tencentcloud-sdk-nodejs-essbasic 4.0.720 → 4.0.721
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/CHANGELOG.md +190 -0
- package/SERVICE_CHANGELOG.md +266 -36
- package/package.json +1 -1
- package/products.md +12 -12
- package/src/services/essbasic/v20210526/essbasic_client.ts +54 -41
- package/src/services/essbasic/v20210526/essbasic_models.ts +129 -68
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +54 -41
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +54 -41
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +129 -68
package/products.md
CHANGED
|
@@ -40,8 +40,8 @@
|
|
|
40
40
|
| casb | [云访问安全代理](https://cloud.tencent.com/document/product/1303) | 2022-12-26 10:53:16 |
|
|
41
41
|
| cat | [云拨测](https://cloud.tencent.com/document/product/280) | 2023-10-25 01:08:41 |
|
|
42
42
|
| cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-11-01 01:07:57 |
|
|
43
|
-
| ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2023-
|
|
44
|
-
| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-
|
|
43
|
+
| ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2023-11-03 01:08:07 |
|
|
44
|
+
| cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-11-03 01:08:21 |
|
|
45
45
|
| cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2023-09-12 01:18:51 |
|
|
46
46
|
| cdn | [内容分发网络 CDN](https://cloud.tencent.com/document/product/228) | 2023-10-27 01:17:34 |
|
|
47
47
|
| cds | [T-Sec-数据安全审计(DSA)](https://cloud.tencent.com/document/product/856) | 2023-08-17 01:43:06 |
|
|
@@ -66,7 +66,7 @@
|
|
|
66
66
|
| cms | [内容安全](https://cloud.tencent.com/document/product/669) | 2023-08-24 01:10:10 |
|
|
67
67
|
| cpdp | [企业收付平台](https://cloud.tencent.com/document/product/1122) | 2023-09-21 02:09:54 |
|
|
68
68
|
| cr | [金融联络机器人](https://cloud.tencent.com/document/product/656) | 2021-02-24 08:03:24 |
|
|
69
|
-
| csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-
|
|
69
|
+
| csip | [云安全一体化平台](https://cloud.tencent.com/document/product/664) | 2023-11-03 01:10:39 |
|
|
70
70
|
| csxg | [5G入云服务](https://cloud.tencent.com/document/product/1687) | 2023-05-19 11:26:14 |
|
|
71
71
|
| cvm | [云服务器](https://cloud.tencent.com/document/product/213) | 2023-10-30 00:24:37 |
|
|
72
72
|
| cwp | [主机安全](https://cloud.tencent.com/document/product/296) | 2023-10-27 01:29:35 |
|
|
@@ -80,7 +80,7 @@
|
|
|
80
80
|
| dc | [专线接入](https://cloud.tencent.com/document/product/216) | 2023-08-17 02:50:46 |
|
|
81
81
|
| dcdb | [TDSQL MySQL 版](https://cloud.tencent.com/document/product/557) | 2023-10-30 00:33:47 |
|
|
82
82
|
| dlc | [数据湖计算 DLC](https://cloud.tencent.com/document/product/1342) | 2023-10-27 01:38:16 |
|
|
83
|
-
| dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-
|
|
83
|
+
| dnspod | [DNSPod](https://cloud.tencent.com/document/product/1427) | 2023-11-03 01:13:17 |
|
|
84
84
|
| domain | [域名注册](https://cloud.tencent.com/document/product/242) | 2023-10-20 01:14:01 |
|
|
85
85
|
| drm | [数字版权管理](https://cloud.tencent.com/document/product/1000) | 2023-11-02 01:38:44 |
|
|
86
86
|
| ds | [文档服务](https://cloud.tencent.com/document/product/869) | 2023-08-17 02:59:40 |
|
|
@@ -96,7 +96,7 @@
|
|
|
96
96
|
| emr | [弹性 MapReduce](https://cloud.tencent.com/document/product/589) | 2023-10-16 01:15:50 |
|
|
97
97
|
| es | [Elasticsearch Service](https://cloud.tencent.com/document/product/845) | 2023-10-30 00:42:05 |
|
|
98
98
|
| ess | [腾讯电子签企业版](https://cloud.tencent.com/document/product/1323) | 2023-11-02 01:44:45 |
|
|
99
|
-
| essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-11-
|
|
99
|
+
| essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-11-03 01:15:04 |
|
|
100
100
|
| facefusion | [人脸融合](https://cloud.tencent.com/document/product/670) | 2023-09-18 01:48:33 |
|
|
101
101
|
| faceid | [人脸核身](https://cloud.tencent.com/document/product/1007) | 2023-10-20 01:16:02 |
|
|
102
102
|
| fmu | [人脸试妆](https://cloud.tencent.com/document/product/1172) | 2023-08-17 03:12:49 |
|
|
@@ -197,18 +197,18 @@
|
|
|
197
197
|
| tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2023-11-01 01:21:35 |
|
|
198
198
|
| tdcpg | [TDSQL-C PostgreSQL 版](https://cloud.tencent.com/document/product/1556) | 2023-06-21 01:36:25 |
|
|
199
199
|
| tdid | [分布式身份](https://cloud.tencent.com/document/product/1439) | 2023-07-24 01:49:20 |
|
|
200
|
-
| tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-11-
|
|
200
|
+
| tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-11-03 01:22:53 |
|
|
201
201
|
| tds | [设备安全](https://cloud.tencent.com/document/product/1628) | 2023-05-18 01:55:50 |
|
|
202
202
|
| tem | [弹性微服务](https://cloud.tencent.com/document/product/1371) | 2023-08-30 01:25:15 |
|
|
203
|
-
| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-11-01
|
|
204
|
-
| thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-
|
|
203
|
+
| teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-11-03 01:23:41 |
|
|
204
|
+
| thpc | [高性能计算平台](https://cloud.tencent.com/document/product/1527) | 2023-11-03 01:23:56 |
|
|
205
205
|
| tia | [智能钛机器学习](https://cloud.tencent.com/document/product/851) | 2021-10-21 11:12:52 |
|
|
206
206
|
| tic | [资源编排 TIC](https://cloud.tencent.com/document/product/1213) | 2023-08-17 05:26:08 |
|
|
207
207
|
| ticm | [智能鉴黄](https://cloud.tencent.com/document/product/864) | 2021-01-07 08:08:15 |
|
|
208
208
|
| tics | [威胁情报云查服务](https://cloud.tencent.com/document/product/1013) | 2023-08-17 05:26:12 |
|
|
209
209
|
| tiems | [腾讯云 TI 平台 TI-EMS ](https://cloud.tencent.com/document/product/1120) | 2022-07-19 06:19:39 |
|
|
210
210
|
| tiia | [图像分析](https://cloud.tencent.com/document/product/865) | 2023-09-01 01:23:47 |
|
|
211
|
-
| tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-11-
|
|
211
|
+
| tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-11-03 01:24:08 |
|
|
212
212
|
| tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-11-01 01:23:35 |
|
|
213
213
|
| tke | [容器服务](https://cloud.tencent.com/document/product/457) | 2023-10-31 02:35:43 |
|
|
214
214
|
| tkgdq | [腾讯知识图谱数据查询](https://cloud.tencent.com/document/product) | 2020-03-10 00:51:44 |
|
|
@@ -228,9 +228,9 @@
|
|
|
228
228
|
| vm | [视频内容安全](https://cloud.tencent.com/document/product/1265) | 2023-05-18 02:04:19 |
|
|
229
229
|
| vms | [语音消息](https://cloud.tencent.com/document/product/1128) | 2023-08-17 05:50:56 |
|
|
230
230
|
| vod | [云点播](https://cloud.tencent.com/document/product/266) | 2023-10-30 01:34:07 |
|
|
231
|
-
| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-11-
|
|
232
|
-
| vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-
|
|
233
|
-
| waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-11-
|
|
231
|
+
| vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-11-03 01:26:23 |
|
|
232
|
+
| vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-11-03 01:27:03 |
|
|
233
|
+
| waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-11-03 01:27:06 |
|
|
234
234
|
| wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 |
|
|
235
235
|
| wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-11-01 01:26:43 |
|
|
236
236
|
| weilingwith | [微瓴同业开放平台](https://cloud.tencent.com/document/product/1693) | 2023-09-12 09:30:48 |
|
|
@@ -462,11 +462,13 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
462
462
|
* 撤销签署流程接口
|
|
463
463
|
|
|
464
464
|
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
465
|
-
|
|
466
|
-
|
|
465
|
+
|
|
466
|
+
- **可撤回合同状态**:未全部签署完成
|
|
467
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
468
|
+
|
|
467
469
|
注:
|
|
468
|
-
<
|
|
469
|
-
|
|
470
|
+
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
|
|
471
|
+
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
470
472
|
*/
|
|
471
473
|
async ChannelCancelFlow(
|
|
472
474
|
req: ChannelCancelFlowRequest,
|
|
@@ -620,17 +622,24 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
|
|
|
620
622
|
/**
|
|
621
623
|
* 通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
|
|
622
624
|
|
|
623
|
-
|
|
624
|
-
>
|
|
625
|
-
> 该接口常用来配合“使用模板创建签署流程”接口作为前置的接口使用。
|
|
626
|
-
> 一个模板通常会包含以下结构信息
|
|
627
|
-
>- 模板基本信息
|
|
628
|
-
>- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
|
|
629
|
-
>- 填写控件 Components
|
|
630
|
-
>- 签署控件 SignComponents
|
|
631
|
-
>- 生成模板的文件基础信息 FileInfos
|
|
625
|
+
**一个模板通常会包含以下结构信息**
|
|
632
626
|
|
|
633
|
-
|
|
627
|
+
- 模板模版ID, 模板名字等基本信息
|
|
628
|
+
- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
|
|
629
|
+
- 发起方和签署方的填写控件 Components
|
|
630
|
+
- 签署方的签署控件 SignComponents
|
|
631
|
+
|
|
632
|
+
**适用场景**
|
|
633
|
+
该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
|
|
634
|
+
通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
|
|
635
|
+
|
|
636
|
+
**模版的来源**
|
|
637
|
+
子客企业的模板有两种途径获取
|
|
638
|
+
- 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
|
|
639
|
+
- 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
|
|
640
|
+
|
|
641
|
+
|
|
642
|
+
**注意**
|
|
634
643
|
|
|
635
644
|
>1. 查询条件TemplateId、TemplateName与ChannelTemplateId可同时存在,即可查询同时满足这些条件的模板。
|
|
636
645
|
>2. TemplateId 和TemplateIds互为独立,若两个参数都传入,则以TemplateId为准
|
|
@@ -736,15 +745,15 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
736
745
|
}
|
|
737
746
|
|
|
738
747
|
/**
|
|
739
|
-
*
|
|
740
|
-
客户指定需要撤销的签署流程Id,最多100个,超过100不处理;
|
|
741
|
-
接口调用成功返回批量撤销合同的链接,通过链接跳转到电子签小程序完成批量撤销;
|
|
748
|
+
* 通过合同编号生成批量撤销合同的链接,单次最多支持撤销100份合同, 返回的链接需要有此权限的人<font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>在<font color='red'>**手机端**</font>打开, 跳转到腾讯电子签小程序输入撤销原因来进行撤销合同
|
|
742
749
|
|
|
743
|
-
|
|
744
|
-
不可以撤回:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
750
|
+
适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
745
751
|
|
|
746
|
-
|
|
747
|
-
|
|
752
|
+
- **可撤回合同状态**:未全部签署完成
|
|
753
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
754
|
+
|
|
755
|
+
注:
|
|
756
|
+
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
748
757
|
*/
|
|
749
758
|
async ChannelCreateBatchCancelFlowUrl(
|
|
750
759
|
req: ChannelCreateBatchCancelFlowUrlRequest,
|
|
@@ -898,8 +907,16 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
898
907
|
}
|
|
899
908
|
|
|
900
909
|
/**
|
|
901
|
-
*
|
|
902
|
-
|
|
910
|
+
* 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
|
911
|
+
解除协议的模板是官方提供,经过提供法务审核,暂不支持自定义。
|
|
912
|
+
|
|
913
|
+
注意:
|
|
914
|
+
<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
|
|
915
|
+
<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
|
|
916
|
+
<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
|
|
917
|
+
<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
|
|
918
|
+
<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
|
|
919
|
+
<li>在解除协议发起之后,原合同的状态将转变为解除中。一旦解除协议签署完毕,原合同及解除协议均变为已解除状态。</li></ul>
|
|
903
920
|
*/
|
|
904
921
|
async ChannelCreateReleaseFlow(
|
|
905
922
|
req: ChannelCreateReleaseFlowRequest,
|
|
@@ -919,22 +936,16 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
919
936
|
}
|
|
920
937
|
|
|
921
938
|
/**
|
|
922
|
-
*
|
|
923
|
-
|
|
924
|
-
|
|
925
|
-
|
|
926
|
-
-
|
|
927
|
-
-
|
|
928
|
-
|
|
929
|
-
- 已撤回
|
|
930
|
-
- 拒绝填写
|
|
931
|
-
- 已解除
|
|
932
|
-
|
|
933
|
-
<br/>
|
|
934
|
-
满足撤销条件的合同会发起异步撤销流程,而不满足撤销条件的合同将返回失败原因。合同撤销成功后,会通过合同状态为 CANCEL 的回调消息通知调用方。具体的回调消息内容可参考 <a href="https://qian.tencent.com/developers/partner/callback_types_contracts_sign" target="_blank">合同状态变更回调消息</a>。
|
|
935
|
-
<br/><br/>
|
|
939
|
+
* 通过合同编号批量撤销合同,单次最多支持撤销100份合同。
|
|
940
|
+
|
|
941
|
+
适用场景:如果某个合同当前**至少还有一方没有签署**,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。
|
|
942
|
+
|
|
943
|
+
- **可撤回合同状态**:未全部签署完成
|
|
944
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
945
|
+
|
|
936
946
|
注:
|
|
937
|
-
|
|
947
|
+
- 有对应合同撤销权限的人: <font color='red'>**合同的发起人或者发起人所在企业的超管、法人**</font>
|
|
948
|
+
- 签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateReleaseFlow" target="_blank">发起解除合同流程接口</a>
|
|
938
949
|
*/
|
|
939
950
|
async ChannelBatchCancelFlows(
|
|
940
951
|
req: ChannelBatchCancelFlowsRequest,
|
|
@@ -946,7 +957,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
|
|
|
946
957
|
/**
|
|
947
958
|
* 该接口 (PrepareFlows) 用于创建待发起文件
|
|
948
959
|
用户通过该接口进入签署流程发起的确认页面,进行发起信息二次确认, 如果确认则进行正常发起。
|
|
949
|
-
目前该接口只支持B2C
|
|
960
|
+
目前该接口只支持B2C,<font color='red'> **不建议使用,将会废弃**</font>。
|
|
950
961
|
*/
|
|
951
962
|
async PrepareFlows(
|
|
952
963
|
req: PrepareFlowsRequest,
|
|
@@ -1353,8 +1364,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
1353
1364
|
}
|
|
1354
1365
|
|
|
1355
1366
|
/**
|
|
1356
|
-
|
|
1357
|
-
|
|
1367
|
+
* 获取个人用户自动签的开通链接。
|
|
1368
|
+
|
|
1369
|
+
注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
1370
|
+
*/
|
|
1358
1371
|
async ChannelCreateUserAutoSignEnableUrl(
|
|
1359
1372
|
req: ChannelCreateUserAutoSignEnableUrlRequest,
|
|
1360
1373
|
cb?: (error: string, rep: ChannelCreateUserAutoSignEnableUrlResponse) => void
|
|
@@ -373,7 +373,7 @@ export interface ChannelDeleteSealPoliciesRequest {
|
|
|
373
373
|
*/
|
|
374
374
|
export interface ChannelBatchCancelFlowsResponse {
|
|
375
375
|
/**
|
|
376
|
-
* 签署流程批量撤销失败原因,错误信息与流程Id
|
|
376
|
+
* 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
|
|
377
377
|
*/
|
|
378
378
|
FailMessages?: Array<string>
|
|
379
379
|
/**
|
|
@@ -1973,26 +1973,26 @@ export interface ChannelRole {
|
|
|
1973
1973
|
}
|
|
1974
1974
|
|
|
1975
1975
|
/**
|
|
1976
|
-
*
|
|
1976
|
+
* 流程中签署方和填写方(如果有填写控件存证时)的信息
|
|
1977
1977
|
*/
|
|
1978
1978
|
export interface Recipient {
|
|
1979
1979
|
/**
|
|
1980
|
-
*
|
|
1980
|
+
* 合同参与方的角色ID
|
|
1981
1981
|
*/
|
|
1982
1982
|
RecipientId?: string
|
|
1983
1983
|
/**
|
|
1984
|
-
*
|
|
1985
|
-
ENTERPRISE
|
|
1986
|
-
INDIVIDUAL
|
|
1987
|
-
PROMOTER
|
|
1984
|
+
* 参与者类型, 可以选择的类型如下:
|
|
1985
|
+
<ul><li> **ENTERPRISE** :此角色为企业参与方</li>
|
|
1986
|
+
<li> **INDIVIDUAL** :此角色为个人参与方</li>
|
|
1987
|
+
<li> **PROMOTER** :此角色是发起方</li></ul>
|
|
1988
1988
|
*/
|
|
1989
1989
|
RecipientType?: string
|
|
1990
1990
|
/**
|
|
1991
|
-
*
|
|
1991
|
+
* 合同参与方的角色描述,长度不能超过100,只能由中文、字母、数字和下划线组成。
|
|
1992
1992
|
*/
|
|
1993
1993
|
Description?: string
|
|
1994
1994
|
/**
|
|
1995
|
-
*
|
|
1995
|
+
* 合同参与方的角色名字,长度不能超过20,只能由中文、字母、数字和下划线组成。
|
|
1996
1996
|
*/
|
|
1997
1997
|
RoleName?: string
|
|
1998
1998
|
/**
|
|
@@ -2802,36 +2802,43 @@ export interface UserThreeFactor {
|
|
|
2802
2802
|
*/
|
|
2803
2803
|
export interface ChannelCreateUserAutoSignEnableUrlRequest {
|
|
2804
2804
|
/**
|
|
2805
|
-
*
|
|
2805
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2806
2806
|
*/
|
|
2807
2807
|
Agent: Agent
|
|
2808
2808
|
/**
|
|
2809
|
-
*
|
|
2810
|
-
E_PRESCRIPTION_AUTO_SIGN
|
|
2809
|
+
* 自动签使用的场景值, 可以选择的场景值如下:
|
|
2810
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
2811
|
+
|
|
2812
|
+
注: `现在仅支持电子处方场景`
|
|
2811
2813
|
*/
|
|
2812
2814
|
SceneKey: string
|
|
2813
2815
|
/**
|
|
2814
|
-
*
|
|
2816
|
+
* 执行本接口操作的员工信息。
|
|
2817
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
2815
2818
|
*/
|
|
2816
2819
|
Operator?: UserInfo
|
|
2817
2820
|
/**
|
|
2818
|
-
*
|
|
2821
|
+
* 自动签开通配置信息, 包括开通的人员的信息等
|
|
2819
2822
|
*/
|
|
2820
2823
|
AutoSignConfig?: AutoSignConfig
|
|
2821
2824
|
/**
|
|
2822
|
-
*
|
|
2825
|
+
* 生成的链接类型:
|
|
2826
|
+
<ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
|
|
2827
|
+
<li> **H5SIGN** : 生成H5端开通链接</li></ul>
|
|
2823
2828
|
*/
|
|
2824
2829
|
UrlType?: string
|
|
2825
2830
|
/**
|
|
2826
|
-
*
|
|
2831
|
+
* 是否通知开通方,通知类型:
|
|
2832
|
+
<ul><li>默认不设置为不通知开通方</li>
|
|
2833
|
+
<li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
|
|
2827
2834
|
*/
|
|
2828
2835
|
NotifyType?: string
|
|
2829
2836
|
/**
|
|
2830
|
-
*
|
|
2837
|
+
* 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
|
|
2831
2838
|
*/
|
|
2832
2839
|
NotifyAddress?: string
|
|
2833
2840
|
/**
|
|
2834
|
-
* 链接的过期时间,格式为Unix
|
|
2841
|
+
* 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
|
|
2835
2842
|
*/
|
|
2836
2843
|
ExpiredTime?: number
|
|
2837
2844
|
}
|
|
@@ -4107,27 +4114,37 @@ export interface FlowApproverInfo {
|
|
|
4107
4114
|
*/
|
|
4108
4115
|
export interface ChannelCreateUserAutoSignEnableUrlResponse {
|
|
4109
4116
|
/**
|
|
4110
|
-
*
|
|
4117
|
+
* 个人用户自动签的开通链接, 短链形式。过期时间受 `ExpiredTime` 参数控制。
|
|
4111
4118
|
*/
|
|
4112
4119
|
Url?: string
|
|
4113
4120
|
/**
|
|
4114
|
-
*
|
|
4121
|
+
* 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
4122
|
+
|
|
4123
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
4115
4124
|
*/
|
|
4116
4125
|
AppId?: string
|
|
4117
4126
|
/**
|
|
4118
|
-
*
|
|
4127
|
+
* 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
4128
|
+
|
|
4129
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
4119
4130
|
*/
|
|
4120
4131
|
AppOriginalId?: string
|
|
4121
4132
|
/**
|
|
4122
|
-
*
|
|
4133
|
+
* 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
4134
|
+
|
|
4135
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
4123
4136
|
*/
|
|
4124
4137
|
Path?: string
|
|
4125
4138
|
/**
|
|
4126
|
-
* base64
|
|
4139
|
+
* base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
|
|
4140
|
+
|
|
4141
|
+
注: `如果获取的是H5链接, 则不会返回此二维码图片`
|
|
4127
4142
|
*/
|
|
4128
4143
|
QrCode?: string
|
|
4129
4144
|
/**
|
|
4130
|
-
*
|
|
4145
|
+
* 返回的链接类型
|
|
4146
|
+
<ul><li> 空: 默认小程序端链接</li>
|
|
4147
|
+
<li> **H5SIGN** : h5端链接</li></ul>
|
|
4131
4148
|
*/
|
|
4132
4149
|
UrlType?: string
|
|
4133
4150
|
/**
|
|
@@ -4621,11 +4638,19 @@ export interface ChannelCreateBatchQuickSignUrlResponse {
|
|
|
4621
4638
|
*/
|
|
4622
4639
|
export interface ChannelCreateBatchCancelFlowUrlRequest {
|
|
4623
4640
|
/**
|
|
4624
|
-
*
|
|
4641
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4642
|
+
|
|
4643
|
+
此接口下面信息必填。
|
|
4644
|
+
<ul>
|
|
4645
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
4646
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4647
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4648
|
+
</ul>
|
|
4649
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
4625
4650
|
*/
|
|
4626
4651
|
Agent: Agent
|
|
4627
4652
|
/**
|
|
4628
|
-
*
|
|
4653
|
+
* 要撤销的合同流程ID列表,最多100个,超过100不处理
|
|
4629
4654
|
*/
|
|
4630
4655
|
FlowIds: Array<string>
|
|
4631
4656
|
/**
|
|
@@ -4821,23 +4846,39 @@ export interface ChannelDescribeRolesResponse {
|
|
|
4821
4846
|
*/
|
|
4822
4847
|
export interface ChannelCreateReleaseFlowRequest {
|
|
4823
4848
|
/**
|
|
4824
|
-
*
|
|
4849
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
4850
|
+
|
|
4851
|
+
此接口下面信息必填。
|
|
4852
|
+
<ul>
|
|
4853
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
4854
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
4855
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
4856
|
+
</ul>
|
|
4857
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
4825
4858
|
*/
|
|
4826
4859
|
Agent: Agent
|
|
4827
4860
|
/**
|
|
4828
|
-
*
|
|
4861
|
+
* 待解除的签署流程编号(即原签署流程的编号)。
|
|
4829
4862
|
*/
|
|
4830
4863
|
NeedRelievedFlowId: string
|
|
4831
4864
|
/**
|
|
4832
|
-
*
|
|
4865
|
+
* 解除协议内容, 包括解除理由等信息。
|
|
4833
4866
|
*/
|
|
4834
4867
|
ReliveInfo: RelieveInfo
|
|
4835
4868
|
/**
|
|
4836
|
-
*
|
|
4869
|
+
* 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
|
|
4870
|
+
如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
|
4871
|
+
|
|
4872
|
+
注意:
|
|
4873
|
+
<ul>
|
|
4874
|
+
<li>只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人</li>
|
|
4875
|
+
<li>可以不指定替换签署人, 使用原流程的签署人</li>
|
|
4876
|
+
</ul>
|
|
4837
4877
|
*/
|
|
4838
4878
|
ReleasedApprovers?: Array<ReleasedApprover>
|
|
4839
4879
|
/**
|
|
4840
4880
|
* 签署完回调url,最大长度1000个字符
|
|
4881
|
+
* @deprecated
|
|
4841
4882
|
*/
|
|
4842
4883
|
CallbackUrl?: string
|
|
4843
4884
|
/**
|
|
@@ -4851,9 +4892,18 @@ export interface ChannelCreateReleaseFlowRequest {
|
|
|
4851
4892
|
*/
|
|
4852
4893
|
Operator?: UserInfo
|
|
4853
4894
|
/**
|
|
4854
|
-
*
|
|
4895
|
+
* 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
|
|
4896
|
+
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
4855
4897
|
*/
|
|
4856
4898
|
Deadline?: number
|
|
4899
|
+
/**
|
|
4900
|
+
* 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
|
|
4901
|
+
|
|
4902
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
4903
|
+
|
|
4904
|
+
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
4905
|
+
*/
|
|
4906
|
+
UserData?: string
|
|
4857
4907
|
}
|
|
4858
4908
|
|
|
4859
4909
|
/**
|
|
@@ -5268,31 +5318,40 @@ export interface ChannelCreateEmbedWebUrlResponse {
|
|
|
5268
5318
|
*/
|
|
5269
5319
|
export interface ChannelBatchCancelFlowsRequest {
|
|
5270
5320
|
/**
|
|
5271
|
-
*
|
|
5321
|
+
* 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
5322
|
+
|
|
5323
|
+
此接口下面信息必填。
|
|
5324
|
+
<ul>
|
|
5325
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
5326
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
5327
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
5328
|
+
</ul>
|
|
5329
|
+
第三方平台子客企业和员工必须已经经过实名认证
|
|
5272
5330
|
*/
|
|
5273
5331
|
Agent: Agent
|
|
5274
5332
|
/**
|
|
5275
|
-
*
|
|
5333
|
+
* 要撤销的合同流程ID列表,最多100个,超过100不处理
|
|
5276
5334
|
*/
|
|
5277
5335
|
FlowIds: Array<string>
|
|
5278
5336
|
/**
|
|
5279
|
-
*
|
|
5337
|
+
* 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
5338
|
+
|
|
5339
|
+
备注:`如果不传递撤回原因,那么默认撤回原因是 "自动撤销(通过接口实现)"`
|
|
5280
5340
|
*/
|
|
5281
5341
|
CancelMessage?: string
|
|
5282
5342
|
/**
|
|
5283
|
-
*
|
|
5284
|
-
|
|
5285
|
-
|
|
5286
|
-
|
|
5287
|
-
|
|
5288
|
-
|
|
5343
|
+
* 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
|
|
5344
|
+
|
|
5345
|
+
**0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
5346
|
+
**1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
|
|
5347
|
+
**2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
|
|
5348
|
+
**3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
|
|
5349
|
+
|
|
5350
|
+
注: `CancelMessage为撤销当前合同的理由`
|
|
5351
|
+
|
|
5352
|
+

|
|
5289
5353
|
|
|
5290
|
-
0: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同
|
|
5291
|
-
1: 发起方以"合同内容错误,需要修正"的理由撤销当前合同
|
|
5292
|
-
2: 发起方-典子谦示例企业以"合同内容错误,需要修正"的理由撤销当前合同
|
|
5293
|
-
3: 发起方-典子谦示例企业-张三以"合同内容错误,需要修正"的理由撤销当前合同</br>
|
|
5294
5354
|
|
|
5295
|
-
备注:`如果不传递撤销理由,那么默认撤销理由是 "自动撤销(通过接口实现)"`
|
|
5296
5355
|
*/
|
|
5297
5356
|
CancelMessageFormat?: number
|
|
5298
5357
|
/**
|
|
@@ -5484,25 +5543,24 @@ export interface DescribeTemplatesRequest {
|
|
|
5484
5543
|
Agent: Agent
|
|
5485
5544
|
/**
|
|
5486
5545
|
* 合同模板ID,为32位字符串。
|
|
5487
|
-
|
|
5546
|
+
|
|
5547
|
+
可以通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录企业控制台, 在企业模板中得到合同模板ID。
|
|
5488
5548
|
*/
|
|
5489
5549
|
TemplateId?: string
|
|
5490
5550
|
/**
|
|
5491
|
-
*
|
|
5551
|
+
* 查询模版的内容
|
|
5492
5552
|
|
|
5493
|
-
<ul><li>**0
|
|
5494
|
-
<li>**1
|
|
5553
|
+
<ul><li>**0**:(默认)模板列表及详情</li>
|
|
5554
|
+
<li>**1**:仅模板列表, 不会返回模板中的签署控件, 填写控件, 参与方角色列表等信息</li></ul>
|
|
5495
5555
|
*/
|
|
5496
5556
|
ContentType?: number
|
|
5497
5557
|
/**
|
|
5498
|
-
* 合同模板ID数组,每一个合同模板ID为32
|
|
5499
|
-
建议开发者保存此模板ID,后续用此模板发起合同流程需要此参数。
|
|
5558
|
+
* 合同模板ID数组,每一个合同模板ID为32位字符串, 最多支持200个模板的批量查询。
|
|
5500
5559
|
|
|
5501
|
-
|
|
5502
|
-
1
|
|
5503
|
-
2.
|
|
5504
|
-
|
|
5505
|
-
4. 若传递此参数,分页参数(Limit,Offset)无效```
|
|
5560
|
+
注意:
|
|
5561
|
+
1.` 此参数TemplateIds与TemplateId互为独立,若两者均传入,以TemplateId为准。`
|
|
5562
|
+
2. `请确保每个模板均正确且属于当前企业,若有任一模板不存在,则返回错误。`
|
|
5563
|
+
4. `若传递此参数,分页参数(Limit,Offset)无效`
|
|
5506
5564
|
|
|
5507
5565
|
*/
|
|
5508
5566
|
TemplateIds?: Array<string>
|
|
@@ -5520,7 +5578,7 @@ export interface DescribeTemplatesRequest {
|
|
|
5520
5578
|
*/
|
|
5521
5579
|
Offset?: number
|
|
5522
5580
|
/**
|
|
5523
|
-
*
|
|
5581
|
+
* 模糊搜索的模板名称,注意是模板名的连续部分,长度不能超过200,可支持由中文、字母、数字和下划线组成字符串。
|
|
5524
5582
|
*/
|
|
5525
5583
|
TemplateName?: string
|
|
5526
5584
|
/**
|
|
@@ -5528,10 +5586,10 @@ export interface DescribeTemplatesRequest {
|
|
|
5528
5586
|
*/
|
|
5529
5587
|
ChannelTemplateId?: string
|
|
5530
5588
|
/**
|
|
5531
|
-
*
|
|
5589
|
+
* 返回控件的范围, 是只返回发起方自己的还是所有参与方的
|
|
5532
5590
|
|
|
5533
|
-
<ul><li>**false
|
|
5534
|
-
<li>**true
|
|
5591
|
+
<ul><li>**false**:(默认)只返回发起方控件</li>
|
|
5592
|
+
<li>**true**:返回所有参与方(包括发起方和签署方)控件</li></ul>
|
|
5535
5593
|
*/
|
|
5536
5594
|
QueryAllComponents?: boolean
|
|
5537
5595
|
/**
|
|
@@ -5540,9 +5598,9 @@ export interface DescribeTemplatesRequest {
|
|
|
5540
5598
|
<ul><li>**false**:不获取(默认)</li>
|
|
5541
5599
|
<li>**true**:获取</li></ul>
|
|
5542
5600
|
|
|
5543
|
-
设置为true之后, 返回参数PreviewUrl,为模板的H5
|
|
5544
|
-
|
|
5545
|
-
|
|
5601
|
+
设置为true之后, 返回参数PreviewUrl,为模板的H5预览链接, 有效期5分钟。可以通过浏览器打开此链接预览模板,或者嵌入到iframe中预览模板。
|
|
5602
|
+
|
|
5603
|
+
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
5546
5604
|
*/
|
|
5547
5605
|
WithPreviewUrl?: boolean
|
|
5548
5606
|
/**
|
|
@@ -5551,8 +5609,9 @@ export interface DescribeTemplatesRequest {
|
|
|
5551
5609
|
<ul><li>**false**:不获取(默认)</li>
|
|
5552
5610
|
<li>**true**:获取</li></ul>
|
|
5553
5611
|
|
|
5554
|
-
设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5
|
|
5555
|
-
|
|
5612
|
+
设置为true之后, 返回参数PdfUrl,为模板PDF文件链接,有效期5分钟, 可以用于将PDF文件下载到本地
|
|
5613
|
+
|
|
5614
|
+
注: `此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
5556
5615
|
*/
|
|
5557
5616
|
WithPdfUrl?: boolean
|
|
5558
5617
|
/**
|
|
@@ -5823,15 +5882,17 @@ export interface UsageDetail {
|
|
|
5823
5882
|
*/
|
|
5824
5883
|
export interface ChannelCreateBatchCancelFlowUrlResponse {
|
|
5825
5884
|
/**
|
|
5826
|
-
*
|
|
5885
|
+
* 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
|
|
5827
5886
|
*/
|
|
5828
5887
|
BatchCancelFlowUrl?: string
|
|
5829
5888
|
/**
|
|
5830
|
-
*
|
|
5889
|
+
* 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
|
|
5831
5890
|
*/
|
|
5832
5891
|
FailMessages?: Array<string>
|
|
5833
5892
|
/**
|
|
5834
|
-
*
|
|
5893
|
+
* 签署撤销链接的过期时间(格式为:年-月-日 时:分:秒), 默认是生成链接的24小时后失效
|
|
5894
|
+
|
|
5895
|
+
|
|
5835
5896
|
*/
|
|
5836
5897
|
UrlExpireOn?: string
|
|
5837
5898
|
/**
|