tencentcloud-sdk-nodejs-ess 4.1.303 → 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.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-ess",
3
- "version": "4.1.303",
3
+ "version": "4.1.305",
4
4
  "description": "腾讯云 API NODEJS SDK",
5
5
  "main": "./tencentcloud/index.js",
6
6
  "module": "./es/index.js",
@@ -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
-
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
+ ]
189
196
  ```
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
- ]
210
- ```
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>
690
-
691
-
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>接口使用。整体的逻辑如下图
693
-
694
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
695
-
696
- 注:**静默(自动)签署不支持合同签署方存在填写**功能
657
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次使用这个配置好的模板,补充合同内容信息及签署信息生成电子合同。
658
+ ## 1.1 传参方式指引
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 |
666
+
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> 。整体的逻辑如下图
669
+
670
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
671
+
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>
@@ -851,43 +831,26 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
851
831
  * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
852
832
  适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
853
833
 
854
- <table>
855
- <thead>
856
- <tr>
857
- <th>签署人类别</th>
858
- <th>需要提前准备的信息</th>
859
- </tr>
860
- </thead>
861
- <tbody>
862
- <tr>
863
- <td>自己企业的员工签署(未认证加入或已认证加入)</td>
864
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
865
- </tr>
866
- <tr>
867
- <td>自己企业的员工签署(已认证加入)</td>
868
- <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
869
- </tr>
870
- <tr>
871
- <td>其他企业的员工签署</td>
872
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
873
- </tr>
874
- <tr>
875
- <td>个人(自然人)签署</td>
876
- <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
877
- </tr>
878
- </tbody>
879
- </table>
880
-
834
+ ## 传参方式指引
881
835
 
836
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
837
+ |------|------|------|------|
838
+ | 本企业员工(未认证加入) | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
839
+ | 本企业员工(已认证加入) | 0 | 签署企业名、员工在电子签平台的 ID(UserId) | OrganizationName + UserId |
840
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
841
+ | 个人(自然人) | 1 | 个人真实姓名、个人触达手机号、身份证号(非必传) | ApproverName + ApproverMobile |
882
842
 
883
- 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>
884
843
 
844
+ 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源)<br/>
885
845
 
886
- ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
846
+ ## 整体流程图
847
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/9bf547fe0bc738f9a97b4b619dea0633.svg)
887
848
 
888
849
  注:
889
- - 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)
890
- - **静默(自动)签署不支持合同签署方存在填写**功能
850
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
851
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
852
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
853
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
891
854
 
892
855
 
893
856
  <font color="red">相关视频指引</font> <br>
@@ -968,7 +931,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
968
931
  ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
969
932
  # 4. 计算完整性签名:HMAC(Key, IV || Ciphertext)
970
933
  signature = HMAC(HMACKey, concat(iv, ciphertext))
