tencentcloud-sdk-nodejs-essbasic 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
|
@@ -327,34 +327,33 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
327
327
|
*/
|
|
328
328
|
ChannelCreatePreparedPersonalEsign(req: ChannelCreatePreparedPersonalEsignRequest, cb?: (error: string, rep: ChannelCreatePreparedPersonalEsignResponse) => void): Promise<ChannelCreatePreparedPersonalEsignResponse>;
|
|
329
329
|
/**
|
|
330
|
-
*
|
|
330
|
+
* 本接口(ChannelCreateFlowByFiles)用于通过**已上传的 PDF 资源编号**创建待签署的合同流程。
|
|
331
331
|
|
|
332
|
-
|
|
332
|
+
**适用场景**:适用于非制式的合同文件签署。当开发者已拥有每个签署流程完整的 PDF 文件时,可通过本接口传入完整的 PDF 文件及流程信息,生成待签署的合同流程。
|
|
333
333
|
|
|
334
|
-
|
|
335
|
-
<ul>
|
|
336
|
-
<li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
|
|
337
|
-
<li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
|
|
338
|
-
</ul>
|
|
334
|
+
### 1.1 调用依赖
|
|
339
335
|
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
**可以作为发起方和签署方的角色列表**
|
|
343
|
-
<table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href="https://qian.tencent.cn/console/company-register" target="_blank">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>
|
|
336
|
+
本接口需依赖[文件上传接口](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)生成 PDF 资源编号(FileId)后使用,整体逻辑如下图:
|
|
344
337
|
|
|
338
|
+

|
|
345
339
|
|
|
346
|
-
|
|
347
|
-
|
|
340
|
+
### 1.2 发起方和签署方
|
|
341
|
+
<table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href="https://qian.tencent.cn/console/company-register" target="_blank">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>
|
|
348
342
|
|
|
349
|
-
`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
|
|
350
343
|
|
|
351
|
-
|
|
344
|
+
<font color="red">发起方(第三方子企业 A 的企业与员工)必须完成实名</font>;作为**签署方**的第三方子企业 A 员工 / 个人自然人 / SaaS 平台企业员工 / 第三方子企业 B 员工等,其企业和个人可以未实名。
|
|
352
345
|
|
|
353
|
-
|
|
346
|
+
### 1.3 注意事项
|
|
347
|
+
- 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/partner/contract_cancel_quota)。
|
|
348
|
+
- <font color="red">支持的证件类型</font>可以参考[支持的证件类型](https://qian.tencent.com/developers/partner/id_card_support)。
|
|
349
|
+
- <font color="red">不同类型的签署方传参不同</font>,各类型签署方的信息传递方式详见 [【签署方入参指引】](https://qian.tencent.com/developers/partner/flow_approver)。
|
|
350
|
+
- 如果合同正式发起前如需<font color="red">预览</font>效果,可参考 [【使用文件发起的预览】](https://qian.tencent.com/developers/partner/preview_guide#%E4%B8%80%E4%BD%BF%E7%94%A8%E6%96%87%E4%BB%B6%E5%8F%91%E8%B5%B7%E7%9A%84%E9%A2%84%E8%A7%88)
|
|
351
|
+
- 关于填写方与签署方的<font color="red">填写、签署先后顺序</font>设置,详见 [【填写与签署顺序说明】](https://qian.tencent.com/developers/partner/fill_sign_order)。
|
|
352
|
+
- 关于<font color="red">本企业自动签署与其他企业自动签署</font>的配置与使用,详见 [【自动签署】](https://qian.tencent.com/developers/partner/autosign_guide)。
|
|
354
353
|
|
|
355
|
-
|
|
356
|
-
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a
|
|
357
|
-
|
|
354
|
+
### 1.4 视频教程
|
|
355
|
+
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a>
|
|
356
|
+
2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a>
|
|
358
357
|
*/
|
|
359
358
|
ChannelCreateFlowByFiles(req: ChannelCreateFlowByFilesRequest, cb?: (error: string, rep: ChannelCreateFlowByFilesResponse) => void): Promise<ChannelCreateFlowByFilesResponse>;
|
|
360
359
|
/**
|
|
@@ -679,7 +678,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
679
678
|
ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
|
|
680
679
|
# 4. 计算完整性签名:HMAC(Key, IV || Ciphertext)
|
|
681
680
|
signature = HMAC(HMACKey, concat(iv, ciphertext))
|
|
682
|
-
# 5.
|
|
681
|
+
# 5. 组装外层请求参数
|
|
683
682
|
encReq = {
|
|
684
683
|
RequestAction: bizAction,
|
|
685
684
|
ApplicationId: bizApplicationId,
|
|
@@ -718,6 +717,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
718
717
|
```
|
|
719
718
|
|
|
720
719
|
**AES-CBC 示例**
|
|
720
|
+
|
|
721
721
|
以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
|
|
722
722
|
|
|
723
723
|
加密密钥:AES-CBC-Key-1234
|
|
@@ -728,7 +728,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
728
728
|
最终请求参数:
|
|
729
729
|
```
|
|
730
730
|
{
|
|
731
|
-
"RequestAction": "
|
|
731
|
+
"RequestAction": "ChannelDescribeFlowComponents",
|
|
732
732
|
"ApplicationId: "yD******************************,
|
|
733
733
|
"IV": "MTIzNDU2Nzg5MGFiY2RlZg==",
|
|
734
734
|
"EncryptedData": "Iqp2W1jislwMNmE7bH9dKZZiMQsfkAPyvAAqDFRnWLw=",
|
|
@@ -737,6 +737,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
737
737
|
```
|
|
738
738
|
|
|
739
739
|
**SM4-CBC 示例**
|
|
740
|
+
|
|
740
741
|
以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
|
|
741
742
|
|
|
742
743
|
加密密钥:SM4-CBC-Key-1234
|
|
@@ -747,7 +748,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
|
|
|
747
748
|
最终请求参数:
|
|
748
749
|
```
|
|
749
750
|
{
|
|
750
|
-
"RequestAction": "
|
|
751
|
+
"RequestAction": "ChannelDescribeFlowComponents",
|
|
751
752
|
"ApplicationId: "yD******************************,
|
|
752
753
|
"IV": "ZmVkY2JhMDk4NzY1NDMyMQ==",
|
|
753
754
|
"EncryptedData": "GwUovQhNUPaUnVM/UDXMtPOYTpTSi2B1oyZDFbyyvns=",
|
|
@@ -393,34 +393,33 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
393
393
|
return this.request("ChannelCreatePreparedPersonalEsign", req, cb);
|
|
394
394
|
}
|
|
395
395
|
/**
|
|
396
|
-
*
|
|
396
|
+
* 本接口(ChannelCreateFlowByFiles)用于通过**已上传的 PDF 资源编号**创建待签署的合同流程。
|
|
397
397
|
|
|
398
|
-
|
|
398
|
+
**适用场景**:适用于非制式的合同文件签署。当开发者已拥有每个签署流程完整的 PDF 文件时,可通过本接口传入完整的 PDF 文件及流程信息,生成待签署的合同流程。
|
|
399
399
|
|
|
400
|
-
|
|
401
|
-
<ul>
|
|
402
|
-
<li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
|
|
403
|
-
<li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
|
|
404
|
-
</ul>
|
|
400
|
+
### 1.1 调用依赖
|
|
405
401
|
|
|
406
|
-
|
|
407
|
-
|
|
408
|
-
**可以作为发起方和签署方的角色列表**
|
|
409
|
-
<table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href="https://qian.tencent.cn/console/company-register" target="_blank">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>
|
|
402
|
+
本接口需依赖[文件上传接口](https://qian.tencent.com/developers/partnerApis/files/UploadFiles)生成 PDF 资源编号(FileId)后使用,整体逻辑如下图:
|
|
410
403
|
|
|
404
|
+

|
|
411
405
|
|
|
412
|
-
|
|
413
|
-
|
|
406
|
+
### 1.2 发起方和签署方
|
|
407
|
+
<table> <thead> <tr> <th>场景编号</th> <th>发起方</th> <th>签署方</th> <th>补充</th> </tr> </thead> <tbody> <tr> <td>场景一</td> <td>子企业A的员工</td> <td>子企业A的员工</td> <td>子企业是通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">CreateConsoleLoginUrl</a>生成子客登录链接注册的企业</td> </tr> <tr> <td>场景二</td> <td>子企业A的员工</td> <td>子企业B(不指定经办人走领取逻辑)</td> <td>领取的逻辑可以参考文档<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">动态签署方</a> </td> </tr> <tr> <td>场景三</td> <td>子企业A的员工</td> <td>子企业B的员工</td> <td>-</td> </tr> <tr> <td>场景四</td> <td>子企业A的员工</td> <td>个人</td> <td>就是自然人,不是企业员工</td> </tr> <tr> <td>场景五</td> <td>子企业A的员工</td> <td>SaaS平台企业员工</td> <td>SaaS平台企业是通过<a href="https://qian.tencent.cn/console/company-register" target="_blank">https://qian.tencent.cn/console/company-register</a>链接注册的企业</td> </tr> </tbody> </table>
|
|
414
408
|
|
|
415
|
-
`2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
|
|
416
409
|
|
|
417
|
-
|
|
410
|
+
<font color="red">发起方(第三方子企业 A 的企业与员工)必须完成实名</font>;作为**签署方**的第三方子企业 A 员工 / 个人自然人 / SaaS 平台企业员工 / 第三方子企业 B 员工等,其企业和个人可以未实名。
|
|
418
411
|
|
|
419
|
-
|
|
412
|
+
### 1.3 注意事项
|
|
413
|
+
- 合同<font color="red">发起后就会扣减合同的额度</font> , 只有撤销没有参与方签署过或只有自动签署签署过的合同,且<font color="red">有撤销合同额度</font>的情形下,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)。具体可以参考[合同撤销返还额度说明](https://qian.tencent.com/developers/partner/contract_cancel_quota)。
|
|
414
|
+
- <font color="red">支持的证件类型</font>可以参考[支持的证件类型](https://qian.tencent.com/developers/partner/id_card_support)。
|
|
415
|
+
- <font color="red">不同类型的签署方传参不同</font>,各类型签署方的信息传递方式详见 [【签署方入参指引】](https://qian.tencent.com/developers/partner/flow_approver)。
|
|
416
|
+
- 如果合同正式发起前如需<font color="red">预览</font>效果,可参考 [【使用文件发起的预览】](https://qian.tencent.com/developers/partner/preview_guide#%E4%B8%80%E4%BD%BF%E7%94%A8%E6%96%87%E4%BB%B6%E5%8F%91%E8%B5%B7%E7%9A%84%E9%A2%84%E8%A7%88)
|
|
417
|
+
- 关于填写方与签署方的<font color="red">填写、签署先后顺序</font>设置,详见 [【填写与签署顺序说明】](https://qian.tencent.com/developers/partner/fill_sign_order)。
|
|
418
|
+
- 关于<font color="red">本企业自动签署与其他企业自动签署</font>的配置与使用,详见 [【自动签署】](https://qian.tencent.com/developers/partner/autosign_guide)。
|
|
420
419
|
|
|
421
|
-
|
|
422
|
-
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a
|
|
423
|
-
|
|
420
|
+
### 1.4 视频教程
|
|
421
|
+
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-UploadFiles.mp4" target="_blank">【上传文件代码】编写示例</a>
|
|
422
|
+
2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/essbasic-ChannelCreateFlowByFiles.mp4" target="_blank">【用PDF文件创建签署流程】编写示例</a>
|
|
424
423
|
*/
|
|
425
424
|
async ChannelCreateFlowByFiles(req, cb) {
|
|
426
425
|
return this.request("ChannelCreateFlowByFiles", req, cb);
|
|
@@ -789,7 +788,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
789
788
|
ciphertext = SymmetricEncrypt(ALGO, AESKey, iv, plaintext)
|
|
790
789
|
# 4. 计算完整性签名:HMAC(Key, IV || Ciphertext)
|
|
791
790
|
signature = HMAC(HMACKey, concat(iv, ciphertext))
|
|
792
|
-
# 5.
|
|
791
|
+
# 5. 组装外层请求参数
|
|
793
792
|
encReq = {
|
|
794
793
|
RequestAction: bizAction,
|
|
795
794
|
ApplicationId: bizApplicationId,
|
|
@@ -828,6 +827,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
828
827
|
```
|
|
829
828
|
|
|
830
829
|
**AES-CBC 示例**
|
|
830
|
+
|
|
831
831
|
以下示例参数及结果可用于验证 AES-CBC 加密和 HMAC-SHA256 签名算法的实现是否正确。
|
|
832
832
|
|
|
833
833
|
加密密钥:AES-CBC-Key-1234
|
|
@@ -838,7 +838,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
838
838
|
最终请求参数:
|
|
839
839
|
```
|
|
840
840
|
{
|
|
841
|
-
"RequestAction": "
|
|
841
|
+
"RequestAction": "ChannelDescribeFlowComponents",
|
|
842
842
|
"ApplicationId: "yD******************************,
|
|
843
843
|
"IV": "MTIzNDU2Nzg5MGFiY2RlZg==",
|
|
844
844
|
"EncryptedData": "Iqp2W1jislwMNmE7bH9dKZZiMQsfkAPyvAAqDFRnWLw=",
|
|
@@ -847,6 +847,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
847
847
|
```
|
|
848
848
|
|
|
849
849
|
**SM4-CBC 示例**
|
|
850
|
+
|
|
850
851
|
以下示例参数及结果可用于验证 SM4-CBC 加密和 HMAC-SM4 签名算法的实现是否正确。
|
|
851
852
|
|
|
852
853
|
加密密钥:SM4-CBC-Key-1234
|
|
@@ -857,7 +858,7 @@ class Client extends TencentCloudCommon.AbstractClient {
|
|
|
857
858
|
最终请求参数:
|
|
858
859
|
```
|
|
859
860
|
{
|
|
860
|
-
"RequestAction": "
|
|
861
|
+
"RequestAction": "ChannelDescribeFlowComponents",
|
|
861
862
|
"ApplicationId: "yD******************************,
|
|
862
863
|
"IV": "ZmVkY2JhMDk4NzY1NDMyMQ==",
|
|
863
864
|
"EncryptedData": "GwUovQhNUPaUnVM/UDXMtPOYTpTSi2B1oyZDFbyyvns=",
|
|
@@ -1489,7 +1489,7 @@ export interface ChannelCreateFlowSignUrlRequest {
|
|
|
1489
1489
|
*/
|
|
1490
1490
|
FlowId: string;
|
|
1491
1491
|
/**
|
|
1492
|
-
* <p>流程签署人列表,其中结构体的ApproverType必传。<br>若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。<br>若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)</p><p>此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</p><ol><li>RecipientId: 发起合同会返回,可以直接用于指定需要生成链接的签署方。</li><li>ApproverSignTypes: 指定签署方签署时候的认证方式,仅此链接生效。</li><li>SignTypeSelector: 可以指定签署方签署合同的认证校验方式的选择模式。</li><li>Intention: 指定H5签署视频核身的意图配置,仅视频签署需要使用。</li></ol><p
|
|
1492
|
+
* <p>流程签署人列表,其中结构体的ApproverType必传。<br>若为个人签署方或saas企业签署方,则Name,Mobile必传。OrganizationName 传对应企业名称。<br>若为子客企业签署方则需传OpenId、OrganizationOpenId、OrganizationName, 其他可不传。(如果对应OrganizationOpenId 子客已经认证激活了,则可以省去OrganizationName)</p><p>此结构体和发起接口参与方结构体复用,除了上述参数外,可传递的参数有:</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>
|
|
1493
1493
|
*/
|
|
1494
1494
|
FlowApproverInfos?: Array<FlowApproverInfo>;
|
|
1495
1495
|
/**
|
|
@@ -2811,64 +2811,36 @@ export interface DescribeTemplatesResponse {
|
|
|
2811
2811
|
*/
|
|
2812
2812
|
export interface AutoSignConfig {
|
|
2813
2813
|
/**
|
|
2814
|
-
*
|
|
2814
|
+
* <p>自动签开通个人用户信息, 包括名字,身份证等</p>
|
|
2815
2815
|
*/
|
|
2816
2816
|
UserInfo: UserThreeFactor;
|
|
2817
2817
|
/**
|
|
2818
|
-
*
|
|
2819
|
-
<ul><li>**false**: 不需要(默认)</li>
|
|
2820
|
-
<li>**true**:需要</li></ul>
|
|
2821
|
-
|
|
2822
|
-
|
|
2823
|
-
注:`该字段已经失效,请勿设置此参数。`
|
|
2818
|
+
* <p>是否回调证书信息:</p><ul><li>**false**: 不需要(默认)</li><li>**true**:需要</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
|
|
2824
2819
|
*/
|
|
2825
2820
|
CertInfoCallback?: boolean;
|
|
2826
2821
|
/**
|
|
2827
|
-
*
|
|
2828
|
-
<ul><li>**false**: 不能自己定义(默认)</li>
|
|
2829
|
-
<li>**true**: 可以自己定义</li></ul>
|
|
2822
|
+
* <p>是否支持用户自定义签名印章:</p><ul><li>**false**: 不能自己定义(默认)</li><li>**true**: 可以自己定义</li></ul>
|
|
2830
2823
|
*/
|
|
2831
2824
|
UserDefineSeal?: boolean;
|
|
2832
2825
|
/**
|
|
2833
|
-
*
|
|
2834
|
-
<ul><li>**false**: 不需要(默认)</li>
|
|
2835
|
-
<li>**true**: 需要</li></ul>
|
|
2826
|
+
* <p>回调中是否需要自动签将要使用的印章(签名)图片的 base64:</p><ul><li>**false**: 不需要(默认)</li><li>**true**: 需要</li></ul>
|
|
2836
2827
|
*/
|
|
2837
2828
|
SealImgCallback?: boolean;
|
|
2838
2829
|
/**
|
|
2839
|
-
*
|
|
2830
|
+
* <p>该字段已废弃,请使用【应用号配置】中的回调地址统一接口消息</p>
|
|
2840
2831
|
* @deprecated
|
|
2841
2832
|
*/
|
|
2842
2833
|
CallbackUrl?: string;
|
|
2843
2834
|
/**
|
|
2844
|
-
*
|
|
2845
|
-
<ul><li>**WEIXINAPP** : 微信人脸识别</li>
|
|
2846
|
-
<li>**INSIGHT** : 慧眼人脸识别</li>
|
|
2847
|
-
<li>**TELECOM** : 运营商三要素验证</li></ul>
|
|
2848
|
-
注:
|
|
2849
|
-
<ul><li>如果是小程序开通链接,仅支持传 WEIXINAPP。为空默认 WEIXINAPP</li>
|
|
2850
|
-
<li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
|
|
2835
|
+
* <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>
|
|
2851
2836
|
*/
|
|
2852
2837
|
VerifyChannels?: Array<string>;
|
|
2853
2838
|
/**
|
|
2854
|
-
*
|
|
2855
|
-
|
|
2856
|
-
<ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul>
|
|
2857
|
-
|
|
2858
|
-
注:`该字段已经失效,请勿设置此参数。`
|
|
2839
|
+
* <p>设置用户开通自动签时是否绑定个人自动签账号许可。</p><ul><li><b>1</b>: (默认)不绑定自动签账号许可开通,开通后一直有效, 后续使用合同份额进行合同发起</li></ul><p>注:<code>该字段已经失效,请勿设置此参数。</code></p>
|
|
2859
2840
|
*/
|
|
2860
2841
|
LicenseType?: number;
|
|
2861
2842
|
/**
|
|
2862
|
-
*
|
|
2863
|
-
|
|
2864
|
-
注:`仅支持H5开通场景`, `跳转链接仅支持 https:// , qianapp:// 开头`
|
|
2865
|
-
|
|
2866
|
-
跳转场景:
|
|
2867
|
-
<ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li>
|
|
2868
|
-
<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>
|
|
2869
|
-
|
|
2870
|
-
成功结果返回:
|
|
2871
|
-
若贵方需要在跳转回时通过链接query参数提示开通成功,JumpUrl中的query应携带如下参数:`appendResult=qian`。这样腾讯电子签H5会在跳转回的url后面会添加query参数提示贵方签署成功,例如:qianapp://YOUR_CUSTOM_URL?action=sign&result=success&from=tencent_ess
|
|
2843
|
+
* <p>开通成功后前端页面跳转的url,此字段的用法场景请联系客户经理确认。</p><p>注:<code>仅支持H5开通场景</code>, <code>跳转链接仅支持 https:// , qianapp:// 开头</code></p><p>跳转场景:</p><ul><li>**贵方H5 -> 腾讯电子签H5 -> 贵方H5** : JumpUrl格式: https://YOUR_CUSTOM_URL/xxxx,只需满足 https:// 开头的正确且合规的网址即可。</li><li>**贵方原生App -> 腾讯电子签H5 -> 贵方原生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&result=success&from=tencent_ess</p>
|
|
2872
2844
|
*/
|
|
2873
2845
|
JumpUrl?: string;
|
|
2874
2846
|
}
|