tencentcloud-sdk-nodejs-ess 4.1.304 → 4.1.305

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/package.json +1 -1
  2. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +50 -70
  3. package/tencentcloud/services/ess/v20201111/ess_client.js +50 -70
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-ess",
3
- "version": "4.1.304",
3
+ "version": "4.1.305",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
package/tencentcloud/services/ess/v20201111/ess_client.d.ts CHANGED
@@ -20,16 +20,16 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
20
20
  DescribeContractReviewTaskListWebUrl(req: DescribeContractReviewTaskListWebUrlRequest, cb?: (error: string, rep: DescribeContractReviewTaskListWebUrlResponse) => void): Promise<DescribeContractReviewTaskListWebUrlResponse>;
21
21
  /**
22
22
  * 此接口用于启动流程。它是模板发起合同的最后一步。
23
- 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
24
-
25
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
26
23
 
27
- 注：
28
- 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
24
+ ## 1.1 接口调用流程
25
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
29
26
 
30
- 2.<font color="red">静默（自动）签署不支持非本企业合同签署方存在填写</font>功能
27
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
31
28
 
32
- 3.<font color="red">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
29
+ ### 1.2 注意事项
30
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
31
+ - 只要存在填写控件，填充时会触发 PDF 合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。**一定要等待该回调（或等待数秒）后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署**，以确保文档已合成完毕。，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
32
+ - 调用 [CreateDocument](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument) 成功后，请<font color="red">在 5 分钟内调用本接口（StartFlow）启动合同</font> ，不要长时间暂存仅调用了 CreateDocument 而未发起的合同；否则会导致该合同长时间后无法再启动，且合同额度不再返还。
33
33
  */
34
34
  StartFlow(req: StartFlowRequest, cb?: (error: string, rep: StartFlowResponse) => void): Promise<StartFlowResponse>;
35
35
  /**
@@ -169,48 +169,42 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
169
169
  */
170
170
  CreateFlowSignReview(req: CreateFlowSignReviewRequest, cb?: (error: string, rep: CreateFlowSignReviewResponse) => void): Promise<CreateFlowSignReviewResponse>;
171
171
  /**
172
- * 创建签署流程电子文档<br />
173
-
174
- ### 调用流程
175
- 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
172
+ * 本接口用于基于**模板**创建合同的电子文档，并填充模板中由发起方补充的信息（归属发起方填写控件）。
176
173
 
177
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
174
+ ### 1.1 调用流程
178
175
 
176
+ 本接口需指定一个模板 ID，并填充该模板中需补充的信息。它需要与<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口配合使用，完整调用顺序如下：
177
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
179
178
 
180
- ### 填充模板中定义的填写控件
181
- 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
179
+ ### 1.2 发起方填写控件
182
180
 
183
- **<font color="red">填充填写控件需要进行Pdf合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**
181
+ 模板中配置的<font color="red">发起人填充控件</font>，可通过本接口的 **FormFields 数组**字段填充。
184
182
 
185
183
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
186
184
 
187
- 填充的传参示例如下
188
-
189
- ```
190
- request.FormFields = [{
191
- "ComponentName": "项目的名字",
192
- "ComponentValue": "休闲山庄"
193
- }, {
194
- "ComponentName": "项目的地址",
195
- "ComponentValue": "凤凰山北侧",
196
- }, {
197
- "ComponentName": "范围",
198
- "ComponentValue": "凤凰山至107国道",
199
- }, {
200
- "ComponentName": "面积",
201
- "ComponentValue": "100亩",
202
- }, {
203
- "ComponentName": "基本情况",
204
- "ComponentValue": "完好",
205
- }, , {
206
- "ComponentName": "用途",
207
- "ComponentValue": "经营农家乐",
208
- }
209
- ]
185
+ 填充的传参示例如下（以 ComponentName 匹配模板中的控件名）：
186
+
187
+ ```json
188
+ [
189
+ { "ComponentName": "项目的名字", "ComponentValue": "休闲山庄" },
190
+ { "ComponentName": "项目的地址", "ComponentValue": "凤凰山北侧" },
191
+ { "ComponentName": "范围", "ComponentValue": "凤凰山至107国道" },
192
+ { "ComponentName": "面积", "ComponentValue": "100亩" },
193
+ { "ComponentName": "基本情况", "ComponentValue": "完好" },
194
+ { "ComponentName": "用途", "ComponentValue": "经营农家乐" }
195
+ ]
210
196
  ```
211
- 合成后合同样子示例
197
+
198
+ 合成后的合同样例：
212
199
 
213
200
  ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)
201
+
202
+ ### 1.3 注意事项
203
+
204
+ - 本接口<font color="red">只能填充分配给发起方的填写控件</font>，不能填充分配给签署方的签署控件。
205
+ - <font color="red">若使用预览方式（`NeedPreview=true`），预览确认无误后，需用同样的参数再次调用本接口</font>（`NeedPreview=false`），并使用新调用返回的 `FlowId` 去调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 发起签署。预览模式返回的 `FlowId` 为临时 ID，不能用于发起。
206
+ - 只要存在发起方的填写控件，填充时会触发 PDF 合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。<font color="red">一定要等待该回调（或等待数秒）后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署</font>，以确保文档已合成完毕。
207
+ - 调用本接口（CreateDocument）成功后，请**在 5 分钟内调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 启动合同**，不要长时间暂存仅调用了 CreateDocument 而未发起的合同；否则会导致该合同长时间后无法再启动，且合同额度不再返还。
214
208
  */
