tencentcloud-sdk-nodejs 4.0.878 → 4.0.880
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 +660 -0
- package/SERVICE_CHANGELOG.md +829 -29
- package/package.json +1 -1
- package/products.md +41 -41
- package/src/common/sdk_version.ts +1 -1
- package/src/services/asr/v20190614/asr_models.ts +1 -1
- package/src/services/billing/v20180709/billing_models.ts +5 -0
- package/src/services/cam/v20190116/cam_models.ts +22 -8
- package/src/services/cdwch/v20200915/cdwch_models.ts +8 -8
- package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +8 -0
- package/src/services/cfw/v20190904/cfw_models.ts +4 -4
- package/src/services/ckafka/v20190819/ckafka_client.ts +2 -3
- package/src/services/ckafka/v20190819/ckafka_models.ts +71 -46
- package/src/services/cls/v20201016/cls_models.ts +9 -1
- package/src/services/cmq/v20190304/cmq_client.ts +1 -1
- package/src/services/cmq/v20190304/cmq_models.ts +16 -16
- package/src/services/csip/v20221121/csip_models.ts +47 -1
- package/src/services/cynosdb/v20190107/cynosdb_client.ts +25 -8
- package/src/services/cynosdb/v20190107/cynosdb_models.ts +272 -29
- package/src/services/dlc/v20210125/dlc_client.ts +31 -6
- package/src/services/dlc/v20210125/dlc_models.ts +97 -0
- package/src/services/dsgc/v20190723/dsgc_models.ts +11 -11
- package/src/services/dts/v20180330/dts_client.ts +3 -18
- package/src/services/dts/v20180330/dts_models.ts +63 -117
- package/src/services/emr/v20190103/emr_models.ts +3 -3
- package/src/services/ess/v20201111/ess_client.ts +864 -827
- package/src/services/ess/v20201111/ess_models.ts +162 -84
- package/src/services/essbasic/v20210526/essbasic_client.ts +44 -3
- package/src/services/essbasic/v20210526/essbasic_models.ts +191 -114
- package/src/services/gaap/v20180529/gaap_models.ts +1 -1
- package/src/services/iecp/v20210914/iecp_client.ts +80 -40
- package/src/services/ims/v20201229/ims_client.ts +4 -3
- package/src/services/lke/v20231130/lke_client.ts +61 -18
- package/src/services/lke/v20231130/lke_models.ts +370 -83
- package/src/services/mongodb/v20190725/mongodb_client.ts +19 -6
- package/src/services/mongodb/v20190725/mongodb_models.ts +56 -0
- package/src/services/monitor/v20180724/monitor_models.ts +4 -0
- package/src/services/mps/v20190612/mps_models.ts +69 -8
- package/src/services/ocr/v20181119/ocr_client.ts +13 -10
- package/src/services/ocr/v20181119/ocr_models.ts +361 -169
- package/src/services/organization/v20210331/organization_client.ts +32 -8
- package/src/services/organization/v20210331/organization_models.ts +70 -30
- package/src/services/pts/v20210728/pts_models.ts +1 -1
- package/src/services/sms/v20210111/sms_client.ts +36 -68
- package/src/services/tcr/v20190924/tcr_models.ts +1 -1
- package/src/services/tdmq/v20200217/tdmq_client.ts +115 -19
- package/src/services/tdmq/v20200217/tdmq_models.ts +381 -86
- package/src/services/tke/v20180525/tke_client.ts +13 -0
- package/src/services/tke/v20180525/tke_models.ts +117 -28
- package/src/services/trro/v20220325/trro_models.ts +6 -6
- package/src/services/trtc/v20190722/trtc_models.ts +1 -1
- package/src/services/tse/v20201207/tse_models.ts +7 -1
- package/src/services/tsf/v20180326/tsf_client.ts +4 -2
- package/src/services/tsf/v20180326/tsf_models.ts +33 -28
- package/src/services/waf/v20180125/waf_client.ts +6 -5
- package/src/services/waf/v20180125/waf_models.ts +112 -84
- package/src/services/wedata/v20210820/wedata_client.ts +1 -1
- package/src/services/wedata/v20210820/wedata_models.ts +13 -8
- package/tencentcloud/common/sdk_version.d.ts +1 -1
- package/tencentcloud/common/sdk_version.js +1 -1
- package/tencentcloud/services/asr/v20190614/asr_models.d.ts +1 -1
- package/tencentcloud/services/billing/v20180709/billing_models.d.ts +5 -0
- package/tencentcloud/services/cam/v20190116/cam_models.d.ts +22 -8
- package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +8 -8
- package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +8 -0
- package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +4 -4
- package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +0 -1
- package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +0 -1
- package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +71 -46
- package/tencentcloud/services/cls/v20201016/cls_models.d.ts +9 -1
- package/tencentcloud/services/cmq/v20190304/cmq_client.d.ts +1 -1
- package/tencentcloud/services/cmq/v20190304/cmq_client.js +1 -1
- package/tencentcloud/services/cmq/v20190304/cmq_models.d.ts +16 -16
- package/tencentcloud/services/csip/v20221121/csip_models.d.ts +47 -1
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.d.ts +7 -3
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_client.js +9 -3
- package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +265 -29
- package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +11 -3
- package/tencentcloud/services/dlc/v20210125/dlc_client.js +15 -3
- package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +92 -0
- package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +11 -11
- package/tencentcloud/services/dts/v20180330/dts_client.d.ts +1 -7
- package/tencentcloud/services/dts/v20180330/dts_client.js +0 -8
- package/tencentcloud/services/dts/v20180330/dts_models.d.ts +63 -114
- package/tencentcloud/services/emr/v20190103/emr_models.d.ts +3 -3
- package/tencentcloud/services/ess/v20201111/ess_client.d.ts +517 -496
- package/tencentcloud/services/ess/v20201111/ess_client.js +620 -595
- package/tencentcloud/services/ess/v20201111/ess_models.d.ts +158 -84
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +26 -1
- package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +29 -0
- package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +187 -114
- package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +1 -1
- package/tencentcloud/services/iecp/v20210914/iecp_client.d.ts +60 -20
- package/tencentcloud/services/iecp/v20210914/iecp_client.js +60 -20
- package/tencentcloud/services/ims/v20201229/ims_client.d.ts +4 -3
- package/tencentcloud/services/ims/v20201229/ims_client.js +4 -3
- package/tencentcloud/services/lke/v20231130/lke_client.d.ts +17 -5
- package/tencentcloud/services/lke/v20231130/lke_client.js +24 -6
- package/tencentcloud/services/lke/v20231130/lke_models.d.ts +358 -84
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.d.ts +7 -3
- package/tencentcloud/services/mongodb/v20190725/mongodb_client.js +9 -3
- package/tencentcloud/services/mongodb/v20190725/mongodb_models.d.ts +53 -0
- package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +4 -0
- package/tencentcloud/services/mps/v20190612/mps_models.d.ts +69 -8
- package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
- package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +356 -167
- package/tencentcloud/services/organization/v20210331/organization_client.d.ts +11 -3
- package/tencentcloud/services/organization/v20210331/organization_client.js +15 -3
- package/tencentcloud/services/organization/v20210331/organization_models.d.ts +66 -30
- package/tencentcloud/services/pts/v20210728/pts_models.d.ts +1 -1
- package/tencentcloud/services/sms/v20210111/sms_client.d.ts +33 -65
- package/tencentcloud/services/sms/v20210111/sms_client.js +33 -65
- package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +1 -1
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.d.ts +38 -6
- package/tencentcloud/services/tdmq/v20200217/tdmq_client.js +55 -7
- package/tencentcloud/services/tdmq/v20200217/tdmq_models.d.ts +365 -86
- package/tencentcloud/services/tke/v20180525/tke_client.d.ts +5 -1
- package/tencentcloud/services/tke/v20180525/tke_client.js +6 -0
- package/tencentcloud/services/tke/v20180525/tke_models.d.ts +114 -28
- package/tencentcloud/services/trro/v20220325/trro_models.d.ts +6 -6
- package/tencentcloud/services/trtc/v20190722/trtc_models.d.ts +1 -1
- package/tencentcloud/services/tse/v20201207/tse_models.d.ts +7 -1
- package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +3 -1
- package/tencentcloud/services/tsf/v20180326/tsf_client.js +3 -1
- package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +33 -28
- package/tencentcloud/services/waf/v20180125/waf_client.d.ts +1 -1
- package/tencentcloud/services/waf/v20180125/waf_models.d.ts +110 -83
- package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +1 -1
- package/tencentcloud/services/wedata/v20210820/wedata_client.js +1 -1
- package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +13 -8
- package/test/cynosdb.v20190107.test.js +12 -2
- package/test/dlc.v20210125.test.js +22 -2
- package/test/dts.v20180330.test.js +0 -10
- package/test/ess.v20201111.test.js +182 -162
- package/test/essbasic.v20210526.test.js +20 -0
- package/test/lke.v20231130.test.js +34 -4
- package/test/mongodb.v20190725.test.js +12 -2
- package/test/organization.v20210331.test.js +22 -2
- package/test/tdmq.v20200217.test.js +84 -4
- package/test/tke.v20180525.test.js +10 -0
|
@@ -27,37 +27,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
27
27
|
constructor(clientConfig) {
|
|
28
28
|
super("ess.tencentcloudapi.com", "2020-11-11", clientConfig);
|
|
29
29
|
}
|
|
30
|
-
/**
|
|
31
|
-
* 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
|
|
32
|
-
**注意:**
|
|
33
|
-
1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
|
|
34
|
-
2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件** 。
|
|
35
|
-
3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
|
|
36
|
-
4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
37
|
-
5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
38
|
-
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
39
|
-
6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
40
|
-
*/
|
|
41
|
-
async CreateBatchQuickSignUrl(req, cb) {
|
|
42
|
-
return this.request("CreateBatchQuickSignUrl", req, cb);
|
|
43
|
-
}
|
|
44
|
-
/**
|
|
45
|
-
* 此接口用于查询合同流程的详情信息,支持查询多个(数量不能超过100)。
|
|
46
|
-
|
|
47
|
-
适用场景:可用于主动查询某个合同详情信息。
|
|
48
|
-
*/
|
|
49
|
-
async DescribeFlowInfo(req, cb) {
|
|
50
|
-
return this.request("DescribeFlowInfo", req, cb);
|
|
51
|
-
}
|
|
52
|
-
/**
|
|
53
|
-
* 新增/删除企业应用集成中的回调配置。
|
|
54
|
-
新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
|
|
55
|
-
请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
|
|
56
|
-
更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
|
|
57
|
-
*/
|
|
58
|
-
async ModifyApplicationCallbackInfo(req, cb) {
|
|
59
|
-
return this.request("ModifyApplicationCallbackInfo", req, cb);
|
|
60
|
-
}
|
|
61
30
|
/**
|
|
62
31
|
* 此接口用于启动流程。它是模板发起合同的最后一步。
|
|
63
32
|
在[创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow)和[创建电子文档](https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument)之后,用于开始整个合同流程, 推进流程进入到签署环节。
|
|
@@ -74,32 +43,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
74
43
|
async StartFlow(req, cb) {
|
|
75
44
|
return this.request("StartFlow", req, cb);
|
|
76
45
|
}
|
|
77
|
-
/**
|
|
78
|
-
* 该接口会生成一个手机号变更的链接,用户可以通过该链接进入电子签系统进行手机号的变更。
|
|
79
|
-
该接口支持员工和个人端手机号的变更。
|
|
80
|
-
*/
|
|
81
|
-
async CreateUserMobileChangeUrl(req, cb) {
|
|
82
|
-
return this.request("CreateUserMobileChangeUrl", req, cb);
|
|
83
|
-
}
|
|
84
|
-
/**
|
|
85
|
-
* 用于撤销合同流程<br/>
|
|
86
|
-
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
|
|
87
|
-
- **可撤回合同状态**:未全部签署完成
|
|
88
|
-
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
89
|
-
|
|
90
|
-
注:
|
|
91
|
-
1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
|
|
92
|
-
|
|
93
|
-
2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
|
|
94
|
-

|
|
95
|
-
|
|
96
|
-
3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
97
|
-
|
|
98
|
-
4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
|
|
99
|
-
*/
|
|
100
|
-
async CancelFlow(req, cb) {
|
|
101
|
-
return this.request("CancelFlow", req, cb);
|
|
102
|
-
}
|
|
103
46
|
/**
|
|
104
47
|
* 此接口(DescribeFlowTemplates)用于查询本企业模板列表信息。
|
|
105
48
|
|
|
@@ -123,32 +66,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
123
66
|
async DescribeFlowTemplates(req, cb) {
|
|
124
67
|
return this.request("DescribeFlowTemplates", req, cb);
|
|
125
68
|
}
|
|
126
|
-
/**
|
|
127
|
-
* 本接口(DeleteSealPolicies)用于撤销企业员工持有的印章权限
|
|
128
|
-
*/
|
|
129
|
-
async DeleteSealPolicies(req, cb) {
|
|
130
|
-
return this.request("DeleteSealPolicies", req, cb);
|
|
131
|
-
}
|
|
132
|
-
/**
|
|
133
|
-
* 本接口(DescribeFileUrls)用于查询文件的下载URL。
|
|
134
|
-
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
135
|
-
*/
|
|
136
|
-
async DescribeFileUrls(req, cb) {
|
|
137
|
-
return this.request("DescribeFileUrls", req, cb);
|
|
138
|
-
}
|
|
139
|
-
/**
|
|
140
|
-
* 获取设置自动签印章小程序链接。
|
|
141
|
-
|
|
142
|
-
注意:
|
|
143
|
-
<ul><li>需要<code>企业开通自动签</code>后使用。</li>
|
|
144
|
-
<li>仅支持<code>已经开通了自动签的个人</code>更换自动签印章。</li>
|
|
145
|
-
<li>链接有效期默认7天,<code>最多30天</code>。</li>
|
|
146
|
-
<li>该接口的链接适用于<code>小程序</code>端。</li>
|
|
147
|
-
<li>该接口不会扣除您的合同套餐,暂不参与计费。</li></ul>
|
|
148
|
-
*/
|
|
149
|
-
async CreateUserAutoSignSealUrl(req, cb) {
|
|
150
|
-
return this.request("CreateUserAutoSignSealUrl", req, cb);
|
|
151
|
-
}
|
|
152
69
|
/**
|
|
153
70
|
* 获取个人用户自动签的开通链接。
|
|
154
71
|
|
|
@@ -170,14 +87,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
170
87
|
async CreateFlowGroupSignReview(req, cb) {
|
|
171
88
|
return this.request("CreateFlowGroupSignReview", req, cb);
|
|
172
89
|
}
|
|
173
|
-
/**
|
|
174
|
-
* 此接口(UnbindEmployeeUserIdWithClientOpenId)用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。
|
|
175
|
-
|
|
176
|
-
注:`在调用此接口时,需确保OpenId已通过调用`<a href="https://qian.tencent.com/developers/companyApis/staffs/BindEmployeeUserIdWithClientOpenId" target="_blank">BindEmployeeUserIdWithClientOpenId</a>`接口与电子签系统的UserId绑定过。若OpenId未经过绑定,则无法使用此接口进行解绑操作。`
|
|
177
|
-
*/
|
|
178
|
-
async UnbindEmployeeUserIdWithClientOpenId(req, cb) {
|
|
179
|
-
return this.request("UnbindEmployeeUserIdWithClientOpenId", req, cb);
|
|
180
|
-
}
|
|
181
90
|
/**
|
|
182
91
|
* 客户可以主动调用生成实名链接去做C端用户实名,会对实名的用户进行打标记为调用链接客户的用户
|
|
183
92
|
使用场景:
|
|
@@ -201,37 +110,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
201
110
|
async CreateEmbedWebUrl(req, cb) {
|
|
202
111
|
return this.request("CreateEmbedWebUrl", req, cb);
|
|
203
112
|
}
|
|
204
|
-
/**
|
|
205
|
-
* 对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
|
|
206
|
-
*/
|
|
207
|
-
async VerifyPdf(req, cb) {
|
|
208
|
-
return this.request("VerifyPdf", req, cb);
|
|
209
|
-
}
|
|
210
|
-
/**
|
|
211
|
-
* 管理企业扩展服务 ,企业经办人需要是企业超管或者法人。
|
|
212
|
-
|
|
213
|
-
跳转小程序的几种方式:主要是设置不同的EndPoint
|
|
214
|
-
1. 通过链接Url直接跳转到小程序,不需要返回
|
|
215
|
-
设置EndPoint为WEIXINAPP,得到链接打开即可。
|
|
216
|
-
|
|
217
|
-
2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
|
|
218
|
-
跳转到小程序的实现,参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
|
|
219
|
-
设置EndPoint为APP,得到path。
|
|
220
|
-
|
|
221
|
-
3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
|
|
222
|
-
跳转到小程序的实现,参考官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
223
|
-
设置EndPoint为APP,得到path。
|
|
224
|
-
|
|
225
|
-
4.其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
|
226
|
-
|
|
227
|
-
| 小程序 | AppID | 原始ID |
|
|
228
|
-
| ------------ | ------------ | ------------ |
|
|
229
|
-
| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
230
|
-
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
231
|
-
*/
|
|
232
|
-
async ModifyExtendedService(req, cb) {
|
|
233
|
-
return this.request("ModifyExtendedService", req, cb);
|
|
234
|
-
}
|
|
235
113
|
/**
|
|
236
114
|
* 此接口用于获取企业批量认证异步任务的状态及结果。
|
|
237
115
|
|
|
@@ -242,82 +120,12 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
242
120
|
async DescribeBatchOrganizationRegistrationUrls(req, cb) {
|
|
243
121
|
return this.request("DescribeBatchOrganizationRegistrationUrls", req, cb);
|
|
244
122
|
}
|
|
245
|
-
/**
|
|
246
|
-
* 指定需要批量撤回的签署流程Id,以获取批量撤销链接。
|
|
247
|
-
客户需指定要撤回的签署流程Id,最多可指定100个,超过100则不处理。
|
|
248
|
-
接口调用成功后,将返回批量撤回合同的链接。通过点击链接,可跳转至电子签小程序完成批量撤回操作。
|
|
249
|
-
|
|
250
|
-
- **可撤回合同状态**:未全部签署完成
|
|
251
|
-
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
252
|
-
|
|
253
|
-
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
|
|
254
|
-
|
|
255
|
-
|
|
256
|
-
注:
|
|
257
|
-
1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
|
|
258
|
-
|
|
259
|
-
2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
|
|
260
|
-

|
|
261
|
-
|
|
262
|
-
3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
263
|
-
*/
|
|
264
|
-
async CreateBatchCancelFlowUrl(req, cb) {
|
|
265
|
-
return this.request("CreateBatchCancelFlowUrl", req, cb);
|
|
266
|
-
}
|
|
267
|
-
/**
|
|
268
|
-
* 此接口(DeleteIntegrationDepartment)用于删除企业的部门信息。
|
|
269
|
-
*/
|
|
270
|
-
async DeleteIntegrationDepartment(req, cb) {
|
|
271
|
-
return this.request("DeleteIntegrationDepartment", req, cb);
|
|
272
|
-
}
|
|
273
|
-
/**
|
|
274
|
-
* 此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
|
|
275
|
-
|
|
276
|
-
此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用
|
|
277
|
-
*/
|
|
278
|
-
async BindEmployeeUserIdWithClientOpenId(req, cb) {
|
|
279
|
-
return this.request("BindEmployeeUserIdWithClientOpenId", req, cb);
|
|
280
|
-
}
|
|
281
123
|
/**
|
|
282
124
|
* 本接口(CreatePreparedPersonalEsign)用于创建导入个人印章(处方单场景专用,使用此接口请与客户经理确认)。
|
|
283
125
|
*/
|
|
284
126
|
async CreatePreparedPersonalEsign(req, cb) {
|
|
285
127
|
return this.request("CreatePreparedPersonalEsign", req, cb);
|
|
286
128
|
}
|
|
287
|
-
/**
|
|
288
|
-
* 适用场景: 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
|
|
289
|
-
|
|
290
|
-
限制条件:
|
|
291
|
-
|
|
292
|
-
1.本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
|
|
293
|
-
2.本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。
|
|
294
|
-
3.他方企业仅支持通过姓名+手机号进行补充。
|
|
295
|
-
4.个人签署人支持通过姓名+手机号进行补充,补充动态签署人时:若个人用户已完成实名,则可通过姓名+证件号码进行补充。
|
|
296
|
-
*/
|
|
297
|
-
async CreateFlowApprovers(req, cb) {
|
|
298
|
-
return this.request("CreateFlowApprovers", req, cb);
|
|
299
|
-
}
|
|
300
|
-
/**
|
|
301
|
-
* 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后,可通过此接口查询批量撤销任务的结果。
|
|
302
|
-
*/
|
|
303
|
-
async DescribeCancelFlowsTask(req, cb) {
|
|
304
|
-
return this.request("DescribeCancelFlowsTask", req, cb);
|
|
305
|
-
}
|
|
306
|
-
/**
|
|
307
|
-
* 本接口(CreateOrganizationAuthUrl)用于生成创建企业认证链接。
|
|
308
|
-
用于业务方系统自己生成认证链接进行跳转.而不用电子签自带的生成链接
|
|
309
|
-
|
|
310
|
-
注: **此接口需要购买单独的实名套餐包方可调用,如有需求请联系对接人员评估**
|
|
311
|
-
*/
|
|
312
|
-
async CreateOrganizationAuthUrl(req, cb) {
|
|
313
|
-
return this.request("CreateOrganizationAuthUrl", req, cb);
|
|
314
|
-
}
|
|
315
|
-
/**
|
|
316
|
-
* 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
|
|
317
|
-
*/
|
|
318
|
-
async DeleteIntegrationRoleUsers(req, cb) {
|
|
319
|
-
return this.request("DeleteIntegrationRoleUsers", req, cb);
|
|
320
|
-
}
|
|
321
129
|
/**
|
|
322
130
|
* 提交企业流程审批结果
|
|
323
131
|
**当前存在两种审核操作:**
|
|
@@ -353,14 +161,6 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
353
161
|
async CreateFlowSignReview(req, cb) {
|
|
354
162
|
return this.request("CreateFlowSignReview", req, cb);
|
|
355
163
|
}
|
|
356
|
-
/**
|
|
357
|
-
* 创建发起流程web页面
|
|
358
|
-
<br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
|
|
359
|
-
<br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
|
|
360
|
-
*/
|
|
361
|
-
async CreatePrepareFlow(req, cb) {
|
|
362
|
-
return this.request("CreatePrepareFlow", req, cb);
|
|
363
|
-
}
|
|
364
164
|
/**
|
|
365
165
|
* 创建签署流程电子文档<br />
|
|
366
166
|
|
|
@@ -407,44 +207,52 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
407
207
|
return this.request("CreateDocument", req, cb);
|
|
408
208
|
}
|
|
409
209
|
/**
|
|
410
|
-
*
|
|
210
|
+
* 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
|
|
411
211
|
|
|
412
|
-
|
|
413
|
-
|
|
212
|
+
1. **企业自动签署**
|
|
213
|
+
2. **批量签署授权**
|
|
214
|
+
3. **企业与港澳台居民签署合同**
|
|
215
|
+
4. **拓宽签署方年龄限制**
|
|
216
|
+
5. **个人签署方仅校验手机号**
|
|
217
|
+
6. **隐藏合同经办人姓名**
|
|
218
|
+
7. **正楷临摹签名失败后更换其他签名类型**
|
|
219
|
+
8. **短信通知签署方**
|
|
220
|
+
9. **个人签署方手动签字**
|
|
221
|
+
10. **骑缝章**
|
|
222
|
+
11. **签署密码开通引导**
|
|
414
223
|
|
|
415
|
-
**注意**:
|
|
416
|
-
1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
|
|
417
|
-
- 模板中配置的签署顺序是无序
|
|
418
|
-
- B端企业的签署方式是静默签署
|
|
419
|
-
- B端企业是非首位签署
|
|
420
|
-
2. 通过一码多签签署码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
|
|
421
|
-
]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
|
|
422
|
-
3. 用户通过一码多签签署码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
|
|
423
224
|
|
|
424
|
-
|
|
225
|
+
对应能力开通页面在Web控制台-更多-企业设置-拓展服务,如下图所示:
|
|
425
226
|
|
|
426
|
-

|
|
228
|
+
|
|
229
|
+
注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Operator.UserId需要传递超管或者法人的UserId)
|
|
427
230
|
*/
|
|
428
|
-
async
|
|
429
|
-
return this.request("
|
|
231
|
+
async DescribeExtendedServiceAuthInfos(req, cb) {
|
|
232
|
+
return this.request("DescribeExtendedServiceAuthInfos", req, cb);
|
|
430
233
|
}
|
|
431
234
|
/**
|
|
432
|
-
*
|
|
235
|
+
* 通过此接口获取个人用户自动签的开通状态。
|
|
433
236
|
|
|
434
|
-
|
|
435
|
-
|
|
436
|
-
|
|
437
|
-
|
|
438
|
-
|
|
237
|
+
注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
238
|
+
*/
|
|
239
|
+
async DescribeUserAutoSignStatus(req, cb) {
|
|
240
|
+
return this.request("DescribeUserAutoSignStatus", req, cb);
|
|
241
|
+
}
|
|
242
|
+
/**
|
|
243
|
+
* 此接口(CreateFlowGroupByTemplates)可用于通过多个模板创建合同组签署流程。
|
|
439
244
|
|
|
440
|
-
|
|
245
|
+
适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
|
|
246
|
+
|
|
247
|
+
注:`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
|
|
441
248
|
*/
|
|
442
|
-
async
|
|
443
|
-
return this.request("
|
|
249
|
+
async CreateFlowGroupByTemplates(req, cb) {
|
|
250
|
+
return this.request("CreateFlowGroupByTemplates", req, cb);
|
|
444
251
|
}
|
|
445
252
|
/**
|
|
446
|
-
*
|
|
447
|
-
|
|
253
|
+
* 此接口(CreateFlowByFiles)用来通过上传后的pdf资源编号来创建待签署的合同流程。<br/>
|
|
254
|
+
适用场景:适用非制式的合同文件签署。一般开发者自己有完整的签署文件,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。<br/>
|
|
255
|
+
|
|
448
256
|
<table>
|
|
449
257
|
<thead>
|
|
450
258
|
<tr>
|
|
@@ -473,184 +281,201 @@ class Client extends abstract_client_1.AbstractClient {
|
|
|
473
281
|
</table>
|
|
474
282
|
|
|
475
283
|
|
|
476
|
-
注:配合<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>接口使用。整体的逻辑如下图
|
|
477
284
|
|
|
478
|
-
|
|
285
|
+
该接口需要依赖[上传文件](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口生成pdf资源编号(FileIds)进行使用。(如果非pdf文件需要调用[创建文件转换任务](https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi)接口转换成pdf资源)<br/>
|
|
286
|
+
|
|
287
|
+
|
|
288
|
+

|
|
289
|
+
|
|
290
|
+
注:
|
|
291
|
+
- 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)
|
|
292
|
+
- **静默(自动)签署不支持合同签署方存在填写**功能
|
|
479
293
|
|
|
480
|
-
注:**静默(自动)签署不支持合同签署方存在填写**功能
|
|
481
|
-
<br>
|
|
482
294
|
|
|
483
295
|
<font color="red">相关视频指引</font> <br>
|
|
484
|
-
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/
|
|
485
|
-
2.
|
|
296
|
+
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/ess_uploadfiles.mp4" target="_blank">上传用于合同发起的PDF文件代码编写示例</a><br>
|
|
297
|
+
2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/ess-CreateFlowByFiles.mp4" target="_blank">用PDF文件创建签署流程编写示例</a><br>
|
|
486
298
|
*/
|
|
487
|
-
async
|
|
488
|
-
return this.request("
|
|
299
|
+
async CreateFlowByFiles(req, cb) {
|
|
300
|
+
return this.request("CreateFlowByFiles", req, cb);
|
|
489
301
|
}
|
|
490
302
|
/**
|
|
491
|
-
*
|
|
492
|
-
|
|
493
|
-
|
|
494
|
-
|
|
495
|
-
|
|
496
|
-
|
|
497
|
-
|
|
498
|
-
|
|
499
|
-
|
|
500
|
-
|
|
501
|
-
|
|
303
|
+
* 此接口(DescribeIntegrationRoles)用于分页查询企业角色列表,列表按照角色创建时间升序排列。
|
|
304
|
+
*/
|
|
305
|
+
async DescribeIntegrationRoles(req, cb) {
|
|
306
|
+
return this.request("DescribeIntegrationRoles", req, cb);
|
|
307
|
+
}
|
|
308
|
+
/**
|
|
309
|
+
* 此接口(DescribeIntegrationEmployees)用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
|
|
310
|
+
*/
|
|
311
|
+
async DescribeIntegrationEmployees(req, cb) {
|
|
312
|
+
return this.request("DescribeIntegrationEmployees", req, cb);
|
|
313
|
+
}
|
|
314
|
+
/**
|
|
315
|
+
* 获取个人用户认证证书图片下载URL
|
|
502
316
|
|
|
503
|
-
|
|
504
|
-
|
|
505
|
-
2. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
506
|
-
|
|
317
|
+
个人用户认证证书图片样式如下图
|
|
507
318
|
|
|
508
|
-
|
|
319
|
+

|
|
509
320
|
|
|
510
|
-
|
|
511
|
-
|
|
512
|
-
|
|
513
|
-
|
|
321
|
+
注:
|
|
322
|
+
<ul>
|
|
323
|
+
<li>只能获取个人用户证明图片, 企业员工的暂不支持</li>
|
|
324
|
+
<li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
|
|
325
|
+
</ul>
|
|
514
326
|
*/
|
|
515
|
-
async
|
|
516
|
-
return this.request("
|
|
327
|
+
async CreatePersonAuthCertificateImage(req, cb) {
|
|
328
|
+
return this.request("CreatePersonAuthCertificateImage", req, cb);
|
|
517
329
|
}
|
|
518
330
|
/**
|
|
519
|
-
*
|
|
520
|
-
注意:此接口仅会返回当前员工是否通过[C端用户实名链接(CreateUserVerifyUrl)](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)所实名的员工是否实名,并不会返回个人用户自己在电子签进行实名的状况
|
|
331
|
+
* 此接口用于赋予员工指定的角色权限,如需解绑请使用 DeleteIntegrationRoleUsers 接口。
|
|
521
332
|
*/
|
|
522
|
-
async
|
|
523
|
-
return this.request("
|
|
333
|
+
async CreateIntegrationUserRoles(req, cb) {
|
|
334
|
+
return this.request("CreateIntegrationUserRoles", req, cb);
|
|
524
335
|
}
|
|
525
336
|
/**
|
|
526
|
-
*
|
|
527
|
-
解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
|
|
337
|
+
* 通过此接口,可以创建小程序批量签署链接,个人/企业员工可通过此链接跳转至小程序进行批量签署。请确保生成链接时的身份信息与签署合同参与方的信息保持一致。
|
|
528
338
|
|
|
529
|
-
|
|
530
|
-
<
|
|
531
|
-
|
|
532
|
-
|
|
533
|
-
|
|
534
|
-
<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
|
|
535
|
-
<li>在解除协议签署完毕后,原合同及解除协议均变为已解除状态。</li>
|
|
536
|
-
<li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>
|
|
537
|
-
</ul>
|
|
339
|
+
注意事项:
|
|
340
|
+
- 使用此接口生成链接,需要贵企业先开通 <font color="red">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。
|
|
341
|
+
- 生成批量签署链接时,<font color="red">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。
|
|
342
|
+
- 企业员工批量签署链接:需要传入签署方所在企业名称,用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color="red">该签署方企业必须已完成腾讯电子签企业认证</font>
|
|
343
|
+
- 个人批量签署链接:需要传入签署方用户名字和手机号(或者身份证件信息)参数来生成签署链接。个人批量签署进行的合同的签名区, 全部变成<font color="red">手写签名</font>(不管合同里边设置的签名限制)来进行。
|
|
538
344
|
*/
|
|
539
|
-
async
|
|
540
|
-
return this.request("
|
|
345
|
+
async CreateBatchSignUrl(req, cb) {
|
|
346
|
+
return this.request("CreateBatchSignUrl", req, cb);
|
|
541
347
|
}
|
|
542
348
|
/**
|
|
543
|
-
*
|
|
544
|
-
|
|
545
|
-
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
349
|
+
* 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
|
|
546
350
|
|
|
547
|
-
|
|
351
|
+
1. 发起合同时,**签署人的NotifyType需设置为sms**
|
|
352
|
+
2. 合同中当前状态为 **待签署** 的签署人是催办的对象
|
|
353
|
+
3. **每个合同只能催办一次**
|
|
548
354
|
|
|
549
|
-
|
|
550
|
-
<ul><li>1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署</li>
|
|
551
|
-
<li>2. 签署链接的有效期为<font color="red">90天</font>,超过有效期链接不可用</li>
|
|
552
|
-
<li>3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接</li>
|
|
553
|
-
<li>4. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ul>
|
|
355
|
+
**催办的效果**: 对方会收到如下的短信通知
|
|
554
356
|
|
|
555
|
-
|
|
357
|
+

|
|
556
358
|
|
|
557
|
-
|
|
558
|
-
| ------------ | ------------ | ------------ |
|
|
559
|
-
| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
560
|
-
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
359
|
+
注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
|
|
561
360
|
*/
|
|
562
|
-
async
|
|
563
|
-
return this.request("
|
|
361
|
+
async CreateFlowReminds(req, cb) {
|
|
362
|
+
return this.request("CreateFlowReminds", req, cb);
|
|
564
363
|
}
|
|
565
364
|
/**
|
|
566
|
-
*
|
|
567
|
-
|
|
568
|
-
注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
365
|
+
* 此接口(DescribePersonCertificate)用于查询个人数字证书信息。<br />注:`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。`<br />`2.调用此接口需要开通白名单,使用前请联系相关人员开通白名单。`
|
|
569
366
|
*/
|
|
570
|
-
async
|
|
571
|
-
return this.request("
|
|
367
|
+
async DescribePersonCertificate(req, cb) {
|
|
368
|
+
return this.request("DescribePersonCertificate", req, cb);
|
|
572
369
|
}
|
|
573
370
|
/**
|
|
574
|
-
*
|
|
371
|
+
* 通过此接口可以关闭个人用户自动签功能。
|
|
372
|
+
无需对应的用户刷脸等方式同意即可关闭。
|
|
575
373
|
|
|
576
|
-
|
|
374
|
+
注意:
|
|
577
375
|
|
|
578
|
-
|
|
376
|
+
<ul><li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li>
|
|
377
|
+
<li>如果此用户在开通时候绑定过个人自动签账号许可, 关闭此用户的自动签不会归还个人自动签账号许可的额度。</li></ul>
|
|
579
378
|
*/
|
|
580
|
-
async
|
|
581
|
-
return this.request("
|
|
379
|
+
async DisableUserAutoSign(req, cb) {
|
|
380
|
+
return this.request("DisableUserAutoSign", req, cb);
|
|
582
381
|
}
|
|
583
382
|
/**
|
|
584
|
-
*
|
|
383
|
+
* 该接口(DeleteIntegrationEmployees)用于离职本企业员工,同时可选择是否进行离职交接。
|
|
585
384
|
|
|
586
|
-
1. **企业自动签署**
|
|
587
|
-
2. **批量签署授权**
|
|
588
|
-
3. **企业与港澳台居民签署合同**
|
|
589
|
-
4. **拓宽签署方年龄限制**
|
|
590
|
-
5. **个人签署方仅校验手机号**
|
|
591
|
-
6. **隐藏合同经办人姓名**
|
|
592
|
-
7. **正楷临摹签名失败后更换其他签名类型**
|
|
593
|
-
8. **短信通知签署方**
|
|
594
|
-
9. **个人签署方手动签字**
|
|
595
|
-
10. **骑缝章**
|
|
596
|
-
11. **签署密码开通引导**
|
|
597
385
|
|
|
386
|
+
- 如果该员工没有未处理的合同,可不设置交接人的ReceiveUserId或ReceiveOpenId进行离职操作。
|
|
387
|
+
- 如果该员工有未处理的合同,需要设置ReceiveUserId或ReceiveOpenId表示交接的负责人,交接后员工会进行离职操作。
|
|
598
388
|
|
|
599
|
-
|
|
389
|
+
未处理的合同包括以下:
|
|
600
390
|
|
|
601
|
-
|
|
391
|
+
- 待签署的合同(包括顺序签署还没有轮到的合同,此类合同某些情况可能不会出现在用户的列表中)。
|
|
392
|
+
- 待填写的合同。
|
|
393
|
+
- 待解除的合同等。
|
|
602
394
|
|
|
603
|
-
|
|
395
|
+
注:
|
|
396
|
+
1. <font color="red">超管或法人身份的员工不能被离职</font>, 需要在控制台或小程序更换法人和超管后进行离职删除。
|
|
397
|
+
2. <font color="red">员工存在待处理合同时必须交接</font>后才能离职无人交接时不能被离职删除。
|
|
398
|
+
3. 未实名的员工可以直接离职,不用交接合同
|
|
604
399
|
*/
|
|
605
|
-
async
|
|
606
|
-
return this.request("
|
|
400
|
+
async DeleteIntegrationEmployees(req, cb) {
|
|
401
|
+
return this.request("DeleteIntegrationEmployees", req, cb);
|
|
607
402
|
}
|
|
608
403
|
/**
|
|
609
|
-
*
|
|
610
|
-
|
|
404
|
+
* 获取设置自动签印章小程序链接。
|
|
405
|
+
|
|
406
|
+
注意:
|
|
407
|
+
<ul><li>需要<code>企业开通自动签</code>后使用。</li>
|
|
408
|
+
<li>仅支持<code>已经开通了自动签的个人</code>更换自动签印章。</li>
|
|
409
|
+
<li>链接有效期默认7天,<code>最多30天</code>。</li>
|
|
410
|
+
<li>该接口的链接适用于<code>小程序</code>端。</li>
|
|
411
|
+
<li>该接口不会扣除您的合同套餐,暂不参与计费。</li></ul>
|
|
611
412
|
*/
|
|
612
|
-
async
|
|
613
|
-
return this.request("
|
|
413
|
+
async CreateUserAutoSignSealUrl(req, cb) {
|
|
414
|
+
return this.request("CreateUserAutoSignSealUrl", req, cb);
|
|
614
415
|
}
|
|
615
416
|
/**
|
|
616
|
-
*
|
|
617
|
-
|
|
618
|
-
适用场景:用于合同,印章的文件上传。文件上传以后,
|
|
619
|
-
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
620
|
-
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
417
|
+
* 给医疗个人自动签许可续期。续期成功后,可对医疗自动签许可追加一年有效期,只可续期一次。
|
|
621
418
|
|
|
622
|
-
|
|
623
|
-
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
|
|
627
|
-
|
|
628
|
-
|
|
419
|
+
注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
420
|
+
*/
|
|
421
|
+
async RenewAutoSignLicense(req, cb) {
|
|
422
|
+
return this.request("RenewAutoSignLicense", req, cb);
|
|
423
|
+
}
|
|
424
|
+
/**
|
|
425
|
+
* 对合同流程文件进行数字签名验证,判断数字签名是否有效,合同文件内容是否被篡改。
|
|
426
|
+
*/
|
|
427
|
+
async VerifyPdf(req, cb) {
|
|
428
|
+
return this.request("VerifyPdf", req, cb);
|
|
429
|
+
}
|
|
430
|
+
/**
|
|
431
|
+
* 此接口(BindEmployeeUserIdWithClientOpenId)用于将电子签系统员工UserId与客户系统员工OpenId进行绑定。
|
|
629
432
|
|
|
630
|
-
|
|
631
|
-
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/ess_uploadfiles.mp4" target="_blank">上传用于合同发起的PDF文件代码编写示例</a><br>
|
|
433
|
+
此OpenId只在 [更新企业员工信息 ](https://qian.tencent.com/developers/companyApis/staffs/UpdateIntegrationEmployees)、[移除企业员工](https://qian.tencent.com/developers/companyApis/staffs/DeleteIntegrationEmployees) 等场景下可以使用
|
|
632
434
|
*/
|
|
633
|
-
async
|
|
634
|
-
return this.request("
|
|
435
|
+
async BindEmployeeUserIdWithClientOpenId(req, cb) {
|
|
436
|
+
return this.request("BindEmployeeUserIdWithClientOpenId", req, cb);
|
|
635
437
|
}
|
|
636
438
|
/**
|
|
637
|
-
*
|
|
439
|
+
* 解绑员工与对应角色的关系,如需绑定请使用 CreateIntegrationUserRoles 接口。
|
|
440
|
+
*/
|
|
441
|
+
async DeleteIntegrationRoleUsers(req, cb) {
|
|
442
|
+
return this.request("DeleteIntegrationRoleUsers", req, cb);
|
|
443
|
+
}
|
|
444
|
+
/**
|
|
445
|
+
* 此接口(CreateFlowGroupByFiles)可用于通过多个文件创建合同组签署流程。
|
|
446
|
+
|
|
447
|
+
适用场景:该接口适用于需要一次性完成多份合同签署的情况,多份合同一般具有关联性,用户以目录的形式查看合同。
|
|
638
448
|
|
|
449
|
+
注意事项:使用该接口需要先依赖[多文件上传](https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles)接口返回的FileIds。
|
|
639
450
|
|
|
451
|
+
注:`合同发起后就会扣减合同的额度, 如果未签署完成时撤销合同会返还此额度(过期,拒签,签署完成,解除完成等状态不会返还额度),合同组中每个合同会扣减一个合同额度`
|
|
452
|
+
*/
|
|
453
|
+
async CreateFlowGroupByFiles(req, cb) {
|
|
454
|
+
return this.request("CreateFlowGroupByFiles", req, cb);
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
* 此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。
|
|
458
|
+
*/
|
|
459
|
+
async CreateIntegrationDepartment(req, cb) {
|
|
460
|
+
return this.request("CreateIntegrationDepartment", req, cb);
|
|
461
|
+
}
|
|
462
|
+
/**
|
|
463
|
+
* 提交申请出证报告任务并返回报告ID。
|
|
640
464
|
|
|
641
465
|
注意:
|
|
642
466
|
<ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
|
|
643
|
-
<li
|
|
467
|
+
<li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
|
|
468
|
+
<li>合同流程必须所有参与方`已经签署完成`。</li>
|
|
469
|
+
<li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/companyApis/certificate/DescribeFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
|
|
644
470
|
|
|
645
471
|
<svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
|
|
646
472
|
*/
|
|
647
|
-
async
|
|
648
|
-
return this.request("
|
|
473
|
+
async CreateFlowEvidenceReport(req, cb) {
|
|
474
|
+
return this.request("CreateFlowEvidenceReport", req, cb);
|
|
649
475
|
}
|
|
650
476
|
/**
|
|
651
|
-
*
|
|
652
|
-
|
|
653
|
-
|
|
477
|
+
* 通过模板创建签署流程<br/>
|
|
478
|
+
适用场景:在标准制式的合同场景中,可通过提前预制好模板文件,每次调用模板文件的id,补充合同内容信息及签署信息生成电子合同。
|
|
654
479
|
<table>
|
|
655
480
|
<thead>
|
|
656
481
|
<tr>
|
|
@@ -679,35 +504,45 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
|
679
504
|
</table>
|
|
680
505
|
|
|
681
506
|
|
|
507
|
+
注:配合<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>接口使用。整体的逻辑如下图
|
|
682
508
|
|
|
683
|
-
|
|
684
|
-
|
|
685
|
-
|
|
686
|
-

|
|
687
|
-
|
|
688
|
-
注:
|
|
689
|
-
- 合同**发起后就会扣减合同的额度**, 只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。(**过期,拒签,签署完成,解除完成等状态不会返还额度**)
|
|
690
|
-
- **静默(自动)签署不支持合同签署方存在填写**功能
|
|
509
|
+

|
|
691
510
|
|
|
511
|
+
注:**静默(自动)签署不支持合同签署方存在填写**功能
|
|
512
|
+
<br>
|
|
692
513
|
|
|
693
514
|
<font color="red">相关视频指引</font> <br>
|
|
694
|
-
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/
|
|
695
|
-
2.
|
|
515
|
+
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/createflow_seversign.mp4" target="_blank">创建静默(自动)签署模板和开通自动签署</a><br>
|
|
516
|
+
2. <a href="https://dyn.ess.tencent.cn/guide/apivideo/flow_document_start.mp4" target="_blank">用模板创建发起合同</a><br>
|
|
696
517
|
*/
|
|
697
|
-
async
|
|
698
|
-
return this.request("
|
|
518
|
+
async CreateFlow(req, cb) {
|
|
519
|
+
return this.request("CreateFlow", req, cb);
|
|
699
520
|
}
|
|
700
521
|
/**
|
|
701
|
-
*
|
|
702
|
-
|
|
703
|
-
这个操作与页面端激活成员企业操作类似
|
|
704
|
-

|
|
522
|
+
* 发起解除协议的主要应用场景为:基于一份已经签署的合同(签署流程),进行解除操作。
|
|
523
|
+
解除协议的模板是官方提供 ,经过提供法务审核,暂不支持自定义。
|
|
705
524
|
|
|
706
|
-
|
|
707
|
-
|
|
525
|
+
注意:
|
|
526
|
+
<ul><li><code>原合同必须签署完</code>成后才能发起解除协议。</li>
|
|
527
|
+
<li>只有原合同企业类型的参与人才能发起解除协议,<code>个人参与方不能发起解除协议</code>。</li>
|
|
528
|
+
<li>原合同个人类型参与人必须是解除协议的参与人,<code>不能更换其他第三方个人</code>参与解除协议。</li>
|
|
529
|
+
<li>如果原合同企业参与人无法参与解除协议,可以指定同企业具有同等权限的<code>企业员工代为处理</code>。</li>
|
|
530
|
+
<li>发起解除协议同发起其他企业合同一样,也会参与合同<code>扣费</code>,扣费标准同其他类型合同。</li>
|
|
531
|
+
<li>在解除协议签署完毕后,原合同及解除协议均变为已解除状态。</li>
|
|
532
|
+
<li>非原合同企业参与人发起解除协议时,需要有<code>解除合同的权限</code>。</li>
|
|
533
|
+
</ul>
|
|
708
534
|
*/
|
|
709
|
-
async
|
|
710
|
-
return this.request("
|
|
535
|
+
async CreateReleaseFlow(req, cb) {
|
|
536
|
+
return this.request("CreateReleaseFlow", req, cb);
|
|
537
|
+
}
|
|
538
|
+
/**
|
|
539
|
+
* 该接口用于获取创建法人章的二维码<br/>
|
|
540
|
+
|
|
541
|
+
**注意**
|
|
542
|
+
1. 该二维码**有效期为7天**,过期后将失效,可重新创建 。
|
|
543
|
+
*/
|
|
544
|
+
async CreateLegalSealQrCode(req, cb) {
|
|
545
|
+
return this.request("CreateLegalSealQrCode", req, cb);
|
|
711
546
|
}
|
|
712
547
|
/**
|
|
713
548
|
* 本接口(CreateSeal)用于创建企业电子印章,支持创建企业公章,合同章,财务专用章和人事专用章创建。
|
|
@@ -721,27 +556,26 @@ p.s.
|
|
|
721
556
|
return this.request("CreateSeal", req, cb);
|
|
722
557
|
}
|
|
723
558
|
/**
|
|
724
|
-
* 此接口(
|
|
725
|
-
*/
|
|
726
|
-
async DescribeIntegrationRoles(req, cb) {
|
|
727
|
-
return this.request("DescribeIntegrationRoles", req, cb);
|
|
728
|
-
}
|
|
729
|
-
/**
|
|
730
|
-
* 此接口(CreateIntegrationDepartment)用于创建企业的部门信息,支持绑定客户系统部门ID。
|
|
731
|
-
*/
|
|
732
|
-
async CreateIntegrationDepartment(req, cb) {
|
|
733
|
-
return this.request("CreateIntegrationDepartment", req, cb);
|
|
734
|
-
}
|
|
735
|
-
/**
|
|
736
|
-
* 此接口(GetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
737
|
-
前提条件:已调用 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
|
|
559
|
+
* 此接口(CreateMultiFlowSignQRCode)用于创建一码多签签署码。
|
|
738
560
|
|
|
739
|
-
|
|
740
|
-
|
|
741
|
-
|
|
561
|
+
**适用场景**:
|
|
562
|
+
签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
563
|
+
|
|
564
|
+
**注意**:
|
|
565
|
+
1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
|
|
566
|
+
- 模板中配置的签署顺序是无序
|
|
567
|
+
- B端企业的签署方式是静默签署
|
|
568
|
+
- B端企业是非首位签署
|
|
569
|
+
2. 通过一码多签签署码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
|
|
570
|
+
]( https://qian.tencent.com/developers/company/callback_types_contracts_sign)
|
|
571
|
+
3. 用户通过一码多签签署码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/company/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
|
|
572
|
+
|
|
573
|
+
签署码的样式如下图:
|
|
574
|
+
|
|
575
|
+

|
|
742
576
|
*/
|
|
743
|
-
async
|
|
744
|
-
return this.request("
|
|
577
|
+
async CreateMultiFlowSignQRCode(req, cb) {
|
|
578
|
+
return this.request("CreateMultiFlowSignQRCode", req, cb);
|
|
745
579
|
}
|
|
746
580
|
/**
|
|
747
581
|
* 查询企业扩展服务的授权详情(列表),当前支持查询以下内容:
|
|
@@ -754,27 +588,6 @@ p.s.
|
|
|
754
588
|
async DescribeExtendedServiceAuthDetail(req, cb) {
|
|
755
589
|
return this.request("DescribeExtendedServiceAuthDetail", req, cb);
|
|
756
590
|
}
|
|
757
|
-
/**
|
|
758
|
-
* 通过此接口(DescribeBillUsage)查询该企业的套餐套餐使用情况。
|
|
759
|
-
*/
|
|
760
|
-
async DescribeBillUsage(req, cb) {
|
|
761
|
-
return this.request("DescribeBillUsage", req, cb);
|
|
762
|
-
}
|
|
763
|
-
/**
|
|
764
|
-
* 此接口(ModifyIntegrationDepartment)用于更新企业的部门信息,支持更新部门名称、客户系统部门ID和部门序号等信息。
|
|
765
|
-
*/
|
|
766
|
-
async ModifyIntegrationDepartment(req, cb) {
|
|
767
|
-
return this.request("ModifyIntegrationDepartment", req, cb);
|
|
768
|
-
}
|
|
769
|
-
/**
|
|
770
|
-
* 创建企业扩展服务授权,当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
|
|
771
|
-
该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口授权给企业员工。
|
|
772
|
-
|
|
773
|
-
注:“企业自动签授权”支持集团代子企业操作,请联系运营开通此功能。
|
|
774
|
-
*/
|
|
775
|
-
async CreateExtendedServiceAuthInfos(req, cb) {
|
|
776
|
-
return this.request("CreateExtendedServiceAuthInfos", req, cb);
|
|
777
|
-
}
|
|
778
591
|
/**
|
|
779
592
|
* 此接口(CancelMultiFlowSignQRCode)用于废除一码多签签署码。
|
|
780
593
|
该接口所需的二维码ID,源自[创建一码多签签署码](https://qian.tencent.com/developers/companyApis/startFlows/CreateMultiFlowSignQRCode)生成的。
|
|
@@ -784,10 +597,25 @@ p.s.
|
|
|
784
597
|
return this.request("CancelMultiFlowSignQRCode", req, cb);
|
|
785
598
|
}
|
|
786
599
|
/**
|
|
787
|
-
*
|
|
600
|
+
* 查询流程基础信息
|
|
601
|
+
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
602
|
+
|
|
603
|
+
注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
|
|
788
604
|
*/
|
|
789
|
-
async
|
|
790
|
-
return this.request("
|
|
605
|
+
async DescribeFlowBriefs(req, cb) {
|
|
606
|
+
return this.request("DescribeFlowBriefs", req, cb);
|
|
607
|
+
}
|
|
608
|
+
/**
|
|
609
|
+
* 该接口用于在使用视频认证方式签署合同后,获取用户的签署人脸认证视频。
|
|
610
|
+
|
|
611
|
+
1. 该接口**仅适用于在H5端签署**的合同,**在通过视频认证后**获取人脸图片。
|
|
612
|
+
2. 该接口**不支持小程序端**的签署人脸图片获取。
|
|
613
|
+
3. 请在**签署完成后的三天内**获取人脸图片,**过期后将无法获取**。
|
|
614
|
+
|
|
615
|
+
**注意:该接口需要开通白名单,请联系客户经理开通后使用。**
|
|
616
|
+
*/
|
|
617
|
+
async DescribeSignFaceVideo(req, cb) {
|
|
618
|
+
return this.request("DescribeSignFaceVideo", req, cb);
|
|
791
619
|
}
|
|
792
620
|
/**
|
|
793
621
|
* 该接口用于发起合同后,生成用户的签署链接 <br/>
|
|
@@ -802,42 +630,59 @@ p.s.
|
|
|
802
630
|
return this.request("CreateFlowSignUrl", req, cb);
|
|
803
631
|
}
|
|
804
632
|
/**
|
|
805
|
-
*
|
|
806
|
-
|
|
807
|
-
个人用户认证证书图片样式如下图
|
|
808
|
-
|
|
809
|
-

|
|
633
|
+
* 用来撤销<a href="https://qian.tencent.com/developers/companyApis/users/CreateUserAutoSignEnableUrl" target="_blank">获取个人用户自动签的开通状态</a>生成的开通链接,撤销生成的链接失效。
|
|
810
634
|
|
|
811
635
|
注:
|
|
812
|
-
<ul>
|
|
813
|
-
<li
|
|
814
|
-
<li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。 </li>
|
|
815
|
-
</ul>
|
|
636
|
+
<ul><li>若个人用户已经用生成的完成自动签署的开通,撤销链接无效不会对开通结果产生影响(此情况接口会报错)。</li>
|
|
637
|
+
<li>处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。</li></ul>
|
|
816
638
|
*/
|
|
817
|
-
async
|
|
818
|
-
return this.request("
|
|
639
|
+
async CancelUserAutoSignEnableUrl(req, cb) {
|
|
640
|
+
return this.request("CancelUserAutoSignEnableUrl", req, cb);
|
|
819
641
|
}
|
|
820
642
|
/**
|
|
821
|
-
*
|
|
822
|
-
前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
|
|
823
|
-
适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
|
|
824
|
-
适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
|
|
825
|
-
转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
826
|
-
注:
|
|
827
|
-
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
828
|
-
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
643
|
+
* 通过此接口(DescribeBillUsageDetail)查询该企业的套餐消耗详情。
|
|
829
644
|
*/
|
|
830
|
-
async
|
|
831
|
-
return this.request("
|
|
645
|
+
async DescribeBillUsageDetail(req, cb) {
|
|
646
|
+
return this.request("DescribeBillUsageDetail", req, cb);
|
|
832
647
|
}
|
|
833
648
|
/**
|
|
834
|
-
*
|
|
835
|
-
适用场景:可用于主动查询某个合同流程的签署状态信息。可以配合回调通知使用。
|
|
836
|
-
|
|
837
|
-
注: `每个企业限制日调用量限制:100W,当日超过此限制后再调用接口返回错误`
|
|
649
|
+
* 此接口(DescribeIntegrationDepartments)用于查询企业的部门信息列表,支持查询单个部门节点或单个部门节点及一级子节点部门列表。
|
|
838
650
|
*/
|
|
839
|
-
async
|
|
840
|
-
return this.request("
|
|
651
|
+
async DescribeIntegrationDepartments(req, cb) {
|
|
652
|
+
return this.request("DescribeIntegrationDepartments", req, cb);
|
|
653
|
+
}
|
|
654
|
+
/**
|
|
655
|
+
* 此接口(ModifyIntegrationDepartment)用于更新企业的部门信息,支持更新部门名称、客户系统部门ID和部门序号等信息。
|
|
656
|
+
*/
|
|
657
|
+
async ModifyIntegrationDepartment(req, cb) {
|
|
658
|
+
return this.request("ModifyIntegrationDepartment", req, cb);
|
|
659
|
+
}
|
|
660
|
+
/**
|
|
661
|
+
* 此API接口用来查询加入集团的成员企业信息
|
|
662
|
+
适用场景:子企业在加入集团后,主企业可能通过此接口获取到所有的子企业列表,方便进行展示和统计
|
|
663
|
+
*/
|
|
664
|
+
async DescribeOrganizationGroupOrganizations(req, cb) {
|
|
665
|
+
return this.request("DescribeOrganizationGroupOrganizations", req, cb);
|
|
666
|
+
}
|
|
667
|
+
/**
|
|
668
|
+
* 该接口会生成一个手机号变更的链接,用户可以通过该链接进入电子签系统进行手机号的变更。
|
|
669
|
+
该接口支持员工和个人端手机号的变更。
|
|
670
|
+
*/
|
|
671
|
+
async CreateUserMobileChangeUrl(req, cb) {
|
|
672
|
+
return this.request("CreateUserMobileChangeUrl", req, cb);
|
|
673
|
+
}
|
|
674
|
+
/**
|
|
675
|
+
* 本接口(DeleteSealPolicies)用于撤销企业员工持有的印章权限
|
|
676
|
+
*/
|
|
677
|
+
async DeleteSealPolicies(req, cb) {
|
|
678
|
+
return this.request("DeleteSealPolicies", req, cb);
|
|
679
|
+
}
|
|
680
|
+
/**
|
|
681
|
+
* 本接口(DescribeFileUrls)用于查询文件的下载URL。
|
|
682
|
+
适用场景:通过传参合同流程编号,下载对应的合同PDF文件流到本地。
|
|
683
|
+
*/
|
|
684
|
+
async DescribeFileUrls(req, cb) {
|
|
685
|
+
return this.request("DescribeFileUrls", req, cb);
|
|
841
686
|
}
|
|
842
687
|
/**
|
|
843
688
|
* 此接口(CreateIntegrationRole)用来创建企业自定义的SaaS角色或集团角色。
|
|
@@ -856,22 +701,68 @@ p.s.
|
|
|
856
701
|
return this.request("CreateIntegrationRole", req, cb);
|
|
857
702
|
}
|
|
858
703
|
/**
|
|
859
|
-
*
|
|
704
|
+
* 管理企业扩展服务 ,企业经办人需要是企业超管或者法人。
|
|
705
|
+
|
|
706
|
+
跳转小程序的几种方式:主要是设置不同的EndPoint
|
|
707
|
+
1. 通过链接Url直接跳转到小程序,不需要返回
|
|
708
|
+
设置EndPoint为WEIXINAPP,得到链接打开即可。
|
|
709
|
+
|
|
710
|
+
2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
|
|
711
|
+
跳转到小程序的实现,参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
|
|
712
|
+
设置EndPoint为APP,得到path。
|
|
713
|
+
|
|
714
|
+
3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
|
|
715
|
+
跳转到小程序的实现,参考官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
716
|
+
设置EndPoint为APP,得到path。
|
|
717
|
+
|
|
718
|
+
4.其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
|
719
|
+
|
|
720
|
+
| 小程序 | AppID | 原始ID |
|
|
721
|
+
| ------------ | ------------ | ------------ |
|
|
722
|
+
| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
723
|
+
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
860
724
|
*/
|
|
861
|
-
async
|
|
862
|
-
return this.request("
|
|
725
|
+
async ModifyExtendedService(req, cb) {
|
|
726
|
+
return this.request("ModifyExtendedService", req, cb);
|
|
863
727
|
}
|
|
864
728
|
/**
|
|
865
|
-
*
|
|
729
|
+
* 在已发起的签署流程中,支持对签署截止日期进行延期操作,主要涉及以下两个维度:
|
|
730
|
+
1. 合同(流程)维度:只需要传递签署流程ID。这将对签署流程和发起时未单独设定签署截止时间的签署人进行延期操作。
|
|
731
|
+
2. 签署人维度:需要传递流程ID和签署人ID。此操作将对签署人进行延期操作,尤其对于有序的合同(流程),签署截止时间不能超过后一位合同(流程)签署人的流程截止时间。
|
|
866
732
|
|
|
867
|
-
|
|
868
|
-
|
|
869
|
-
|
|
733
|
+
此接口有如下限制条件:
|
|
734
|
+
1. 执行操作的员工需为发起方企业的超级管理员、法定代表人或签署流程的发起人。
|
|
735
|
+
2. 在延长整个签署流程时,签署流程应至少还有一方未签署(即签署流程不能处于已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态)。
|
|
736
|
+
3. 在延长整个签署流程时,新的签署截止日期应晚于合同已设定的签署截止日期和当前日期。
|
|
737
|
+
4. 在延长签署方的截止时间时,签署方不能处于流程完结或已终止状态(即签署人不能处于已签署、已拒签、已过期、已撤回、拒绝填写、已解除等状态)。
|
|
738
|
+
5. 在延长签署方的截止时间时,签署方的新签署截止日期应晚于当前日期和签署方已设定的截止日期。若为有序合同,还应早于或等于下一签署人的截止日期,且早于签署流程整体的截止日期。
|
|
739
|
+
6. 不支持操作合同组合同。
|
|
740
|
+
*/
|
|
741
|
+
async ModifyFlowDeadline(req, cb) {
|
|
742
|
+
return this.request("ModifyFlowDeadline", req, cb);
|
|
743
|
+
}
|
|
744
|
+
/**
|
|
745
|
+
* 获取区块链存证报告查看链接/二维码接口
|
|
870
746
|
|
|
871
|
-
|
|
747
|
+
适用场景:企业员工可以通过此接口生成合同区块链存证报告的查看链接/二维码,以供他人扫码打开腾讯电子签小程序查看。
|
|
748
|
+
|
|
749
|
+
[点击查看区块链存证报告样式](https://qcloudimg.tencent-cloud.cn/raw/47d5e9c2ffa90ad4e27b3cd14095aa08.jpg)
|
|
750
|
+
|
|
751
|
+
注:
|
|
752
|
+
<ul><li>1. 二维码下载链接过期时间为5分钟,请尽快下载保存。二维码/短链的过期时间为<font color="red">7天</font>,超过有效期则不可用。</li>
|
|
753
|
+
<li>2. 合同状态需为<font color="red">签署完成</font> 、<font color="red">已解除</font>才能生成报告查看二维码/短链。</li>
|
|
754
|
+
<li>3. 调用接口时,需确保接口调用身份拥有此合同的访问数据权限或为合同参与方。</li>
|
|
755
|
+
<li>4. 通过扫码或者点击链接,用户无需登录或者鉴权即可查看对应合同的区块链存证报告,请妥善保管好二维码或链接。</li></ul>
|
|
872
756
|
*/
|
|
873
|
-
async
|
|
874
|
-
return this.request("
|
|
757
|
+
async CreateFlowBlockchainEvidenceUrl(req, cb) {
|
|
758
|
+
return this.request("CreateFlowBlockchainEvidenceUrl", req, cb);
|
|
759
|
+
}
|
|
760
|
+
/**
|
|
761
|
+
* 用于客户企业在调用生成[C端用户实名链接(CreateUserVerifyUrl)](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)接口之前判断C端用户是否实名,如果已经实名,就不需要再次调用生成C端链接接口去实名
|
|
762
|
+
注意:此接口仅会返回当前员工是否通过[C端用户实名链接(CreateUserVerifyUrl)](https://qian.tencent.com/developers/companyApis/users/CreateUserVerifyUrl)所实名的员工是否实名,并不会返回个人用户自己在电子签进行实名的状况
|
|
763
|
+
*/
|
|
764
|
+
async DescribeUserVerifyStatus(req, cb) {
|
|
765
|
+
return this.request("DescribeUserVerifyStatus", req, cb);
|
|
875
766
|
}
|
|
876
767
|
/**
|
|
877
768
|
* 此接口(ModifyIntegrationRole)用来更新企业自定义的SaaS角色或集团角色。
|
|
@@ -890,124 +781,41 @@ p.s.
|
|
|
890
781
|
return this.request("ModifyIntegrationRole", req, cb);
|
|
891
782
|
}
|
|
892
783
|
/**
|
|
893
|
-
*
|
|
784
|
+
* 本接口(CreateBatchOrganizationRegistrationTasks)用于批量创建企业认证链接
|
|
785
|
+
该接口为异步提交任务接口,需要跟查询企业批量认证链接(DescribeBatchOrganizationRegistrationUrls) 配合使用.
|
|
894
786
|
|
|
895
|
-
|
|
896
|
-
- 使用此接口生成链接,需要贵企业先开通 <font color="red">使用手机号验证签署方身份 </font>功能。您可以在 <b>【腾讯电子签网页端】->【企业设置】->【拓展服务】</b>中找到该功能。
|
|
897
|
-
- 生成批量签署链接时,<font color="red">合同目标参与方的状态必须为<b>待签署</b>状态</font>。签署人点击链接后需要输入短信验证码才能查看合同内容。
|
|
898
|
-
- 企业员工批量签署链接:需要传入签署方所在企业名称,用户名字和手机号(或者身份证件信息)参数来生成签署链接。<font color="red">该签署方企业必须已完成腾讯电子签企业认证</font>
|
|
899
|
-
- 个人批量签署链接:需要传入签署方用户名字和手机号(或者身份证件信息)参数来生成签署链接。个人批量签署进行的合同的签名区, 全部变成<font color="red">手写签名</font>(不管合同里边设置的签名限制)来进行。
|
|
900
|
-
*/
|
|
901
|
-
async CreateBatchSignUrl(req, cb) {
|
|
902
|
-
return this.request("CreateBatchSignUrl", req, cb);
|
|
903
|
-
}
|
|
904
|
-
/**
|
|
905
|
-
* 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
|
|
906
|
-
附注:
|
|
907
|
-
- 员工必须需作为批量签署合同的签署方,or或签合同的候选人之一。
|
|
908
|
-
- 对于本方企业:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
|
|
909
|
-
- 若要生成他发企业签署链接:应传RecipientIds,且制定的合同必须是接口调用方发起的。
|
|
910
|
-
- 支持待签署、待填写状态的合同生成签署链接。
|
|
911
|
-
*/
|
|
912
|
-
async CreateOrganizationBatchSignUrl(req, cb) {
|
|
913
|
-
return this.request("CreateOrganizationBatchSignUrl", req, cb);
|
|
914
|
-
}
|
|
915
|
-
/**
|
|
916
|
-
* 指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办:
|
|
917
|
-
|
|
918
|
-
1. 发起合同时,**签署人的NotifyType需设置为sms**
|
|
919
|
-
2. 合同中当前状态为 **待签署** 的签署人是催办的对象
|
|
920
|
-
3. **每个合同只能催办一次**
|
|
921
|
-
|
|
922
|
-
**催办的效果**: 对方会收到如下的短信通知
|
|
923
|
-
|
|
924
|
-

|
|
925
|
-
|
|
926
|
-
注:`合同催办是白名单功能,请联系客户经理申请开白后使用`
|
|
927
|
-
*/
|
|
928
|
-
async CreateFlowReminds(req, cb) {
|
|
929
|
-
return this.request("CreateFlowReminds", req, cb);
|
|
930
|
-
}
|
|
931
|
-
/**
|
|
932
|
-
* 查询流程填写控件内容,可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
|
|
933
|
-
*/
|
|
934
|
-
async DescribeFlowComponents(req, cb) {
|
|
935
|
-
return this.request("DescribeFlowComponents", req, cb);
|
|
936
|
-
}
|
|
937
|
-
/**
|
|
938
|
-
* 通过此接口可以关闭个人用户自动签功能。
|
|
939
|
-
无需对应的用户刷脸等方式同意即可关闭。
|
|
940
|
-
|
|
941
|
-
注意:
|
|
787
|
+
批量创建链接有以下限制:
|
|
942
788
|
|
|
943
|
-
|
|
944
|
-
|
|
945
|
-
|
|
946
|
-
|
|
947
|
-
return this.request("DisableUserAutoSign", req, cb);
|
|
948
|
-
}
|
|
949
|
-
/**
|
|
950
|
-
* 此接口(DescribePersonCertificate)用于查询个人数字证书信息。<br />注:`1.目前仅用于查询开通了医疗自动签署功能的个人数字证书。`<br />`2.调用此接口需要开通白名单,使用前请联系相关人员开通白名单。`
|
|
951
|
-
*/
|
|
952
|
-
async DescribePersonCertificate(req, cb) {
|
|
953
|
-
return this.request("DescribePersonCertificate", req, cb);
|
|
954
|
-
}
|
|
955
|
-
/**
|
|
956
|
-
* 通过AuthCode查询个人用户是否实名
|
|
789
|
+
1. 单次最多创建10个企业。
|
|
790
|
+
2. 一天同一家企业最多创建8000家企业。
|
|
791
|
+
3. 同一批创建的企业不能重复 其中包括 企业名称,企业统一信用代码
|
|
792
|
+
4. 跳转到小程序的实现,参考微信官方文档(分为全屏、半屏两种方式),如何配置也可以请参考: 跳转电子签小程序配置
|
|
957
793
|
|
|
794
|
+
注:
|
|
958
795
|
|
|
959
|
-
|
|
960
|
-
|
|
961
|
-
<
|
|
962
|
-
|
|
963
|
-
</ul>
|
|
964
|
-
*/
|
|
965
|
-
async DescribeThirdPartyAuthCode(req, cb) {
|
|
966
|
-
return this.request("DescribeThirdPartyAuthCode", req, cb);
|
|
967
|
-
}
|
|
968
|
-
/**
|
|
969
|
-
* 给医疗个人自动签许可续期。续期成功后,可对医疗自动签许可追加一年有效期,只可续期一次。
|
|
796
|
+
1. **此接口需要购买单独的实名套餐包方可调用,如有需求请联系对接人员评估**
|
|
797
|
+
|
|
798
|
+
2. 如果生成的链接是APP链接,跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
799
|
+
|
|
970
800
|
|
|
971
|
-
|
|
972
|
-
*/
|
|
973
|
-
async RenewAutoSignLicense(req, cb) {
|
|
974
|
-
return this.request("RenewAutoSignLicense", req, cb);
|
|
975
|
-
}
|
|
976
|
-
/**
|
|
977
|
-
* 用来设置本企业嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),设置后获取的web签署界面都会使用此配置进行展示。
|
|
801
|
+
**腾讯电子签小程序的AppID 和 原始Id如下:**
|
|
978
802
|
|
|
979
|
-
|
|
980
|
-
|
|
981
|
-
|
|
982
|
-
|
|
983
|
-
}
|
|
984
|
-
/**
|
|
985
|
-
* 查询企业印章的列表,需要操作者具有查询印章权限
|
|
986
|
-
客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
|
|
803
|
+
| 小程序 | AppID | 原始ID |
|
|
804
|
+
| --- | --- | --- |
|
|
805
|
+
| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
806
|
+
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
987
807
|
*/
|
|
988
|
-
async
|
|
989
|
-
return this.request("
|
|
808
|
+
async CreateBatchOrganizationRegistrationTasks(req, cb) {
|
|
809
|
+
return this.request("CreateBatchOrganizationRegistrationTasks", req, cb);
|
|
990
810
|
}
|
|
991
811
|
/**
|
|
992
|
-
*
|
|
993
|
-
|
|
994
|
-
|
|
995
|
-
- 如果该员工没有未处理的合同,可不设置交接人的ReceiveUserId或ReceiveOpenId进行离职操作。
|
|
996
|
-
- 如果该员工有未处理的合同,需要设置ReceiveUserId或ReceiveOpenId表示交接的负责人,交接后员工会进行离职操作。
|
|
997
|
-
|
|
998
|
-
未处理的合同包括以下:
|
|
999
|
-
|
|
1000
|
-
- 待签署的合同(包括顺序签署还没有轮到的合同,此类合同某些情况可能不会出现在用户的列表中)。
|
|
1001
|
-
- 待填写的合同。
|
|
1002
|
-
- 待解除的合同等。
|
|
812
|
+
* 创建企业扩展服务授权,当前仅支持授权 “企业自动签” 和 “批量签署” 给企业员工。
|
|
813
|
+
该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口授权给企业员工。
|
|
1003
814
|
|
|
1004
|
-
|
|
1005
|
-
1. <font color="red">超管或法人身份的员工不能被离职</font>, 需要在控制台或小程序更换法人和超管后进行离职删除。
|
|
1006
|
-
2. <font color="red">员工存在待处理合同时必须交接</font>后才能离职无人交接时不能被离职删除。
|
|
1007
|
-
3. 未实名的员工可以直接离职,不用交接合同
|
|
815
|
+
注:“企业自动签授权”支持集团代子企业操作,请联系运营开通此功能。
|
|
1008
816
|
*/
|
|
1009
|
-
async
|
|
1010
|
-
return this.request("
|
|
817
|
+
async CreateExtendedServiceAuthInfos(req, cb) {
|
|
818
|
+
return this.request("CreateExtendedServiceAuthInfos", req, cb);
|
|
1011
819
|
}
|
|
1012
820
|
/**
|
|
1013
821
|
* 此接口(CreateOrganizationInfoChangeUrl)用于创建企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。
|
|
@@ -1049,60 +857,73 @@ p.s.
|
|
|
1049
857
|
return this.request("CreateOrganizationInfoChangeUrl", req, cb);
|
|
1050
858
|
}
|
|
1051
859
|
/**
|
|
1052
|
-
*
|
|
1053
|
-
|
|
860
|
+
* 此接口(CreateConvertTaskApi)用来将word、excel、html、图片、txt类型文件转换为PDF文件。<br />
|
|
861
|
+
前提条件:源文件已经通过 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">文件上传接口</a>完成上传,并得到了源文件的资源Id。<br />
|
|
862
|
+
适用场景1:已经上传了一个word文件,希望将该word文件转换成pdf文件后发起合同
|
|
863
|
+
适用场景2:已经上传了一个jpg图片文件,希望将该图片文件转换成pdf文件后发起合同<br />
|
|
864
|
+
转换文件是一个耗时操作,若想查看转换任务是否完成,可以通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>接口获取任务状态。<br />
|
|
1054
865
|
注:
|
|
1055
|
-
|
|
1056
|
-
|
|
1057
|
-
*/
|
|
1058
|
-
async CancelUserAutoSignEnableUrl(req, cb) {
|
|
1059
|
-
return this.request("CancelUserAutoSignEnableUrl", req, cb);
|
|
1060
|
-
}
|
|
1061
|
-
/**
|
|
1062
|
-
* 通过此接口(DescribeBillUsageDetail)查询该企业的套餐消耗详情。
|
|
866
|
+
1. `支持的文件类型有doc、docx、xls、xlsx、html、jpg、jpeg、png、bmp、txt`
|
|
867
|
+
2. `可通过发起合同时设置预览来检查转换文件是否达到预期效果`
|
|
1063
868
|
*/
|
|
1064
|
-
async
|
|
1065
|
-
return this.request("
|
|
869
|
+
async CreateConvertTaskApi(req, cb) {
|
|
870
|
+
return this.request("CreateConvertTaskApi", req, cb);
|
|
1066
871
|
}
|
|
1067
872
|
/**
|
|
1068
|
-
*
|
|
873
|
+
* 本接口(CreateOrganizationAuthUrl)用于生成创建企业认证链接。
|
|
874
|
+
用于业务方系统自己生成认证链接进行跳转.而不用电子签自带的生成链接
|
|
875
|
+
|
|
876
|
+
注: **此接口需要购买单独的实名套餐包方可调用,如有需求请联系对接人员评估**
|
|
1069
877
|
*/
|
|
1070
|
-
async
|
|
1071
|
-
return this.request("
|
|
878
|
+
async CreateOrganizationAuthUrl(req, cb) {
|
|
879
|
+
return this.request("CreateOrganizationAuthUrl", req, cb);
|
|
1072
880
|
}
|
|
1073
881
|
/**
|
|
1074
|
-
* 此接口(
|
|
882
|
+
* 此接口(UploadFiles)文件上传。<br/>
|
|
1075
883
|
|
|
1076
|
-
|
|
884
|
+
适用场景:用于合同,印章的文件上传。文件上传以后,
|
|
885
|
+
如果是PDF格式文件可配合<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles" target="_blank">用PDF文件创建签署流程</a>接口进行合同流程的发起
|
|
886
|
+
如果是其他类型可以配合<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务</a>接口转换成PDF文件
|
|
1077
887
|
|
|
1078
|
-
|
|
888
|
+
注:
|
|
889
|
+
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
890
|
+
2. 调用此接口时需要设置单独的Domain请求域名,<font color="red">联调开发环境为: file.test.ess.tencent.cn,正式环境需要设置为:file.ess.tencent.cn</font>,代码示例
|
|
891
|
+
```
|
|
892
|
+
HttpProfile httpProfile = new HttpProfile();
|
|
893
|
+
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|
|
894
|
+
```
|
|
1079
895
|
|
|
1080
|
-
|
|
896
|
+
<font color="red">相关视频指引</font> <br>
|
|
897
|
+
1. <a href="https://dyn.ess.tencent.cn/guide/apivideo/ess_uploadfiles.mp4" target="_blank">上传用于合同发起的PDF文件代码编写示例</a><br>
|
|
1081
898
|
*/
|
|
1082
|
-
async
|
|
1083
|
-
return this.request("
|
|
899
|
+
async UploadFiles(req, cb) {
|
|
900
|
+
return this.request("UploadFiles", req, cb);
|
|
1084
901
|
}
|
|
1085
902
|
/**
|
|
1086
|
-
*
|
|
1087
|
-
|
|
903
|
+
* 通过此接口,创建子企业激活记录,集团企业管理员可针对未激活的成员企业进行激活。
|
|
904
|
+
激活子企业时请保证子企业 lisence 充足。
|
|
905
|
+
这个操作与页面端激活成员企业操作类似
|
|
906
|
+

|
|
907
|
+
|
|
908
|
+
p.s.
|
|
909
|
+
此接口只能用于激活,不能用于续期。
|
|
1088
910
|
*/
|
|
1089
|
-
async
|
|
1090
|
-
return this.request("
|
|
911
|
+
async CreateIntegrationSubOrganizationActiveRecord(req, cb) {
|
|
912
|
+
return this.request("CreateIntegrationSubOrganizationActiveRecord", req, cb);
|
|
1091
913
|
}
|
|
1092
914
|
/**
|
|
1093
|
-
*
|
|
915
|
+
* 查询流程填写控件内容,可以根据合同流程ID查询该合同流程相关联的填写控件信息和填写内容。
|
|
1094
916
|
*/
|
|
1095
|
-
async
|
|
1096
|
-
return this.request("
|
|
917
|
+
async DescribeFlowComponents(req, cb) {
|
|
918
|
+
return this.request("DescribeFlowComponents", req, cb);
|
|
1097
919
|
}
|
|
1098
920
|
/**
|
|
1099
|
-
*
|
|
1100
|
-
该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口取消企业员工授权。
|
|
921
|
+
* 用来设置本企业嵌入式页面个性化主题配置(例如是否展示电子签logo、定义主题色等),设置后获取的web签署界面都会使用此配置进行展示。
|
|
1101
922
|
|
|
1102
|
-
|
|
923
|
+
如果多次调用,会以最后一次的配置为准
|
|
1103
924
|
*/
|
|
1104
|
-
async
|
|
1105
|
-
return this.request("
|
|
925
|
+
async CreateWebThemeConfig(req, cb) {
|
|
926
|
+
return this.request("CreateWebThemeConfig", req, cb);
|
|
1106
927
|
}
|
|
1107
928
|
/**
|
|
1108
929
|
* 此接口(CreateIntegrationEmployees)用于创建企业员工。创建的员工初始化为未实名,如下图所示。
|
|
@@ -1149,6 +970,163 @@ p.s.
|
|
|
1149
970
|
async CreateIntegrationEmployees(req, cb) {
|
|
1150
971
|
return this.request("CreateIntegrationEmployees", req, cb);
|
|
1151
972
|
}
|
|
973
|
+
/**
|
|
974
|
+
* 该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
|
|
975
|
+
**注意:**
|
|
976
|
+
1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=1)。
|
|
977
|
+
2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名(控件类型为SIGN_SIGNATURE)和时间类型的签署控件**,**不支持填写控件** 。
|
|
978
|
+
3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
|
|
979
|
+
4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
|
|
980
|
+
5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
981
|
+
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>。
|
|
982
|
+
6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
983
|
+
*/
|
|
984
|
+
async CreateBatchQuickSignUrl(req, cb) {
|
|
985
|
+
return this.request("CreateBatchQuickSignUrl", req, cb);
|
|
986
|
+
}
|
|
987
|
+
/**
|
|
988
|
+
* 新增/删除企业应用集成中的回调配置。
|
|
989
|
+
新增回调配置只会增加不存在的CallbackUrl;删除操作将针对找到的相同CallbackUrl的配置进行删除。
|
|
990
|
+
请确保回调地址能够接收并处理 HTTP POST 请求,并返回状态码 200 以表示处理正常。
|
|
991
|
+
更多回调相关的说明参考文档[回调通知能力](https://qian.tencent.com/developers/company/callback_types_v2)
|
|
992
|
+
*/
|
|
993
|
+
async ModifyApplicationCallbackInfo(req, cb) {
|
|
994
|
+
return this.request("ModifyApplicationCallbackInfo", req, cb);
|
|
995
|
+
}
|
|
996
|
+
/**
|
|
997
|
+
* 用于撤销合同流程<br/>
|
|
998
|
+
适用场景:如果某个合同流程当前至少还有一方没有签署,则可通过该接口取消该合同流程。常用于合同发错、内容填错,需要及时撤销的场景。<br/>
|
|
999
|
+
- **可撤回合同状态**:未全部签署完成
|
|
1000
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
1001
|
+
|
|
1002
|
+
注:
|
|
1003
|
+
1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
|
|
1004
|
+
|
|
1005
|
+
2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
|
|
1006
|
+

|
|
1007
|
+
|
|
1008
|
+
3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
1009
|
+
|
|
1010
|
+
4. 撤销后可以看合同PDF内容的人员: 发起方的超管, 发起方自己,发起方撤销合同的操作人员,已经签署合同、已经填写合同、邀请填写已经补充信息的参与人员
|
|
1011
|
+
*/
|
|
1012
|
+
async CancelFlow(req, cb) {
|
|
1013
|
+
return this.request("CancelFlow", req, cb);
|
|
1014
|
+
}
|
|
1015
|
+
/**
|
|
1016
|
+
* 此接口(UnbindEmployeeUserIdWithClientOpenId)用于解除电子签系统员工UserId与客户系统员工OpenId之间的绑定关系。
|
|
1017
|
+
|
|
1018
|
+
注:`在调用此接口时,需确保OpenId已通过调用`<a href="https://qian.tencent.com/developers/companyApis/staffs/BindEmployeeUserIdWithClientOpenId" target="_blank">BindEmployeeUserIdWithClientOpenId</a>`接口与电子签系统的UserId绑定过。若OpenId未经过绑定,则无法使用此接口进行解绑操作。`
|
|
1019
|
+
*/
|
|
1020
|
+
async UnbindEmployeeUserIdWithClientOpenId(req, cb) {
|
|
1021
|
+
return this.request("UnbindEmployeeUserIdWithClientOpenId", req, cb);
|
|
1022
|
+
}
|
|
1023
|
+
/**
|
|
1024
|
+
* 指定需要批量撤回的签署流程Id,以获取批量撤销链接。
|
|
1025
|
+
客户需指定要撤回的签署流程Id,最多可指定100个,超过100则不处理。
|
|
1026
|
+
接口调用成功后,将返回批量撤回合同的链接。通过点击链接,可跳转至电子签小程序完成批量撤回操作。
|
|
1027
|
+
|
|
1028
|
+
- **可撤回合同状态**:未全部签署完成
|
|
1029
|
+
- **不撤回合同状态**:已全部签署完成、已拒签、已过期、已撤回、拒绝填写、已解除等合同状态。
|
|
1030
|
+
|
|
1031
|
+
批量撤销结果可以通过接口返回的TaskId关联[批量撤销任务结果回调](https://qian.tencent.com/developers/company/callback_types_contracts_sign#%E4%B9%9D-%E6%89%B9%E9%87%8F%E6%92%A4%E9%94%80%E7%BB%93%E6%9E%9C%E5%9B%9E%E8%B0%83)或通过接口[查询批量撤销签署流程任务结果](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)
|
|
1032
|
+
|
|
1033
|
+
|
|
1034
|
+
注:
|
|
1035
|
+
1. 如果合同流程中的参与方均已签署完毕,则无法通过该接口撤销合同,签署完毕的合同需要双方走解除流程将合同作废,可以参考<a href="https://qian.tencent.com/developers/companyApis/operateFlows/CreateReleaseFlow" target="_blank">发起解除合同流程</a>接口。
|
|
1036
|
+
|
|
1037
|
+
2. 有对应合同撤销权限的人: <font color='red'>合同的发起人(并已经授予撤销权限)或者发起人所在企业的超管、法人</font>
|
|
1038
|
+

|
|
1039
|
+
|
|
1040
|
+
3. <font color='red'>只有撤销没有参与方签署过或只有自动签署签署过的合同,才会返还合同额度。</font>
|
|
1041
|
+
*/
|
|
1042
|
+
async CreateBatchCancelFlowUrl(req, cb) {
|
|
1043
|
+
return this.request("CreateBatchCancelFlowUrl", req, cb);
|
|
1044
|
+
}
|
|
1045
|
+
/**
|
|
1046
|
+
* 此接口(DeleteIntegrationDepartment)用于删除企业的部门信息。
|
|
1047
|
+
*/
|
|
1048
|
+
async DeleteIntegrationDepartment(req, cb) {
|
|
1049
|
+
return this.request("DeleteIntegrationDepartment", req, cb);
|
|
1050
|
+
}
|
|
1051
|
+
/**
|
|
1052
|
+
* 适用场景: 当通过模板或文件发起合同时,若未指定企业签署人信息,则可调用此接口补充或添加签署人。同一签署人可补充多个员工作为或签署人,最终实际签署人取决于谁先领取合同完成签署。
|
|
1053
|
+
|
|
1054
|
+
限制条件:
|
|
1055
|
+
|
|
1056
|
+
1.本企业(发起方企业)企业微信签署人仅支持通过企业微信UserId或姓名+手机号进行补充。
|
|
1057
|
+
2.本企业(发起方企业)非企业微信签署人仅支持通过姓名+手机号进行补充。
|
|
1058
|
+
3.他方企业仅支持通过姓名+手机号进行补充。
|
|
1059
|
+
4.个人签署人支持通过姓名+手机号进行补充,补充动态签署人时:若个人用户已完成实名,则可通过姓名+证件号码进行补充。
|
|
1060
|
+
*/
|
|
1061
|
+
async CreateFlowApprovers(req, cb) {
|
|
1062
|
+
return this.request("CreateFlowApprovers", req, cb);
|
|
1063
|
+
}
|
|
1064
|
+
/**
|
|
1065
|
+
* 创建发起流程web页面
|
|
1066
|
+
<br/>适用场景:通过该接口(CreatePrepareFlow)传入合同文件/模板编号及签署人信息,可获得发起流程的可嵌入页面,在页面完成签署控件等信息的编辑与确认后,快速发起流程。
|
|
1067
|
+
<br/>注:该接口包含模板/文件发起流程的全部功能,调用接口后不会立即发起,需在可嵌入页面点击按钮进行发起流程。
|
|
1068
|
+
*/
|
|
1069
|
+
async CreatePrepareFlow(req, cb) {
|
|
1070
|
+
return this.request("CreatePrepareFlow", req, cb);
|
|
1071
|
+
}
|
|
1072
|
+
/**
|
|
1073
|
+
* 通过此接口(DescribeBillUsage)查询该企业的套餐套餐使用情况。
|
|
1074
|
+
*/
|
|
1075
|
+
async DescribeBillUsage(req, cb) {
|
|
1076
|
+
return this.request("DescribeBillUsage", req, cb);
|
|
1077
|
+
}
|
|
1078
|
+
/**
|
|
1079
|
+
* 此接口用于查询合同流程的详情信息,支持查询多个(数量不能超过100)。
|
|
1080
|
+
|
|
1081
|
+
适用场景:可用于主动查询某个合同详情信息。
|
|
1082
|
+
*/
|
|
1083
|
+
async DescribeFlowInfo(req, cb) {
|
|
1084
|
+
return this.request("DescribeFlowInfo", req, cb);
|
|
1085
|
+
}
|
|
1086
|
+
/**
|
|
1087
|
+
* 本接口(CreateSealPolicy)用于对企业员工进行印章授权
|
|
1088
|
+
*/
|
|
1089
|
+
async CreateSealPolicy(req, cb) {
|
|
1090
|
+
return this.request("CreateSealPolicy", req, cb);
|
|
1091
|
+
}
|
|
1092
|
+
/**
|
|
1093
|
+
* 通过[获取批量撤销签署流程腾讯电子签小程序链接](https://qian.tencent.com/developers/companyApis/operateFlows/CreateBatchCancelFlowUrl)发起批量撤销任务后,可通过此接口查询批量撤销任务的结果。
|
|
1094
|
+
*/
|
|
1095
|
+
async DescribeCancelFlowsTask(req, cb) {
|
|
1096
|
+
return this.request("DescribeCancelFlowsTask", req, cb);
|
|
1097
|
+
}
|
|
1098
|
+
/**
|
|
1099
|
+
* 生成集团加入链接,分享至子企业超管或者法人,子企业管理员可通过链接加入集团。
|
|
1100
|
+
注意:调用当前接口的企业 必须为集团企业。如何成为集团企业可以参考下面的文档[集团操作文档](https://qian.tencent.com/document/86707)
|
|
1101
|
+
*/
|
|
1102
|
+
async CreateOrganizationGroupInvitationLink(req, cb) {
|
|
1103
|
+
return this.request("CreateOrganizationGroupInvitationLink", req, cb);
|
|
1104
|
+
}
|
|
1105
|
+
/**
|
|
1106
|
+
* 获取出证报告任务执行结果,返回报告 URL。
|
|
1107
|
+
|
|
1108
|
+
|
|
1109
|
+
|
|
1110
|
+
注意:
|
|
1111
|
+
<ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
|
|
1112
|
+
<li>需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/companyApis/certificate/CreateFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。</li></ul>
|
|
1113
|
+
|
|
1114
|
+
<svg id="SvgjsSvg1006" width="262" height="229" xmlns="http://www.w3.org/2000/svg" version="1.1" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:svgjs="http://svgjs.com/svgjs"><defs id="SvgjsDefs1007"><pattern patternUnits="userSpaceOnUse" id="pattern_mark_0" width="300" height="300"><text x="150" y="100" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><pattern patternUnits="userSpaceOnUse" id="pattern_mark_1" width="300" height="300"><text x="150" y="200" fill="rgba(229,229,229,0.8)" font-size="18" transform="rotate(-45, 150, 150)" style="dominant-baseline: middle; text-anchor: middle;"></text></pattern><marker id="SvgjsMarker1021" markerWidth="12" markerHeight="8" refX="9" refY="4" viewBox="0 0 12 8" orient="auto" markerUnits="userSpaceOnUse" stroke-dasharray="0,0"><path id="SvgjsPath1022" d="M0,0 L12,4 L0,8 L0,0" fill="#323232" stroke="#323232" stroke-width="1"></path></marker></defs><rect id="svgbackgroundid" width="262" height="229" fill="transparent"></rect><rect id="SvgjsRect1009" width="262" height="229" fill="url(#pattern_mark_0)"></rect><rect id="SvgjsRect1010" width="262" height="229" fill="url(#pattern_mark_1)"></rect><g id="SvgjsG1011" transform="translate(31.75,25)"><path id="SvgjsPath1012" d="M 0 0L 198 0L 198 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1013"><text id="SvgjsText1014" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="178px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1015" dy="16" x="99"><tspan id="SvgjsTspan1016" style="text-decoration:;fill: rgb(28, 30, 33);">CreateFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1017" dy="16" x="99"><tspan id="SvgjsTspan1018" style="text-decoration:;fill: rgb(51, 51, 51);">提交申请出证报告任务</tspan></tspan></text></g></g><g id="SvgjsG1019"><path id="SvgjsPath1020" d="M130.75 84.5L130.75 114.5L130.75 114.5L130.75 143.2" stroke="#323232" stroke-width="1" fill="none" marker-end="url(#SvgjsMarker1021)"></path></g><g id="SvgjsG1023" transform="translate(25,145)"><path id="SvgjsPath1024" d="M 0 0L 211.5 0L 211.5 59L 0 59Z" stroke="rgba(86,146,48,1)" stroke-width="1" fill-opacity="1" fill="#e7ebed"></path><g id="SvgjsG1025"><text id="SvgjsText1026" font-family="微软雅黑" text-anchor="middle" font-size="13px" width="192px" fill="#323232" font-weight="400" align="middle" lineHeight="125%" anchor="middle" family="微软雅黑" size="13px" weight="400" font-style="" opacity="1" y="10.375" transform="rotate(0)"><tspan id="SvgjsTspan1027" dy="16" x="106"><tspan id="SvgjsTspan1028" style="text-decoration:;fill: rgb(28, 30, 33);">DescribeFlowEvidenceReport</tspan></tspan><tspan id="SvgjsTspan1029" dy="16" x="106"><tspan id="SvgjsTspan1030" style="text-decoration:;fill: rgb(51, 51, 51);">获取出证报告任务执行结果</tspan></tspan></text></g></g></svg>
|
|
1115
|
+
*/
|
|
1116
|
+
async DescribeFlowEvidenceReport(req, cb) {
|
|
1117
|
+
return this.request("DescribeFlowEvidenceReport", req, cb);
|
|
1118
|
+
}
|
|
1119
|
+
/**
|
|
1120
|
+
* 此接口(GetTaskResultApi)用来查询转换任务的状态。如需发起转换任务,请使用<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行资源文件的转换操作<br />
|
|
1121
|
+
前提条件:已调用 <a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/CreateConvertTaskApi" target="_blank">创建文件转换任务接口</a>进行文件转换,并得到了返回的转换任务Id。<br />
|
|
1122
|
+
|
|
1123
|
+
适用场景:已创建一个文件转换任务,想查询该文件转换任务的状态,或获取转换后的文件资源Id。<br />
|
|
1124
|
+
注:
|
|
1125
|
+
1. `大文件转换所需的时间可能会比较长`
|
|
1126
|
+
*/
|
|
1127
|
+
async GetTaskResultApi(req, cb) {
|
|
1128
|
+
return this.request("GetTaskResultApi", req, cb);
|
|
1129
|
+
}
|
|
1152
1130
|
/**
|
|
1153
1131
|
* 此接口(UpdateIntegrationEmployees)<font color="red"><b>用于修改未实名企业员工信息(姓名,手机号,邮件、部门)</b></font>。
|
|
1154
1132
|
如果企业员工已经实名, 姓名,手机号,邮件等需要企业员工到小程序或者控制台自己修改, 部门则需要超管到控制台分配
|
|
@@ -1187,20 +1165,67 @@ p.s.
|
|
|
1187
1165
|
return this.request("UpdateIntegrationEmployees", req, cb);
|
|
1188
1166
|
}
|
|
1189
1167
|
/**
|
|
1190
|
-
*
|
|
1191
|
-
|
|
1192
|
-
|
|
1168
|
+
* 使用此接口,您可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。<br/>
|
|
1169
|
+
附注:
|
|
1170
|
+
- 员工必须需作为批量签署合同的签署方,or或签合同的候选人之一。
|
|
1171
|
+
- 对于本方企业:如有UserId,应以UserId为主要标识;如果没有UserId,则必须填写Name和Mobile信息。
|
|
1172
|
+
- 若要生成他发企业签署链接:应传RecipientIds,且制定的合同必须是接口调用方发起的。
|
|
1173
|
+
- 支持待签署、待填写状态的合同生成签署链接。
|
|
1174
|
+
*/
|
|
1175
|
+
async CreateOrganizationBatchSignUrl(req, cb) {
|
|
1176
|
+
return this.request("CreateOrganizationBatchSignUrl", req, cb);
|
|
1177
|
+
}
|
|
1178
|
+
/**
|
|
1179
|
+
* 通过AuthCode查询个人用户是否实名
|
|
1193
1180
|
|
|
1194
|
-
|
|
1195
|
-
|
|
1196
|
-
|
|
1197
|
-
|
|
1198
|
-
|
|
1199
|
-
|
|
1200
|
-
6. 不支持操作合同组合同。
|
|
1181
|
+
|
|
1182
|
+
注意:
|
|
1183
|
+
<ul>
|
|
1184
|
+
<li>此接口为合作引流场景使用,使用`有白名单限制`,使用前请联系对接的客户经理沟通。</li>
|
|
1185
|
+
<li>`AuthCode 只能使用一次`,查询一次再次查询会返回错误</li>
|
|
1186
|
+
</ul>
|
|
1201
1187
|
*/
|
|
1202
|
-
async
|
|
1203
|
-
return this.request("
|
|
1188
|
+
async DescribeThirdPartyAuthCode(req, cb) {
|
|
1189
|
+
return this.request("DescribeThirdPartyAuthCode", req, cb);
|
|
1190
|
+
}
|
|
1191
|
+
/**
|
|
1192
|
+
* 查询企业印章的列表,需要操作者具有查询印章权限
|
|
1193
|
+
客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数。
|
|
1194
|
+
*/
|
|
1195
|
+
async DescribeOrganizationSeals(req, cb) {
|
|
1196
|
+
return this.request("DescribeOrganizationSeals", req, cb);
|
|
1197
|
+
}
|
|
1198
|
+
/**
|
|
1199
|
+
* 获取跳转至腾讯电子签小程序的签署链接
|
|
1200
|
+
|
|
1201
|
+
适用场景:如果需要签署人在自己的APP、小程序、H5应用中签署,可以通过此接口获取跳转腾讯电子签小程序的签署跳转链接。
|
|
1202
|
+
|
|
1203
|
+
跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
|
|
1204
|
+
|
|
1205
|
+
注:
|
|
1206
|
+
<ul><li>1. 如果签署人是在PC端扫码签署,可以通过生成跳转链接自主转换成二维码,让签署人在PC端扫码签署</li>
|
|
1207
|
+
<li>2. 签署链接的有效期为<font color="red">90天</font>,超过有效期链接不可用</li>
|
|
1208
|
+
<li>3. 如果需跳转详情页(即PathType值为1)进行填写或签署合同,需指定签署方信息:姓名、手机号码、企业名称等,才能生成正确的跳转链接</li>
|
|
1209
|
+
<li>4. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)</li></ul>
|
|
1210
|
+
|
|
1211
|
+
其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
|
1212
|
+
|
|
1213
|
+
| 小程序 | AppID | 原始ID |
|
|
1214
|
+
| ------------ | ------------ | ------------ |
|
|
1215
|
+
| 腾讯电子签(正式版) | wxa023b292fd19d41d | gh_da88f6188665 |
|
|
1216
|
+
| 腾讯电子签Demo | wx371151823f6f3edf | gh_39a5d3de69fa |
|
|
1217
|
+
*/
|
|
1218
|
+
async CreateSchemeUrl(req, cb) {
|
|
1219
|
+
return this.request("CreateSchemeUrl", req, cb);
|
|
1220
|
+
}
|
|
1221
|
+
/**
|
|
1222
|
+
* 删除企业扩展服务授权,当前仅支持 “企业自动签” 和“批量签署” 的取消授权。
|
|
1223
|
+
该接口作用和电子签控制台 企业设置-扩展服务-企业自动签署和批量签署授权 两个模块功能相同,可通过该接口取消企业员工授权。
|
|
1224
|
+
|
|
1225
|
+
注:支持集团代子企业操作,请联系运营开通此功能。
|
|
1226
|
+
*/
|
|
1227
|
+
async DeleteExtendedServiceAuthInfos(req, cb) {
|
|
1228
|
+
return this.request("DeleteExtendedServiceAuthInfos", req, cb);
|
|
1204
1229
|
}
|
|
1205
1230
|
}
|
|
1206
1231
|
exports.Client = Client;
|