tencentcloud-sdk-nodejs-essbasic 4.0.717 → 4.0.718

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "tencentcloud-sdk-nodejs-essbasic",
3
- "version": "4.0.717",
3
+ "version": "4.0.718",
4
4
  "description": "Tencent Cloud API NODEJS SDK",
5
5
  "main": "tencentcloud/index.js",
6
6
  "scripts": {
package/products.md CHANGED
@@ -39,7 +39,7 @@
39
39
  | car | [应用云渲染](https://cloud.tencent.com/document/product/1547) | 2023-10-17 01:08:50 |
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
- | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-10-19 15:57:59 |
42
+ | cbs | [云硬盘](https://cloud.tencent.com/document/product/362) | 2023-11-01 01:07:57 |
43
43
  | ccc | [云联络中心](https://cloud.tencent.com/document/product/679) | 2023-10-27 01:15:45 |
44
44
  | cdb | [云数据库 MySQL](https://cloud.tencent.com/document/product/236) | 2023-10-30 00:11:05 |
45
45
  | cdc | [本地专用集群](https://cloud.tencent.com/document/product/1346) | 2023-09-12 01:18:51 |
@@ -56,7 +56,7 @@
56
56
  | cim | [](https://cloud.tencent.com/document/product) | 2019-05-16 17:21:18 |
57
57
  | cis | [](https://cloud.tencent.com/document/product) | 2018-06-07 15:01:42 |
58
58
  | ckafka | [消息队列 CKafka 版](https://cloud.tencent.com/document/product/597) | 2023-10-27 01:21:10 |
59
- | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2023-10-31 01:23:38 |
59
+ | clb | [负载均衡](https://cloud.tencent.com/document/product/214) | 2023-11-01 01:09:28 |
60
60
  | cloudaudit | [云审计](https://cloud.tencent.com/document/product/629) | 2023-05-18 01:13:28 |
61
61
  | cloudhsm | [云加密机](https://cloud.tencent.com/document/product/639) | 2023-08-17 01:57:08 |
62
62
  | cloudstudio | [Cloud Studio(云端 IDE)](https://cloud.tencent.com/document/product/1039) | 2023-08-03 01:03:28 |
@@ -90,13 +90,13 @@
90
90
  | eb | [事件总线](https://cloud.tencent.com/document/product/1359) | 2023-10-31 01:45:32 |
91
91
  | ecc | [英文作文批改](https://cloud.tencent.com/document/product/1076) | 2023-09-13 01:42:58 |
92
92
  | ecdn | [全站加速网络](https://cloud.tencent.com/document/product/570) | 2023-08-17 03:03:04 |
93
- | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-10-31 01:46:23 |
93
+ | ecm | [边缘计算机器](https://cloud.tencent.com/document/product/1108) | 2023-11-01 01:13:22 |
94
94
  | eiam | [数字身份管控平台(员工版)](https://cloud.tencent.com/document/product/1442) | 2023-05-18 01:25:40 |
95
95
  | eis | [数据连接器](https://cloud.tencent.com/document/product/1270) | 2023-08-10 01:17:44 |
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-10-31 01:49:17 |
99
- | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-10-31 01:50:09 |
99
+ | essbasic | [腾讯电子签(基础版)](https://cloud.tencent.com/document/product/1420) | 2023-11-01 01:14:11 |
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 |
@@ -109,7 +109,7 @@
109
109
  | gse | [游戏服务器伸缩](https://cloud.tencent.com/document/product/1165) | 2022-07-11 06:12:44 |
110
110
  | habo | [](https://cloud.tencent.com/document/product) | 2019-05-09 19:37:22 |
111
111
  | hasim | [高可用物联网卡](https://cloud.tencent.com/document/product/1482) | 2023-05-18 01:29:47 |
112
- | hcm | [数学作业批改](https://cloud.tencent.com/document/product/1004) | 2023-09-25 01:15:46 |
112
+ | hcm | [数学作业批改](https://cloud.tencent.com/document/product/1004) | 2023-11-01 01:14:52 |
113
113
  | iai | [人脸识别](https://cloud.tencent.com/document/product/867) | 2023-10-24 01:16:21 |
114
114
  | ic | [图片瘦身](https://cloud.tencent.com/document/product/636) | 2023-03-02 01:23:21 |
115
115
  | icr | [对话机器人](https://cloud.tencent.com/document/product/1268) | 2023-05-18 01:30:40 |
@@ -129,7 +129,7 @@
129
129
  | keewidb | [云数据库 KeeWiDB](https://cloud.tencent.com/document/product/1520) | 2023-07-19 01:29:34 |
130
130
  | kms | [密钥管理系统](https://cloud.tencent.com/document/product/573) | 2023-08-17 03:51:31 |
131
131
  | lcic | [实时互动-教育版](https://cloud.tencent.com/document/product/1639) | 2023-10-23 00:14:04 |
132
- | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-10-24 01:18:10 |
132
+ | lighthouse | [轻量应用服务器](https://cloud.tencent.com/document/product/1207) | 2023-11-01 01:16:48 |
133
133
  | live | [云直播CSS](https://cloud.tencent.com/document/product/267) | 2023-10-26 01:18:09 |
134
134
  | lowcode | [云开发低码](https://cloud.tencent.com/document/product/1301) | 2022-04-04 06:56:51 |
135
135
  | lp | [登录保护](https://cloud.tencent.com/document/product/1190) | 2022-04-04 06:56:52 |
@@ -143,7 +143,7 @@
143
143
  | mongodb | [云数据库 MongoDB](https://cloud.tencent.com/document/product/240) | 2023-09-15 02:08:53 |
144
144
  | monitor | [腾讯云可观测平台](https://cloud.tencent.com/document/product/248) | 2023-10-30 01:00:00 |
145
145
  | mps | [媒体处理](https://cloud.tencent.com/document/product/862) | 2023-10-25 01:21:31 |
146
- | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-10-23 00:16:02 |
146
+ | mrs | [医疗报告结构化](https://cloud.tencent.com/document/product/1314) | 2023-11-01 01:18:18 |
147
147
  | ms | [移动应用安全](https://cloud.tencent.com/document/product/283) | 2023-10-17 01:22:38 |
148
148
  | msp | [迁移服务平台](https://cloud.tencent.com/document/product/659) | 2023-08-17 04:18:22 |
149
149
  | mvj | [营销价值判断](https://cloud.tencent.com/document/product) | 2020-03-19 08:11:44 |
@@ -194,10 +194,10 @@
194
194
  | tci | [腾讯智学课堂分析](https://cloud.tencent.com/document/product) | 2020-08-24 08:06:03 |
195
195
  | tcm | [服务网格](https://cloud.tencent.com/document/product/1261) | 2023-10-09 01:23:14 |
196
196
  | tcr | [容器镜像服务](https://cloud.tencent.com/document/product/1141) | 2023-09-11 02:43:38 |
197
- | tcss | [容器安全服务](https://cloud.tencent.com/document/product/1285) | 2023-10-31 02:25:36 |
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-10-31 02:29:08 |
200
+ | tdmq | [消息队列 TDMQ](https://cloud.tencent.com/document/product/1179) | 2023-11-01 01:22:25 |
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
203
  | teo | [边缘安全加速平台](https://cloud.tencent.com/document/product/1552) | 2023-10-31 02:31:17 |
@@ -208,8 +208,8 @@
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-10-20 01:25:11 |
212
- | tiw | [互动白板](https://cloud.tencent.com/document/product/1137) | 2023-10-31 02:34:57 |
211
+ | tione | [TI-ONE 训练平台](https://cloud.tencent.com/document/product/851) | 2023-11-01 01:23:17 |
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 |
215
215
  | tms | [文本内容安全](https://cloud.tencent.com/document/product/1124) | 2023-10-25 01:27:42 |
@@ -228,11 +228,11 @@
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-10-31 02:45:47 |
231
+ | vpc | [私有网络](https://cloud.tencent.com/document/product/215) | 2023-11-01 01:25:39 |
232
232
  | vrs | [声音复刻](https://cloud.tencent.com/document/product/1283) | 2023-07-18 01:58:58 |
233
- | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-10-27 02:33:14 |
233
+ | waf | [Web 应用防火墙](https://cloud.tencent.com/document/product/627) | 2023-11-01 01:26:18 |
234
234
  | wav | [企业微信汽车行业版](https://cloud.tencent.com/document/product/1318) | 2023-07-18 01:59:28 |
235
- | wedata | [数据开发治理平台 WeData](https://cloud.tencent.com/document/product/1267) | 2023-10-31 02:51:22 |
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 |
237
237
  | wss | [SSL证书管理服务](https://cloud.tencent.com/document/product) | 2020-04-01 08:53:44 |
238
238
  | yinsuda | [音速达直播音乐版权引擎](https://cloud.tencent.com/document/product/1592) | 2023-08-10 01:50:27 |
@@ -617,7 +617,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
617
617
  /**
618
618
  * 创建跳转小程序查看或签署的链接
619
619
 
620
- **腾讯电子签小程序的的AppID 和 原始Id如下:**
620
+ **腾讯电子签小程序的AppID 和 原始Id如下:**
621
621
 
622
622
  | 小程序 | AppID | 原始ID |
623
623
  | ------------ | ------------ | ------------ |
@@ -628,10 +628,10 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
628
628
 
629
629
  |EndPoint| 场景| 说明和示例|
630
630
  | ---- | ---- | --- |
631
- | WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
632
- | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
631
+ | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
632
+ | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
633
633
  | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
634
- |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
634
+ |APP| 贵方App跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
635
635
  |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
636
636
  */
637
637
  async CreateSignUrls(
@@ -879,7 +879,7 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
879
879
  }
880
880
 
881
881
  /**
882
- * 查询企业员工列表
882
+ * 用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
883
883
  */
884
884
  async ChannelDescribeEmployees(
885
885
  req: ChannelDescribeEmployeesRequest,
@@ -2007,19 +2007,25 @@ export interface DescribeTemplatesResponse {
2007
2007
  */
2008
2008
  export interface AutoSignConfig {
2009
2009
  /**
2010
- * 自动签开通个人用户的三要素
2010
+ * 自动签开通个人用户信息, 包括名字,身份证等
2011
2011
  */
2012
2012
  UserInfo: UserThreeFactor
2013
2013
  /**
2014
- * 是否回调证书信息
2014
+ * 是否回调证书信息:
2015
+ <ul><li>**false**: 不需要(默认)</li>
2016
+ <li>**true**:需要</li></ul>
2015
2017
  */
2016
2018
  CertInfoCallback?: boolean
2017
2019
  /**
2018
- * 是否支持用户自定义签名印章
2020
+ * 是否支持用户自定义签名印章:
2021
+ <ul><li>**false**: 不能自己定义(默认)</li>
2022
+ <li>**true**: 可以自己定义</li></ul>
2019
2023
  */
2020
2024
  UserDefineSeal?: boolean
2021
2025
  /**
2022
- * 是否需要回调的时候返回印章(签名) 图片的 base64
2026
+ * 回调中是否需要自动签将要使用的印章(签名)图片的 base64:
2027
+ <ul><li>**false**: 不需要(默认)</li>
2028
+ <li>**true**: 需要</li></ul>
2023
2029
  */
2024
2030
  SealImgCallback?: boolean
2025
2031
  /**
@@ -2027,11 +2033,20 @@ export interface AutoSignConfig {
2027
2033
  */
2028
2034
  CallbackUrl?: string
2029
2035
  /**
2030
- * 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
2036
+ * 开通时候的身份验证方式, 取值为:
2037
+ <ul><li>**WEIXINAPP** : 微信人脸识别</li>
2038
+ <li>**INSIGHT** : 慧眼人脸认别</li>
2039
+ <li>**TELECOM** : 运营商三要素验证</li></ul>
2040
+ 注:
2041
+ <ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
2042
+ <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
2031
2043
  */
2032
2044
  VerifyChannels?: Array<string>
2033
2045
  /**
2034
- * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
2046
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。
2047
+
2048
+ <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
2049
+ </ul>
2035
2050
  */
2036
2051
  LicenseType?: number
2037
2052
  }
@@ -2356,7 +2371,7 @@ export interface CreateConsoleLoginUrlRequest {
2356
2371
  * 该参数和Module参数配合使用,用于指定模块下的资源Id,指定后链接登录将展示该资源的详情。
2357
2372
 
2358
2373
  根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到)。当前支持:
2359
- <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模版的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
2374
+ <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模板的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
2360
2375
  注意:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
2361
2376
 
2362
2377
  */
@@ -3452,21 +3467,32 @@ export interface ChannelCreateBoundFlowsRequest {
3452
3467
  */
3453
3468
  export interface ChannelDescribeEmployeesRequest {
3454
3469
  /**
3455
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3470
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3471
+
3472
+ 此接口下面信息必填。
3473
+ <ul>
3474
+ <li>渠道应用标识: Agent.AppId</li>
3475
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3476
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3477
+ </ul>
3478
+ 第三方平台子客企业和员工必须已经经过实名认证
3456
3479
  */
3457
3480
  Agent: Agent
3458
3481
  /**
3459
- * 指定每页多少条数据,单页最大20
3482
+ * 指定分页每页返回的数据条数,单页最大支持 20
3460
3483
  */
3461
3484
  Limit: number
3462
3485
  /**
3463
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
3464
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
3465
- 查询离职员工时,KeyStatusValues为["QuiteJob"]
3486
+ * 查询的关键字段,支持Key-Values查询。可选键值如下:
3487
+ <ul>
3488
+ <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
3489
+ <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["QuiteJob"]**:查询离职员工</li></ul></li>
3490
+ <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
3491
+ </ul>
3466
3492
  */
3467
3493
  Filters?: Array<Filter>
3468
3494
  /**
3469
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大为20000
3495
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000
3470
3496
  */
3471
3497
  Offset?: number
3472
3498
  /**
@@ -3552,7 +3578,7 @@ export interface CreateSignUrlsRequest {
3552
3578
  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3553
3579
  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3554
3580
  </ul>
3555
- 第三方平台子客企业和员工必须已经经过实名认证
3581
+ 第三方平台子客企业和员工必须已经过实名认证
3556
3582
  */
3557
3583
  Agent: Agent
3558
3584
  /**
@@ -3569,7 +3595,7 @@ export interface CreateSignUrlsRequest {
3569
3595
  * 签署链接类型,可以设置的参数如下
3570
3596
  <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
3571
3597
  <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接</li>
3572
- <li> **APP** :第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>
3598
+ <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
3573
3599
  <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
3574
3600
 
3575
3601
  详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
@@ -3911,7 +3937,13 @@ export interface FlowApproverInfo {
3911
3937
  ApproverVerifyTypes?: Array<number | bigint>
3912
3938
  /**
3913
3939
  * 签署人签署合同时的认证方式
3914
- 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
3940
+ <ul><li> **1** :人脸认证</li>
3941
+ <li> **2** :签署密码</li>
3942
+ <li> **3** :运营商三要素</li></ul>
3943
+
3944
+ 默认为1(人脸认证 ),2(签署密码)
3945
+
3946
+ 注: `用模版创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在此创建合同指定无效`
3915
3947
  */
3916
3948
  ApproverSignTypes?: Array<number | bigint>
3917
3949
  /**
@@ -5750,21 +5782,21 @@ export interface SyncFailReason {
5750
5782
  */
5751
5783
  export interface ChannelDescribeEmployeesResponse {
5752
5784
  /**
5753
- * 员工数据列表
5785
+ * 员工信息列表。
5754
5786
  注意:此字段可能返回 null,表示取不到有效值。
5755
5787
  */
5756
5788
  Employees?: Array<Staff>
5757
5789
  /**
5758
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
5790
+ * 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000
5759
5791
  注意:此字段可能返回 null,表示取不到有效值。
5760
5792
  */
5761
5793
  Offset?: number
5762
5794
  /**
5763
- * 指定每页多少条数据,单页最大20
5795
+ * 指定分页每页返回的数据条数,单页最大支持 20
5764
5796
  */
5765
5797
  Limit?: number
5766
5798
  /**
5767
- * 符合条件的员工数量
5799
+ * 符合条件的员工数量。
5768
5800
  */
5769
5801
  TotalCount?: number
5770
5802
  /**
@@ -296,7 +296,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
296
296
  /**
297
297
  * 创建跳转小程序查看或签署的链接
298
298
 
299
- **腾讯电子签小程序的的AppID 和 原始Id如下:**
299
+ **腾讯电子签小程序的AppID 和 原始Id如下:**
300
300
 
301
301
  | 小程序 | AppID | 原始ID |
302
302
  | ------------ | ------------ | ------------ |
@@ -307,10 +307,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
307
307
 
308
308
  |EndPoint| 场景| 说明和示例|
309
309
  | ---- | ---- | --- |
310
- | WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
311
- | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
310
+ | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
311
+ | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
312
312
  | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
313
- |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
313
+ |APP| 贵方App跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
314
314
  |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
315
315
  */
316
316
  CreateSignUrls(req: CreateSignUrlsRequest, cb?: (error: string, rep: CreateSignUrlsResponse) => void): Promise<CreateSignUrlsResponse>;
@@ -456,7 +456,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
456
456
  */
457
457
  ChannelCreateReleaseFlow(req: ChannelCreateReleaseFlowRequest, cb?: (error: string, rep: ChannelCreateReleaseFlowResponse) => void): Promise<ChannelCreateReleaseFlowResponse>;
458
458
  /**
459
- * 查询企业员工列表
459
+ * 用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
460
460
  */
461
461
  ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
462
462
  /**
@@ -357,7 +357,7 @@ class Client extends TencentCloudCommon.AbstractClient {
357
357
  /**
358
358
  * 创建跳转小程序查看或签署的链接
359
359
 
360
- **腾讯电子签小程序的的AppID 和 原始Id如下:**
360
+ **腾讯电子签小程序的AppID 和 原始Id如下:**
361
361
 
362
362
  | 小程序 | AppID | 原始ID |
363
363
  | ------------ | ------------ | ------------ |
@@ -368,10 +368,10 @@ class Client extends TencentCloudCommon.AbstractClient {
368
368
 
369
369
  |EndPoint| 场景| 说明和示例|
370
370
  | ---- | ---- | --- |
371
- | WEIXINAPP | 短链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
372
- | LONGURL2WEIXINAPP | 长链跳转腾讯电子签签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
371
+ | WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
372
+ | LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
373
373
  | CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
374
- |APP| 贵方APP跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
374
+ |APP| 贵方App跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
375
375
  |APP| 贵方小程序跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
376
376
  */
377
377
  async CreateSignUrls(req, cb) {
@@ -551,7 +551,7 @@ class Client extends TencentCloudCommon.AbstractClient {
551
551
  return this.request("ChannelCreateReleaseFlow", req, cb);
552
552
  }
553
553
  /**
554
- * 查询企业员工列表
554
+ * 用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
555
555
  */
556
556
  async ChannelDescribeEmployees(req, cb) {
557
557
  return this.request("ChannelDescribeEmployees", req, cb);
@@ -1932,19 +1932,25 @@ export interface DescribeTemplatesResponse {
1932
1932
  */
1933
1933
  export interface AutoSignConfig {
1934
1934
  /**
1935
- * 自动签开通个人用户的三要素
1935
+ * 自动签开通个人用户信息, 包括名字,身份证等
1936
1936
  */
1937
1937
  UserInfo: UserThreeFactor;
1938
1938
  /**
1939
- * 是否回调证书信息
1939
+ * 是否回调证书信息:
1940
+ <ul><li>**false**: 不需要(默认)</li>
1941
+ <li>**true**:需要</li></ul>
1940
1942
  */
1941
1943
  CertInfoCallback?: boolean;
1942
1944
  /**
1943
- * 是否支持用户自定义签名印章
1945
+ * 是否支持用户自定义签名印章:
1946
+ <ul><li>**false**: 不能自己定义(默认)</li>
1947
+ <li>**true**: 可以自己定义</li></ul>
1944
1948
  */
1945
1949
  UserDefineSeal?: boolean;
1946
1950
  /**
1947
- * 是否需要回调的时候返回印章(签名) 图片的 base64
1951
+ * 回调中是否需要自动签将要使用的印章(签名)图片的 base64:
1952
+ <ul><li>**false**: 不需要(默认)</li>
1953
+ <li>**true**: 需要</li></ul>
1948
1954
  */
1949
1955
  SealImgCallback?: boolean;
1950
1956
  /**
@@ -1952,11 +1958,20 @@ export interface AutoSignConfig {
1952
1958
  */
1953
1959
  CallbackUrl?: string;
1954
1960
  /**
1955
- * 开通时候的验证方式,取值:WEIXINAPP(微信人脸识别),INSIGHT(慧眼人脸认别),TELECOM(运营商三要素验证)。如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
1961
+ * 开通时候的身份验证方式, 取值为:
1962
+ <ul><li>**WEIXINAPP** : 微信人脸识别</li>
1963
+ <li>**INSIGHT** : 慧眼人脸认别</li>
1964
+ <li>**TELECOM** : 运营商三要素验证</li></ul>
1965
+ 注:
1966
+ <ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
1967
+ <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
1956
1968
  */
1957
1969
  VerifyChannels?: Array<string>;
1958
1970
  /**
1959
- * 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
1971
+ * 设置用户开通自动签时是否绑定个人自动签账号许可。
1972
+
1973
+ <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
1974
+ </ul>
1960
1975
  */
1961
1976
  LicenseType?: number;
1962
1977
  }
@@ -2272,7 +2287,7 @@ export interface CreateConsoleLoginUrlRequest {
2272
2287
  * 该参数和Module参数配合使用,用于指定模块下的资源Id,指定后链接登录将展示该资源的详情。
2273
2288
 
2274
2289
  根据Module参数的不同所代表的含义不同(ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到)。当前支持:
2275
- <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模版的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
2290
+ <table> <thead> <tr> <th>Module传值</th> <th>ModuleId传值</th> <th>进入的目标页面</th> </tr> </thead> <tbody> <tr> <td>SEAL</td> <td>印章ID</td> <td>查看指定印章的详情页面</td> </tr> <tr> <td>TEMPLATE</td> <td>合同模板ID</td> <td>指定模板的详情页面</td> </tr> <tr> <td>DOCUMENT</td> <td>合同ID</td> <td>指定合同的详情页面</td> </tr> </tbody> </table>
2276
2291
  注意:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
2277
2292
 
2278
2293
  */
@@ -3345,21 +3360,32 @@ export interface ChannelCreateBoundFlowsRequest {
3345
3360
  */
3346
3361
  export interface ChannelDescribeEmployeesRequest {
3347
3362
  /**
3348
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3363
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3364
+
3365
+ 此接口下面信息必填。
3366
+ <ul>
3367
+ <li>渠道应用标识: Agent.AppId</li>
3368
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3369
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3370
+ </ul>
3371
+ 第三方平台子客企业和员工必须已经经过实名认证
3349
3372
  */
3350
3373
  Agent: Agent;
3351
3374
  /**
3352
- * 指定每页多少条数据,单页最大20
3375
+ * 指定分页每页返回的数据条数,单页最大支持 20
3353
3376
  */
3354
3377
  Limit: number;
3355
3378
  /**
3356
- * 查询过滤实名用户,Key为Status,Values为["IsVerified"]
3357
- 根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
3358
- 查询离职员工时,KeyStatusValues为["QuiteJob"]
3379
+ * 查询的关键字段,支持Key-Values查询。可选键值如下:
3380
+ <ul>
3381
+ <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
3382
+ <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["QuiteJob"]**:查询离职员工</li></ul></li>
3383
+ <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
3384
+ </ul>
3359
3385
  */
3360
3386
  Filters?: Array<Filter>;
3361
3387
  /**
3362
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大为20000
3388
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000
3363
3389
  */
3364
3390
  Offset?: number;
3365
3391
  /**
@@ -3440,7 +3466,7 @@ export interface CreateSignUrlsRequest {
3440
3466
  <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3441
3467
  <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3442
3468
  </ul>
3443
- 第三方平台子客企业和员工必须已经经过实名认证
3469
+ 第三方平台子客企业和员工必须已经过实名认证
3444
3470
  */
3445
3471
  Agent: Agent;
3446
3472
  /**
@@ -3457,7 +3483,7 @@ export interface CreateSignUrlsRequest {
3457
3483
  * 签署链接类型,可以设置的参数如下
3458
3484
  <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
3459
3485
  <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接</li>
3460
- <li> **APP** :第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>
3486
+ <li> **APP** :第三方App或小程序跳转电子签小程序的path, App或者小程序跳转适合此类型</li>
3461
3487
  <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
3462
3488
 
3463
3489
  详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
@@ -3796,7 +3822,13 @@ export interface FlowApproverInfo {
3796
3822
  ApproverVerifyTypes?: Array<number | bigint>;
3797
3823
  /**
3798
3824
  * 签署人签署合同时的认证方式
3799
- 1-人脸认证 2-签署密码 3-运营商三要素(默认为1,2)
3825
+ <ul><li> **1** :人脸认证</li>
3826
+ <li> **2** :签署密码</li>
3827
+ <li> **3** :运营商三要素</li></ul>
3828
+
3829
+ 默认为1(人脸认证 ),2(签署密码)
3830
+
3831
+ 注: `用模版创建合同场景, 签署人的认证方式需要在配置模板的时候指定, 在此创建合同指定无效`
3800
3832
  */
3801
3833
  ApproverSignTypes?: Array<number | bigint>;
3802
3834
  /**
@@ -5567,21 +5599,21 @@ export interface SyncFailReason {
5567
5599
  */
5568
5600
  export interface ChannelDescribeEmployeesResponse {
5569
5601
  /**
5570
- * 员工数据列表
5602
+ * 员工信息列表。
5571
5603
  注意:此字段可能返回 null,表示取不到有效值。
5572
5604
  */
5573
5605
  Employees?: Array<Staff>;
5574
5606
  /**
5575
- * 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
5607
+ * 指定分页返回第几页的数据。页码从 0 开始,即首页为 0,最大20000
5576
5608
  注意:此字段可能返回 null,表示取不到有效值。
5577
5609
  */
5578
5610
  Offset?: number;
5579
5611
  /**
5580
- * 指定每页多少条数据,单页最大20
5612
+ * 指定分页每页返回的数据条数,单页最大支持 20
5581
5613
  */
5582
5614
  Limit?: number;
5583
5615
  /**
5584
- * 符合条件的员工数量
5616
+ * 符合条件的员工数量。
5585
5617
  */
5586
5618
  TotalCount?: number;
5587
5619
  /**