215
209
  CreateDocument(req: CreateDocumentRequest, cb?: (error: string, rep: CreateDocumentResponse) => void): Promise<CreateDocumentResponse>;
216
210
  /**
@@ -660,40 +654,26 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
660
654
  CreateFlowEvidenceReport(req: CreateFlowEvidenceReportRequest, cb?: (error: string, rep: CreateFlowEvidenceReportResponse) => void): Promise<CreateFlowEvidenceReportResponse>;
661
655
  /**
662
656
  * 通过模板创建签署流程<br/>
663
- 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
664
- <table>
665
- <thead>
666
- <tr>
667
- <th>签署人类别</th>
668
- <th>需要提前准备的信息</th>
669
- </tr>
670
- </thead>
671
- <tbody>
672
- <tr>
673
- <td>自己企业的员工签署（未认证加入或已认证加入）</td>
674
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
675
- </tr>
676
- <tr>
677
- <td>自己企业的员工签署（已认证加入）</td>
678
- <td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
679
- </tr>
680
- <tr>
681
- <td>其他企业的员工签署</td>
682
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
683
- </tr>
684
- <tr>
685
- <td>个人（自然人）签署</td>
686
- <td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
687
- </tr>
688
- </tbody>
689
- </table>
657
+ 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次使用这个配置好的模板，补充合同内容信息及签署信息生成电子合同。
658
+ ## 1.1 传参方式指引
690
659
 
660
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
661
+ |------|------|------|------|
662
+ | 本企业员工（未认证加入） | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
663
+ | 本企业员工（已认证加入） | 0 | 签署企业名、员工在电子签平台的 ID（UserId） | OrganizationName + UserId |
664
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
665
+ | 个人（自然人） | 1 | 个人真实姓名、个人触达手机号、身份证号（非必传） | ApproverName + ApproverMobile |
691
666
 
692
- 注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
667
+ ## 1.2 接口调用流程
668
+ 此接口需<font color="red">配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用</font> 。整体的逻辑如下图
693
669
 
694
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
670
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
695
671
 
696
- 注：**静默（自动）签署不支持合同签署方存在填写**功能
672
+ ## 1.3 注意事项
673
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
674
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
675
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
676
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
697
677
  <br>
698
678
 
699
679
  <font color="red">相关视频指引</font> <br>
@@ -864,7 +844,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
864
844
  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源）<br/>
865
845
 
866
846
  ## 整体流程图
867
- ![image](https://qcloudimg.tencent-cloud.cn/raw/9577ac334c083ecfe0014a187d64b485.svg)
847
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/9bf547fe0bc738f9a97b4b619dea0633.svg)
868
848
 
869
849
  注：
870
850
  - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
package/tencentcloud/services/ess/v20201111/ess_client.js CHANGED
@@ -46,16 +46,16 @@ class Client extends TencentCloudCommon.AbstractClient {
46
46
  }
47
47
  /**
48
48
  * 此接口用于启动流程。它是模板发起合同的最后一步。
49
- 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
50
-
51
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
52
49
 
53
- 注：
54
- 1.<font color="red">合同发起后就会扣减合同的额度</font>, 只有撤销没有参与方签署过或只有自动签署签署过的合同，才会返还合同额度。（过期，拒签，签署完成，解除完成等状态不会返还额度）
50
+ ## 1.1 接口调用流程
51
+ 在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后，用于开始整个合同流程, 推进流程进入到签署环节。
55
52
 
56
- 2.<font color="red">静默（自动）签署不支持非本企业合同签署方存在填写</font>功能
53
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
57
54
 
58
- 3.<font color="red">在发起签署流程之前，建议等待 [PDF合成完成的回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)</font>，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
55
+ ### 1.2 注意事项
56
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
57
+ - 只要存在填写控件，填充时会触发 PDF 合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。**一定要等待该回调（或等待数秒）后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署**，以确保文档已合成完毕。，尤其是当模板中存在动态表格等复杂填写控件时，因为合成过程可能会耗费秒级别的时间。
58
+ - 调用 [CreateDocument](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument) 成功后，请<font color="red">在 5 分钟内调用本接口（StartFlow）启动合同</font> ，不要长时间暂存仅调用了 CreateDocument 而未发起的合同；否则会导致该合同长时间后无法再启动，且合同额度不再返还。
59
59
  */