971
- # 5. 组装外层请求参数(三段均为标准 Base64)
934
+ # 5. 组装外层请求参数
972
935
  encReq = {
973
936
  RequestAction: bizAction,
974
937
  IV: Base64(iv),
@@ -1006,6 +969,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
1006
969
  ```
1007
970
 
1008
971
  **AES-CBC 示例**
972
+
1009
973
  以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
1010
974
 
1011
975
  加密密钥:AES-CBC-Key-1234
@@ -1024,6 +988,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
1024
988
  ```
1025
989
 
1026
990
  **SM4-CBC 示例**
991
+
1027
992
  以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
1028
993
 
1029
994
  加密密钥:SM4-CBC-Key-1234
@@ -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
-
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
+ ]
241
248
  ```
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
- ]
262
- ```
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>
830
-
831
-
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>接口使用。整体的逻辑如下图
833
-
834
- ![image](https://qcloudimg.tencent-cloud.cn/raw/1f38ebd7c5afed8763ad961741d81438.png)
835
-
836
- 注:**静默(自动)签署不支持合同签署方存在填写**功能
797
+ 适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次使用这个配置好的模板,补充合同内容信息及签署信息生成电子合同。
798
+ ## 1.1 传参方式指引
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 |
806
+
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> 。整体的逻辑如下图
809
+
810
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/dbd2eba8200d812d76b7e9e34d739e75.svg)
811
+
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>
@@ -1017,43 +997,26 @@ class Client extends TencentCloudCommon.AbstractClient {
1017
997
  * 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
1018
998
  适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
1019
999
 
1020
- <table>
1021
- <thead>
1022
- <tr>
1023
- <th>签署人类别</th>
1024
- <th>需要提前准备的信息</th>
1025
- </tr>
1026
- </thead>
1027
- <tbody>
1028
- <tr>
1029
- <td>自己企业的员工签署(未认证加入或已认证加入)</td>
1030
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
1031
- </tr>
1032
- <tr>
1033
- <td>自己企业的员工签署(已认证加入)</td>
1034
- <td>签署企业的名字、员工在电子签平台的ID(UserId)</td>
1035
- </tr>
1036
- <tr>
1037
- <td>其他企业的员工签署</td>
1038
- <td>签署企业的名字、员工的真实名字、员工的触达手机号、员工的证件号(证件号非必传)</td>
1039
- </tr>
1040
- <tr>
1041
- <td>个人(自然人)签署</td>
1042
- <td>个人的真实名字、个人的触达手机号、个人的身份证(证件号非必传)</td>
1043
- </tr>
1044
- </tbody>
1045
- </table>
1046
-
1000
+ ## 传参方式指引
1047
1001
 
1002
+ | 签署方类型 | ApproverType | 需要提前准备的信息 | 对应 Approvers 关键字段 |
1003
+ |------|------|------|------|
1004
+ | 本企业员工(未认证加入) | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
1005
+ | 本企业员工(已认证加入) | 0 | 签署企业名、员工在电子签平台的 ID(UserId) | OrganizationName + UserId |
1006
+ | 他方企业员工 | 0 | 签署企业名、员工真实姓名、员工触达手机号、证件号(非必传) | OrganizationName + ApproverName + ApproverMobile |
1007
+ | 个人(自然人) | 1 | 个人真实姓名、个人触达手机号、身份证号(非必传) | ApproverName + ApproverMobile |
1048
1008
 
1049
- 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>
1050
1009
 
1010
+ 该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFileConvertTask)接口转换成pdf资源)<br/>
1051
1011
 
1052
- ![image](https://qcloudimg.tencent-cloud.cn/raw/f097a74b289e3e1acd740936bdfe9843.png)
1012
+ ## 整体流程图
1013
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/9bf547fe0bc738f9a97b4b619dea0633.svg)
1053
1014
 
1054
1015
  注:
1055
- - 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)
1056
- - **静默(自动)签署不支持合同签署方存在填写**功能
1016
+ - 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/company/contract_cancel_quota)。
1017
+ - 支持的证件类型可以参考[支持的证件类型](https://qian.tencent.com/developers/company/id_card_support)。
1018
+ - 合同发起方需要【组织管理】->【角色管理】中拥有<font color="red">接口发起合同</font>的权限
1019
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/c8553d1823ca1323e82c11f01c86e8cd.png)
1057
1020
 
1058
1021
 
1059
1022
  <font color="red">相关视频指引</font> <br>
