tencentcloud-sdk-nodejs-essbasic 4.0.714 → 4.0.716

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.
@@ -550,12 +550,19 @@ export interface ModifyExtendedServiceRequest {
550
550
  */
551
551
  export interface DescribeResourceUrlsByFlowsRequest {
552
552
  /**
553
- * 应用相关信息。
554
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
553
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
554
+
555
+ 此接口下面信息必填。
556
+ <ul>
557
+ <li>渠道应用标识: Agent.AppId</li>
558
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
559
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
560
+ </ul>
561
+ 第三方平台子客企业和员工必须已经经过实名认证
555
562
  */
556
563
  Agent: Agent;
557
564
  /**
558
- * 查询资源所对应的签署流程Id,最多支持50个
565
+ * 需要下载的合同流程的ID, 至少需要1个, 做多50个
559
566
  */
560
567
  FlowIds?: Array<string>;
561
568
  /**
@@ -955,24 +962,27 @@ export interface ReleasedApprover {
955
962
  */
956
963
  export interface CreateConsoleLoginUrlResponse {
957
964
  /**
958
- * 子客企业Web控制台url注意事项:
959
- 1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
960
- 2. 若企业认证完成且员工认证完成后,重新获取pc端的链接在5分钟之内有效,且只能访问一次
961
- 3. 若企业认证完成且员工认证完成后,重新获取CHANNEL/APP的链接只要在有效期内(一年)都可以访问
962
- 4. 此链接仅单次有效,每次登录需要需要重新创建新的链接,尽量不要做链接存储,多次使用。
963
- 5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
965
+ * 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
966
+ <table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table>
967
+ 注:
968
+ `1.链接仅单次有效,每次登录需要需要重新创建新的链接`
969
+ `2.创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`
970
+
964
971
  */
965
972
  ConsoleUrl?: string;
966
973
  /**
967
- * 子客企业是否已开通腾讯电子签,true-是,false-否
968
- 注意:
969
- 1、企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码
974
+ * 子客企业是否已开通腾讯电子签,
975
+ <ul><li> **true** :已经开通腾讯电子签</li>
976
+ <li> **false** :还未开通腾讯电子签</li></ul>
977
+
978
+ 注:`企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码`
970
979
  */
971
980
  IsActivated?: boolean;
972
981
  /**
973
- * 当前经办人是否已认证,true-是,false-否
974
- 注意:
975
- 1、经办人是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名
982
+ * 当前经办人是否已认证并加入功能
983
+ <ul><li> **true** : 已经认证加入公司</li>
984
+ <li> **false** : 还未认证加入公司</li></ul>
985
+ 注意:**员工是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名**
976
986
  */
977
987
  ProxyOperatorIsVerified?: boolean;
978
988
  /**
@@ -1495,12 +1505,12 @@ export interface FlowApproverDetail {
1495
1505
  */
1496
1506
  export interface DescribeResourceUrlsByFlowsResponse {
1497
1507
  /**
1498
- * 签署流程资源对应链接信息
1508
+ * 合同流程PDF下载链接
1499
1509
  */
1500
1510
  FlowResourceUrlInfos?: Array<FlowResourceUrlInfo>;
1501
1511
  /**
1502
- * 创建消息,对应多个合同ID,
1503
- 成功为“”,创建失败则对应失败消息
1512
+ * 如果某个序号的合同流程生成PDF下载链接成功, 对应序号的值为空
1513
+ 如果某个序号的合同流程生成PDF下载链接失败, 对应序号的值为错误的原因
1504
1514
  */
1505
1515
  ErrorMessages?: Array<string>;
1506
1516
  /**
@@ -1525,11 +1535,11 @@ export interface ChannelCreateFlowGroupByFilesRequest {
1525
1535
 
1526
1536
  此接口下面信息必填。
1527
1537
  <ul>
1528
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1529
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1530
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1538
+ <li>渠道应用标识: Agent.AppId</li>
1539
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1540
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
1531
1541
  </ul>
1532
- 子客企业和子客企业中的员工比较走完创建和实名过程
1542
+ 第三方平台子客企业和员工必须已经经过实名认证
1533
1543
  */
1534
1544
  Agent?: Agent;
1535
1545
  /**
@@ -1808,7 +1818,8 @@ export interface ChannelCreateOrganizationBatchSignUrlRequest {
1808
1818
  */
1809
1819
  export interface GetDownloadFlowUrlResponse {
1810
1820
  /**
1811
- * 合同(流程)下载地址
1821
+ * 跳转控制台合同下载页面链接 , 5分钟之内有效,且只能访问一次
1822
+
1812
1823
  */
1813
1824
  DownLoadUrl?: string;
1814
1825
  /**
@@ -2213,82 +2224,89 @@ export interface ChannelVerifyPdfResponse {
2213
2224
  */
2214
2225
  export interface CreateConsoleLoginUrlRequest {
2215
2226
  /**
2216
- * 应用信息
2217
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
2227
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
2228
+ 此接口下面信息必填。
2229
+ <ul>
2230
+ <li>渠道应用标识: Agent.AppId</li>
2231
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2232
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
2233
+ </ul>注:
2234
+ `1. 企业激活时, 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识, 建议开发者保存企业ProxyOrganizationOpenId,后续各项接口调用皆需要此参数。 `
2235
+ `2. 员工认证时, 此时的Agent.ProxyOrganizationOpenId将会是员工认证加入企业后的唯一标识, 建议开发者保存此员工的penId, 后续各项接口调用皆需要此参数。 `
2236
+ `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一, 员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)`
2218
2237
  */
2219
2238
  Agent: Agent;
2220
2239
  /**
2221
- * 子客企业名称,最大长度64个字符
2222
- 注意:
2223
- 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
2224
- 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
2240
+ * 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
2241
+
2242
+ 注:
2243
+ `1. 如果名称中包含英文括号(),请使用中文括号()代替。`
2244
+ `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。 `
2225
2245
  */
2226
2246
  ProxyOrganizationName: string;
2227
2247
  /**
2228
2248
  * 子客企业统一社会信用代码,最大长度200个字符
2229
- 注意:
2230
- 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
2249
+ 注意:`如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效`。
2231
2250
  */
2232
2251
  UniformSocialCreditCode?: string;
2233
2252
  /**
2234
- * 子客企业经办人的姓名,最大长度50个字符
2235
- 注意:
2236
- 1、若经办人已经实名,这里修改经办人名字传入将不会生效。
2237
- 2、该名称需要和Agent. ProxyOperator.OpenId相匹配
2253
+ * 子客企业员工的姓名,最大长度50个字符, 员工的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2254
+
2255
+ 注:`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业,这里修改经办人名字传入将不会生效`
2238
2256
  */
2239
2257
  ProxyOperatorName?: string;
2240
2258
  /**
2241
- * PC控制台登录后进入该参数指定的模块,如果不传递,将默认进入控制台首页。支持的模块包括:
2242
- 1、DOCUMENT:合同管理模块,
2243
- 2、TEMPLATE:企业模板管理模块,
2244
- 3、SEAL:印章管理模块,
2245
- 4、OPERATOR:组织管理模块,
2246
- 默认将进入企业中心模块
2259
+ * Web控制台登录后进入的功能模块, 支持的模块包括:
2260
+ <ul>
2261
+ <li> **空值** :(默认)企业中心模块</li>
2262
+ <li> **DOCUMENT** :合同管理模块</li>
2263
+ <li> **TEMPLATE** :企业模板管理模块</li>
2264
+ <li> **SEAL** :印章管理模块</li>
2265
+ <li> **OPERATOR** :组织管理模块</li></ul>
2247
2266
  注意:
2248
2267
  1、如果EndPoint选择"CHANNEL"或"APP",该参数仅支持传递"SEAL",进入印章管理模块
2249
- 2、该参数仅在企业和员工激活完成,登录控制台场景才生效。
2268
+ 2、该参数**仅在企业和员工激活已经完成,登录控制台场景才生效**。
2250
2269
  */
2251
2270
  Module?: string;
2252
2271
  /**
2253
2272
  * 该参数和Module参数配合使用,用于指定模块下的资源Id,指定后链接登录将展示该资源的详情。
2254
- 根据Module参数的不同所代表的含义不同。当前支持:
2255
- 1、如果Module="SEAL",ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。
2256
- 2、如果Module="TEMPLATE",ModuleId代表模版Id,登录链接将直接查看指定模版的详情。
2257
- 3、如果Module="1、DOCUMENT",ModuleId代表合同Id,登录链接将直接查看指定合同的详情。
2258
- 注意:
2259
- 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
2260
- 2、ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到。
2273
+
2274
+ 根据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>
2276
+ 注意:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
2277
+
2261
2278
  */
2262
2279
  ModuleId?: string;
2263
2280
  /**
2264
2281
  * 是否展示左侧菜单栏
2265
- "ENABLE": 是,展示
2266
- DISABLE”: 否,不展示
2267
- 默认值为ENABLE
2268
- 注意:
2269
- 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
2282
+ <ul><li> **ENABLE** : (默认)进入web控制台展示左侧菜单栏</li>
2283
+ <li> **DISABLE** : 进入web控制台不展示左侧菜单栏</li></ul>
2284
+ 注:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
2270
2285
  */
2271
2286
  MenuStatus?: string;
2272
2287
  /**
2273
2288
  * 生成链接的类型:
2274
- "PC":PC控制台链接
2275
- "CHANNEL":H5跳转到电子签小程序链接
2276
- "APP":第三方APP或小程序跳转电子签小程序链接
2277
- 默认将生成PC控制台链接
2289
+ 生成链接的类型
2290
+ <ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>
2291
+ <li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
2292
+ <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
2278
2293
  */
2279
2294
  Endpoint?: string;
2280
2295
  /**
2281
2296
  * 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
2282
- "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
2297
+ <ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
2283
2298
  */
2284
2299
  AutoJumpBackEvent?: string;
2285
2300
  /**
2286
- * 可选的企业授权方式:
2287
- 1:上传授权书
2288
- 2:转法定代表人授权
2289
- 4:企业实名认证(信任第三方认证源)(此项仅支持单选)
2290
- 未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不生效;选择信任第三方认证源时,请先通过“同步企业信息”接口同步信息。
2291
- 该参数仅在企业激活场景生效
2301
+ * 可选的此企业允许的授权方式, 可以设置的方式有:
2302
+ <ul><li>1:上传授权书</li>
2303
+ <li>2:转法定代表人授权</li>
2304
+ <li>4:企业实名认证(信任第三方认证源)(此项有排他性, 选择后不能增添其他的方式)</li></ul>
2305
+ 注:<ul>
2306
+ <li>未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不对此法人生效`</li>
2307
+ <li>选择信任第三方认证源时,请先通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganization" target="_blank">同步企业信息</a>接口同步信息。</li>
2308
+ <li>该参数仅在企业未激活时生效</li>
2309
+ </ul>
2292
2310
  */
2293
2311
  AuthorizationTypes?: Array<number | bigint>;
2294
2312
  /**
@@ -2370,9 +2388,9 @@ export interface SignUrlInfo {
2370
2388
  */
2371
2389
  OrganizationName?: string;
2372
2390
  /**
2373
- * 参与者类型:
2374
- ORGANIZATION 企业经办人
2375
- PERSON 自然人
2391
+ * 参与者类型, 类型如下:
2392
+ **ORGANIZATION**:企业经办人
2393
+ **PERSON**: 自然人
2376
2394
  注意:此字段可能返回 null,表示取不到有效值。
2377
2395
  */
2378
2396
  ApproverType?: string;
@@ -3287,17 +3305,17 @@ export interface ResourceUrlInfo {
3287
3305
  * 资源链接地址,过期时间5分钟
3288
3306
  注意:此字段可能返回 null,表示取不到有效值。
3289
3307
  */
3290
- Url: string;
3308
+ Url?: string;
3291
3309
  /**
3292
3310
  * 资源名称
3293
3311
  注意:此字段可能返回 null,表示取不到有效值。
3294
3312
  */
3295
- Name: string;
3313
+ Name?: string;
3296
3314
  /**
3297
3315
  * 资源类型
3298
3316
  注意:此字段可能返回 null,表示取不到有效值。
3299
3317
  */
3300
- Type: string;
3318
+ Type?: string;
3301
3319
  }
3302
3320
  /**
3303
3321
  * ChannelCreateBoundFlows请求参数结构体
@@ -3410,57 +3428,72 @@ export interface ChannelCreateFlowApproversResponse {
3410
3428
  */
3411
3429
  export interface CreateSignUrlsRequest {
3412
3430
  /**
3413
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3431
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3432
+
3433
+ 此接口下面信息必填。
3434
+ <ul>
3435
+ <li>渠道应用标识: Agent.AppId</li>
3436
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3437
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3438
+ </ul>
3439
+ 第三方平台子客企业和员工必须已经经过实名认证
3414
3440
  */
3415
3441
  Agent: Agent;
3416
3442
  /**
3417
- * 流程(合同)的编号列表,最多支持100个。(备注:该参数和合同组编号必须二选一)
3443
+ * 合同流程ID数组,最多支持100个。
3444
+ 注: `该参数和合同组编号必须二选一`
3418
3445
  */
3419
3446
  FlowIds?: Array<string>;
3420
3447
  /**
3421
- * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
3448
+ * 合同组编号
3449
+ 注:`该参数和合同流程ID数组必须二选一`
3422
3450
  */
3423
3451
  FlowGroupId?: string;
3424
3452
  /**
3425
3453
  * 签署链接类型,可以设置的参数如下
3454
+ <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
3455
+ <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接</li>
3456
+ <li> **APP** :第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>
3457
+ <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
3426
3458
 
3427
- - WEIXINAPP:短链直接跳小程序 (默认类型)
3428
- - CHANNEL:跳转H5页面
3429
- - APP:第三方APP或小程序跳转电子签小程序
3430
- - LONGURL2WEIXINAPP:长链接跳转小程序
3459
+ 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
3431
3460
  */
3432
3461
  Endpoint?: string;
3433
3462
  /**
3434
3463
  * 签署链接生成类型,可以选择的类型如下
3435
3464
 
3436
- - ALL:全部签署方签署链接,此时不会给自动签署的签署方创建签署链接(默认类型)
3437
- - CHANNEL:第三方平台子客企业企业
3438
- - NOT_CHANNEL:非第三方平台子客企业企业
3439
- - PERSON:个人
3440
- - FOLLOWER:关注方,目前是合同抄送方
3441
- - RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
3465
+ <ul><li>**ALL**:(默认)全部签署方签署链接,此时不会给自动签署(静默签署)的签署方创建签署链接</li>
3466
+ <li>**CHANNEL**:第三方子企业员工签署方</li>
3467
+ <li>**NOT_CHANNEL**:SaaS平台企业员工签署方</li>
3468
+ <li>**PERSON**:个人/自然人签署方</li>
3469
+ <li>**FOLLOWER**:关注方,目前是合同抄送方</li>
3470
+ <li>**RECIPIENT**:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接</li></ul>
3442
3471
  */
3443
3472
  GenerateType?: string;
3444
3473
  /**
3445
- * 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
3474
+ * SaaS平台企业员工签署方的企业名称
3475
+ 如果名称中包含英文括号(),请使用中文括号()代替。
3476
+
3477
+ 注: `GenerateType为"NOT_CHANNEL"时必填`
3446
3478
  */
3447
3479
  OrganizationName?: string;
3448
3480
  /**
3449
- * 参与人姓名
3450
- GenerateType为"PERSON"(即个人签署方)时必填
3481
+ * 合同流程里边参与方的姓名。
3482
+ 注: `GenerateType为"PERSON"(即个人签署方)时必填`
3451
3483
  */
3452
3484
  Name?: string;
3453
3485
  /**
3454
- * 参与人手机号
3455
- GenerateType为"PERSON"或"FOLLOWER"时必填
3486
+ * 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
3487
+ 注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
3456
3488
  */
3457
3489
  Mobile?: string;
3458
3490
  /**
3459
- * 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
3491
+ * 第三方平台子客企业的企业的标识, 即OrganizationOpenId
3492
+ 注: `GenerateType为"CHANNEL"时必填`
3460
3493
  */
3461
3494
  OrganizationOpenId?: string;
3462
3495
  /**
3463
- * 第三方平台子客企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
3496
+ * 第三方平台子客企业员工的标识OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
3464
3497
  */
3465
3498
  OpenId?: string;
3466
3499
  /**
@@ -3477,16 +3510,20 @@ export interface CreateSignUrlsRequest {
3477
3510
  */
3478
3511
  Operator?: UserInfo;
3479
3512
  /**
3480
- * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
3513
+ * 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
3514
+
3515
+ <ul><li> **0** :合同签署页面更多操作按钮</li>
3516
+ <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
3517
+ <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
3518
+ <li> **3** :签署成功页的查看详情按钮</li></ul>
3481
3519
 
3482
- - 0:合同签署页面更多操作按钮
3483
- - 1:合同签署页面更多操作的拒绝签署按钮
3484
- - 2:合同签署页面更多操作的转他人处理按钮
3485
- - 3:签署成功页的查看详情按钮
3520
+ 注: `字段为数组, 可以传值隐藏多个按钮`
3486
3521
  */
3487
3522
  Hides?: Array<number | bigint>;
3488
3523
  /**
3489
- * 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
3524
+ * 参与方角色ID,用于生成动态签署人链接完成领取。
3525
+
3526
+ 注:`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`,
3490
3527
  */
3491
3528
  RecipientIds?: Array<string>;
3492
3529
  }
@@ -4093,15 +4130,15 @@ export interface ChannelDescribeUserAutoSignStatusRequest {
4093
4130
  */
4094
4131
  export interface FlowResourceUrlInfo {
4095
4132
  /**
4096
- * 流程对应Id
4133
+ * 合同流程的ID
4097
4134
  注意:此字段可能返回 null,表示取不到有效值。
4098
4135
  */
4099
- FlowId: string;
4136
+ FlowId?: string;
4100
4137
  /**
4101
- * 流程对应资源链接信息数组
4138
+ * 对应的合同流程的PDF下载链接
4102
4139
  注意:此字段可能返回 null,表示取不到有效值。
4103
4140
  */
4104
- ResourceUrlInfos: Array<ResourceUrlInfo>;
4141
+ ResourceUrlInfos?: Array<ResourceUrlInfo>;
4105
4142
  }
4106
4143
  /**
4107
4144
  * 此结构体 (UploadFile) 用于描述多文件上传的文件信息。
@@ -4258,14 +4295,17 @@ export interface ChannelDeleteRoleRequest {
4258
4295
  export interface UploadFilesResponse {
4259
4296
  /**
4260
4297
  * 上传成功文件数量
4298
+ 注: `如果一个文件上传失败, 则全部文件皆上传失败`
4261
4299
  */
4262
4300
  TotalCount?: number;
4263
4301
  /**
4264
- * 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
4302
+ * 文件资源ID数组,每个文件资源ID为32位字符串。
4303
+ 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
4304
+ 注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用`
4265
4305
  */
4266
4306
  FileIds?: Array<string>;
4267
4307
  /**
4268
- * 文件Url
4308
+ * 对应上传文件的下载链接,过期时间5分钟
4269
4309
  */
4270
4310
  FileUrls?: Array<string>;
4271
4311
  /**
@@ -4848,11 +4888,26 @@ export interface ChannelCreateWebThemeConfigResponse {
4848
4888
  */
4849
4889
  export interface GetDownloadFlowUrlRequest {
4850
4890
  /**
4851
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
4891
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4892
+
4893
+ 此接口下面信息必填。
4894
+ <ul>
4895
+ <li>渠道应用标识: Agent.AppId</li>
4896
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4897
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
4898
+ </ul>
4899
+ 第三方平台子客企业和员工必须已经经过实名认证
4852
4900
  */
4853
4901
  Agent: Agent;
4854
4902
  /**
4855
- * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
4903
+ * 流程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹对多20个合同, 所有文件夹最多50个合同
4904
+
4905
+ 如下列组织形式, 控制台下载页面点击下载按钮后, 会生成**2023采购合同.zip**和**2023入职合同.zip** 两个下载任务(注:`部分浏览器需要授权或不支持创建多下载任务`)
4906
+
4907
+ **2023采购合同.zip**压缩包会有`yDwivUUckpor6wtoUuogwQHCAB0ES0pQ`和`yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh`两个合同的文件
4908
+ **2023入职合同.zip** 压缩包会有`yDwivUUckpor6wobUuogwQHvdGfvDi5K`的文件
4909
+
4910
+ ![image]( https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl_DownLoadFlows.png)
4856
4911
  */
4857
4912
  DownLoadFlows?: Array<DownloadFlowInfo>;
4858
4913
  /**
@@ -4987,11 +5042,11 @@ export interface ChannelCreateFlowGroupByTemplatesRequest {
4987
5042
 
4988
5043
  此接口下面信息必填。
4989
5044
  <ul>
4990
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4991
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4992
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
5045
+ <li>渠道应用标识: Agent.AppId</li>
5046
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5047
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
4993
5048
  </ul>
4994
- 子客企业和子客企业中的员工比较走完创建和实名过程
5049
+ 第三方平台子客企业和员工必须已经经过实名认证
4995
5050
  */
4996
5051
  Agent: Agent;
4997
5052
  /**
@@ -5025,23 +5080,36 @@ export interface SignUrl {
5025
5080
  */
5026
5081
  export interface ChannelCancelFlowRequest {
5027
5082
  /**
5028
- * 签署流程编号
5083
+ * 要撤销的合同流程ID
5029
5084
  */
5030
5085
  FlowId: string;
5031
5086
  /**
5032
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
5087
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5088
+
5089
+ 此接口下面信息必填。
5090
+ <ul>
5091
+ <li>渠道应用标识: Agent.AppId</li>
5092
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5093
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5094
+ </ul>
5095
+ 第三方平台子客企业和员工必须已经经过实名认证
5033
5096
  */
5034
5097
  Agent?: Agent;
5035
5098
  /**
5036
- * 撤回原因,最大不超过200字符
5099
+ * 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
5037
5100
  */
5038
5101
  CancelMessage?: string;
5039
5102
  /**
5040
- * 撤销理由自定义格式;选项:
5041
- 0 默认格式
5042
- 1 只保留身份信息:展示为【发起方】
5043
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
5044
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
5103
+ * 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
5104
+
5105
+ **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
5106
+ **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
5107
+ **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
5108
+ **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
5109
+
5110
+ 注: `CancelMessage为撤销当前合同的理由`
5111
+
5112
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
5045
5113
  */
5046
5114
  CancelMessageFormat?: number;
5047
5115
  /**
@@ -5262,17 +5330,26 @@ export interface CreateFlowsByTemplatesRequest {
5262
5330
  */
5263
5331
  export interface UploadFilesRequest {
5264
5332
  /**
5265
- * 应用相关信息,若是第三方应用集成调用 若是第三方应用集成调用,Agent.AppId 和 Agent.ProxyOrganizationOpenId 必填
5333
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5334
+
5335
+ 此接口下面信息必填。
5336
+ <ul>
5337
+ <li>渠道应用标识: Agent.AppId</li>
5338
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5339
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5340
+ </ul>
5341
+ 第三方平台子客企业和员工必须已经经过实名认证
5266
5342
  */
5267
5343
  Agent: Agent;
5268
5344
  /**
5269
- * 文件对应业务类型
5270
- 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
5271
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
5345
+ *
5346
+ 文件对应业务类型,可以选择的类型如下
5347
+ <ul><li> **TEMPLATE** : 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
5348
+ <li> **DOCUMENT** : 此文件用来发起合同流程,文件类型支持.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li></ul>
5272
5349
  */
5273
5350
  BusinessType: string;
5274
5351
  /**
5275
- * 上传文件内容数组,最多支持20个文件
5352
+ * 上传文件内容数组,最多支持上传20个文件。
5276
5353
  */
5277
5354
  FileInfos?: Array<UploadFile>;
5278
5355
  /**
@@ -5581,9 +5658,9 @@ export interface CreateSealByImageRequest {
5581
5658
 
5582
5659
  此接口下面信息必填。
5583
5660
  <ul>
5584
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
5585
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
5586
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
5661
+ <li>渠道应用标识: Agent.AppId</li>
5662
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5663
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
5587
5664
  </ul>
5588
5665
  第三方平台子客企业和员工必须已经经过实名认证
5589
5666
  */
@@ -5618,7 +5695,7 @@ export interface CreateSealByImageRequest {
5618
5695
  * 电子印章类型 , 可选类型如下:
5619
5696
  <ul><li>**OFFICIAL**: (默认)公章</li>
5620
5697
  <li>**CONTRACT**: 合同专用章;</li>
5621
- <li>**FINANCE**: 合财务专用章;</li>
5698
+ <li>**FINANCE**: 财务专用章;</li>
5622
5699
  <li>**PERSONNEL**: 人事专用章</li>
5623
5700
  </ul>
5624
5701
  注: `同企业下只能有一个公章, 重复创建会报错`
@@ -5634,8 +5711,8 @@ export interface CreateSealByImageRequest {
5634
5711
  SealHorizontalText?: string;
5635
5712
  /**
5636
5713
  * 印章样式, 可以选择的样式如下:
5637
- <ul><li>**cycle**:(默认)圆形印章</li>
5638
- <li>**ellipse**:椭圆印章</li>
5714
+ <ul><li>**circle**:(默认)圆形印章</li>
5715
+ <li>**ellipse**:椭圆印章</li></ul>
5639
5716
  */
5640
5717
  SealStyle?: string;
5641
5718
  /**