60
60
  async StartFlow(req, cb) {
61
61
  return this.request("StartFlow", req, cb);
@@ -221,48 +221,42 @@ class Client extends TencentCloudCommon.AbstractClient {
221
221
  return this.request("CreateFlowSignReview", req, cb);
222
222
  }
223
223
  /**
224
- * 创建签署流程电子文档<br />
225
-
226
- ### 调用流程
227
- 该接口需要给对应的流程指定一个模板id，并且填充该模板中需要补充的信息。需要配置<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。具体逻辑可以参考下图:
224
+ * 本接口用于基于**模板**创建合同的电子文档，并填充模板中由发起方补充的信息（归属发起方填写控件）。
228
225
 
229
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
226
+ ### 1.1 调用流程
230
227
 
228
+ 本接口需指定一个模板 ID，并填充该模板中需补充的信息。它需要与<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口配合使用，完整调用顺序如下：
229
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
231
230
 
232
- ### 填充模板中定义的填写控件
233
- 模板中配置的<font color="red">发起人填充控件</font>可以通过本接口的**FormFields数组**字段填充。
231
+ ### 1.2 发起方填写控件
234
232
 
235
- **<font color="red">填充填写控件需要进行Pdf合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83),建议在收到此回调后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口。</font>**
233
+ 模板中配置的<font color="red">发起人填充控件</font>，可通过本接口的 **FormFields 数组**字段填充。
236
234
 
237
235
  ![image](https://qcloudimg.tencent-cloud.cn/raw/37457e0e450fc221effddfcb8b1bad55.png)
238
236
 
239
- 填充的传参示例如下
240
-
241
- ```
242
- request.FormFields = [{
243
- "ComponentName": "项目的名字",
244
- "ComponentValue": "休闲山庄"
245
- }, {
246
- "ComponentName": "项目的地址",
247
- "ComponentValue": "凤凰山北侧",
248
- }, {
249
- "ComponentName": "范围",
250
- "ComponentValue": "凤凰山至107国道",
251
- }, {
252
- "ComponentName": "面积",
253
- "ComponentValue": "100亩",
254
- }, {
255
- "ComponentName": "基本情况",
256
- "ComponentValue": "完好",
257
- }, , {
258
- "ComponentName": "用途",
259
- "ComponentValue": "经营农家乐",
260
- }
261
- ]
237
+ 填充的传参示例如下（以 ComponentName 匹配模板中的控件名）：
238
+
239
+ ```json
240
+ [
241
+ { "ComponentName": "项目的名字", "ComponentValue": "休闲山庄" },
242
+ { "ComponentName": "项目的地址", "ComponentValue": "凤凰山北侧" },
243
+ { "ComponentName": "范围", "ComponentValue": "凤凰山至107国道" },
244
+ { "ComponentName": "面积", "ComponentValue": "100亩" },
245
+ { "ComponentName": "基本情况", "ComponentValue": "完好" },
246
+ { "ComponentName": "用途", "ComponentValue": "经营农家乐" }
247
+ ]
262
248
  ```
263
- 合成后合同样子示例
249
+
250
+ 合成后的合同样例：
264
251
 
265
252
  ![image](https://qcloudimg.tencent-cloud.cn/raw/140a2fb771ac66a185d0a000d37485f6.png)
253
+
254
+ ### 1.3 注意事项
255
+
256
+ - 本接口<font color="red">只能填充分配给发起方的填写控件</font>，不能填充分配给签署方的签署控件。
257
+ - <font color="red">若使用预览方式（`NeedPreview=true`），预览确认无误后，需用同样的参数再次调用本接口</font>（`NeedPreview=false`），并使用新调用返回的 `FlowId` 去调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 发起签署。预览模式返回的 `FlowId` 为临时 ID，不能用于发起。
258
+ - 只要存在发起方的填写控件，填充时会触发 PDF 合成工作，文档合成完成后会收到[合同文档合成完成回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E5%90%88%E5%90%8C%E6%96%87%E6%A1%A3%E5%90%88%E6%88%90%E5%AE%8C%E6%88%90%E5%9B%9E%E8%B0%83)。<font color="red">一定要等待该回调（或等待数秒）后再调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 接口发起签署</font>，以确保文档已合成完毕。
259
+ - 调用本接口（CreateDocument）成功后，请**在 5 分钟内调用 [StartFlow](https://qian.tencent.com/developers/companyApis/startFlows/StartFlow) 启动合同**，不要长时间暂存仅调用了 CreateDocument 而未发起的合同；否则会导致该合同长时间后无法再启动，且合同额度不再返还。
266
260
  */
267
261
  async CreateDocument(req, cb) {
268
262
  return this.request("CreateDocument", req, cb);
@@ -800,40 +794,26 @@ class Client extends TencentCloudCommon.AbstractClient {
800
794
  }
801
795
  /**
802
796
  * 通过模板创建签署流程<br/>
803
- 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次调用模板文件的id，补充合同内容信息及签署信息生成电子合同。
804
- <table>
805
- <thead>
806
- <tr>
807
- <th>签署人类别</th>
808
- <th>需要提前准备的信息</th>
809
- </tr>
810
- </thead>
811
- <tbody>
812
- <tr>
813
- <td>自己企业的员工签署（未认证加入或已认证加入）</td>
814
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
815
- </tr>
816
- <tr>
817
- <td>自己企业的员工签署（已认证加入）</td>
818
- <td>签署企业的名字、员工在电子签平台的ID（UserId）</td>
819
- </tr>
820
- <tr>
821
- <td>其他企业的员工签署</td>
822
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号（证件号非必传）</td>
823
- </tr>
824
- <tr>
825
- <td>个人（自然人）签署</td>
826
- <td>个人的真实名字、个人的触达手机号、个人的身份证（证件号非必传）</td>
827
- </tr>
828
- </tbody>
829
- </table>
797
+ 适用场景：在标准制式的合同场景中，可通过提前预制好模板文件，每次使用这个配置好的模板，补充合同内容信息及签署信息生成电子合同。
798
+ ## 1.1 传参方式指引
830
799
 
800
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
801
+ |------|------|------|------|
802
+ | 本企业员工（未认证加入） | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
803
+ | 本企业员工（已认证加入） | 0 | 签署企业名、员工在电子签平台的 ID（UserId） | OrganizationName + UserId |
804
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号（非必传） | OrganizationName + ApproverName + ApproverMobile |
805
+ | 个人（自然人） | 1 | 个人真实姓名、个人触达手机号、身份证号（非必传） | ApproverName + ApproverMobile |
831
806
 
832
- 注：配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用。整体的逻辑如下图
807
+ ## 1.2 接口调用流程
808
+ 此接口需<font color="red">配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口使用</font> 。整体的逻辑如下图
833
809
 
834
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
810
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
835
811
 
836
- 注：**静默（自动）签署不支持合同签署方存在填写**功能
812
+ ## 1.3 注意事项
813
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
814
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
815
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
816
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
837
817
  <br>
838
818
 
839
819
  <font color="red">相关视频指引</font> <br>
@@ -1030,7 +1010,7 @@ class Client extends TencentCloudCommon.AbstractClient {
1030
1010
  该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号（FileIds）进行使用。（如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源）<br/>
1031
1011
 
1032
1012
  ## 整体流程图
1033
- ![image](https://qcloudimg.tencent-cloud.cn/raw/9577ac334c083ecfe0014a187d64b485.svg)
1013
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/9bf547fe0bc738f9a97b4b619dea0633.svg)
1034
1014
 
1035
1015
  注：
1036
1016
  - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同，且<font color="red">有撤销合同额度</font>的情形下，才会返还合同额度。（**过期，拒签，签署完成，解除完成等状态不会返还额度**）。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。