@@ -1142,7 +1105,7 @@ class Client extends TencentCloudCommon.AbstractClient {
1142
1105
  ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
1143
1106
  # 4. 计算完整性签名:HMAC(Key, IV || Ciphertext)
1144
1107
  signature = HMAC(HMACKey, concat(iv, ciphertext))
1145
- # 5. 组装外层请求参数(三段均为标准 Base64)
1108
+ # 5. 组装外层请求参数
1146
1109
  encReq = {
1147
1110
  RequestAction: bizAction,
1148
1111
  IV: Base64(iv),
@@ -1180,6 +1143,7 @@ class Client extends TencentCloudCommon.AbstractClient {
1180
1143
  ```
1181
1144
 
1182
1145
  **AES-CBC 示例**
1146
+
1183
1147
  以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
1184
1148
 
1185
1149
  加密密钥:AES-CBC-Key-1234
@@ -1198,6 +1162,7 @@ class Client extends TencentCloudCommon.AbstractClient {
1198
1162
  ```
1199
1163
 
1200
1164
  **SM4-CBC 示例**
1165
+
1201
1166
  以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
1202
1167
 
1203
1168
  加密密钥:SM4-CBC-Key-1234
@@ -4448,65 +4448,36 @@ export interface DeleteIntegrationDepartmentResponse {
4448
4448
  */
4449
4449
  export interface AutoSignConfig {
4450
4450
  /**
4451
- * 自动签开通个人用户信息, 包括名字,身份证等
4451
+ * <p>自动签开通个人用户信息, 包括名字,身份证等</p>
4452
4452
  */
4453
4453
  UserInfo: UserThreeFactor;
4454
4454
  /**
4455
- * 是否回调证书信息:
4456
- <ul><li>**false**: 不需要(默认)</li>
4457
- <li>**true**:需要</li></ul>
4458
-
4459
- 注:`该字段已经失效,请勿设置此参数。`
4455
+ * <p>是否回调证书信息:</p><ul><li>**false**: 不需要(默认)</li><li>**true**:需要</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
4460
4456
  */
4461
4457
  CertInfoCallback?: boolean;
4462
4458
  /**
4463
- * 是否支持用户自定义签名印章:
4464
- <ul><li>**false**: 不能自己定义(默认)</li>
4465
- <li>**true**: 可以自己定义</li></ul>
4459
+ * <p>是否支持用户自定义签名印章:</p><ul><li>**false**: 不能自己定义(默认)</li><li>**true**: 可以自己定义</li></ul>
4466
4460
  */
4467
4461
  UserDefineSeal?: boolean;
4468
4462
  /**
4469
- * 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
4470
- <ul><li>**false**: 不需要(默认)</li>
4471
- <li>**true**: 需要</li></ul>
4463
+ * <p>回调中是否需要自动签将要使用的印章(签名) 图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
4472
4464
  */
4473
4465
  SealImgCallback?: boolean;
4474
4466
  /**
4475
- * 执行结果的回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
4476
- 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
4477
- 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
4467
+ * <p>执行结果的回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。<br>腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。<br>回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。</p>
4478
4468
  * @deprecated
4479
4469
  */
4480
4470
  CallbackUrl?: string;
4481
4471
  /**
4482
- * 开通时候的身份验证方式, 取值为:
4483
- <ul><li>**WEIXINAPP** : 微信人脸识别</li>
4484
- <li>**INSIGHT** : 慧眼人脸识别</li>
4485
- <li>**TELECOM** : 运营商三要素验证</li></ul>
4486
- 注:
4487
- <ul><li>如果是小程序开通链接,仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li>
4488
- <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
4472
+ * <p>开通时候的身份验证方式, 取值为:</p><ul><li>**WEIXINAPP** : 微信人脸识别</li><li>**INSIGHT** : 慧眼人脸识别</li><li>**TELECOM** : 运营商三要素验证</li></ul>注:<ul><li>如果是小程序开通链接,仅支持 WEIXINAPP 。为空默认 WEIXINAPP</li><li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
4489
4473
  */
4490
4474
  VerifyChannels?: Array<string>;
4491
4475
  /**
4492
- * 设置用户自动签合同的扣费方式。
4493
-
4494
- <ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul>
4495
-
4496
- 注:`该字段已经失效,请勿设置此参数。`
4476
+ * <p>设置用户自动签合同的扣费方式。</p><ul><li><b>1</b>: (默认)使用合同份额进行扣减</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
4497
4477
  */
4498
4478
  LicenseType?: number;
4499
4479
  /**
4500
- * 开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。
4501
-
4502
- 注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
4503
-
4504
- 跳转场景:
4505
- <ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>
4506
- <li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。`APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。`APP拦截地址跳转可参考:<a href='https://stackoverflow.com/questions/41693263/android-webview-err-unknown-url-scheme'>Android</a>,<a href='https://razorpay.com/docs/payments/payment-gateway/web-integration/standard/webview/upi-intent-ios/'>IOS</a> </li></ul>
4507
-
4508
- 成功结果返回:
4509
- 若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如: qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
4480
+ * <p>开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。</p><p>注:<code>仅支持H5开通场景</code>, <code>跳转链接仅支持 https:// , qianapp:// 开头</code></p><p>跳转场景:</p><ul><li>**贵方H5 -&gt; 腾讯电子签H5 -&gt; 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li><li>**贵方原生App -&gt; 腾讯电子签H5 -&gt; 贵方原生App** : JumpUrl格式: qianapp://YOUR_CUSTOM_URL,只需满足 qianapp:// 开头的URL即可。<code>APP实现方,需要拦截Webview地址跳转,发现url是qianapp:// 开头时跳转到原生页面。</code>APP拦截地址跳转可参考:<a href="https://qian.tencent.com/developers/company/openqianh5/#3-%E8%BF%94%E5%9B%9E%E5%BA%94%E7%94%A8jumpurl%E6%A0%BC%E5%BC%8F">返回应用JumpUrl格式</a></li></ul><p>成功结果返回:<br>若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:<code>appendResult=qian</code>。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如: qianapp://YOUR_CUSTOM_URL?action=sign&amp;result=success&amp;from=tencent_ess</p>
4510
4481
  */
4511
4482
  JumpUrl?: string;
4512
4483
  }
@@ -7658,21 +7629,21 @@ export interface DescribeOrganizationGroupOrganizationsRequest {
7658
7629
  */
7659
7630
  export interface Agent {
7660
7631
  /**
7661
- * 代理机构的应用编号,32位字符串,一般不用传
7632
+ * <p>CA-API应用编号,用于同平台企业下标识不同的CA-API应用</p>
7662
7633
  * @deprecated
7663
7634
  */
7664
7635
  AppId?: string;
7665
7636
  /**
7666
- * 被代理机构的应用号,一般不用传
7637
+ * <p>被代理机构的应用号,一般不用传</p>
7667
7638
  * @deprecated
7668
7639
  */
7669
7640
  ProxyAppId?: string;
7670
7641
  /**
7671
- * 被代理机构在电子签平台的机构编号,集团代理下场景必传
7642
+ * <p>被代理机构在电子签平台的机构编号,集团代理下场景必传</p>
7672
7643
  */
7673
7644
  ProxyOrganizationId?: string;
7674
7645
  /**
7675
- * 被代理机构的经办人,一般不用传
7646
+ * <p>被代理机构的经办人,一般不用传</p>
7676
7647
  * @deprecated
7677
7648
  */
7678
7649
  ProxyOperator?: string;
@@ -12443,7 +12414,7 @@ export interface CreateFlowSignUrlRequest {
12443
12414
  */
12444
12415
  Agent?: Agent;
12445
12416
  /**
12446
- * <p>流程签署人列表中,结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p>注:</p><ol><li>签署人<b>只能使用手写签名、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。</li><li>生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。</li></ol>
12417
+ * <p>流程签署人列表中,结构体的ApproverName、ApproverMobile和ApproverType为必传字段。如果是企业签署人,还需传递OrganizationName。</p><p>此结构体和CreateFlow发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p>注:</p><ol><li>签署人<b>只能使用签名类型、时间类型、印章类型、签批类型的签署控件和内容填写控件</b>,其他类型的签署控件暂时不支持。</li><li>对于签名控件类型,支持手写签名、系统签名、个人印章等类型的签名方式,取决于合同发起时的设定。另外,签署的时候不支持拉取个人签署方已有签名图片资产,且创建的签名图片为一次性使用,不会保存为签署方个人资产。</li><li>生成发起方预览链接时,该字段(FlowApproverInfos)可以传空或者不传。</li></ol>
12447
12418
  */
12448
12419
  FlowApproverInfos?: Array<FlowCreateApprover>;
12449
12420
  /**