tencentcloud-sdk-nodejs-essbasic 4.0.715 → 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.
@@ -582,12 +582,19 @@ CLOSE:关闭
582
582
  */
583
583
  export interface DescribeResourceUrlsByFlowsRequest {
584
584
  /**
585
- * 应用相关信息。
586
- 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
585
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
586
+
587
+ 此接口下面信息必填。
588
+ <ul>
589
+ <li>渠道应用标识: Agent.AppId</li>
590
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
591
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
592
+ </ul>
593
+ 第三方平台子客企业和员工必须已经经过实名认证
587
594
  */
588
595
  Agent: Agent
589
596
  /**
590
- * 查询资源所对应的签署流程Id,最多支持50个
597
+ * 需要下载的合同流程的ID, 至少需要1个, 做多50个
591
598
  */
592
599
  FlowIds?: Array<string>
593
600
  /**
@@ -1000,24 +1007,27 @@ ENTERPRISESERVER-企业静默签
1000
1007
  */
1001
1008
  export interface CreateConsoleLoginUrlResponse {
1002
1009
  /**
1003
- * 子客企业Web控制台url注意事项:
1004
- 1. 所有类型的链接在企业未认证/员工未认证完成时,只要在有效期内(一年)都可以访问
1005
- 2. 若企业认证完成且员工认证完成后,重新获取pc端的链接在5分钟之内有效,且只能访问一次
1006
- 3. 若企业认证完成且员工认证完成后,重新获取CHANNEL/APP的链接只要在有效期内(一年)都可以访问
1007
- 4. 此链接仅单次有效,每次登录需要需要重新创建新的链接,尽量不要做链接存储,多次使用。
1008
- 5. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
1010
+ * 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
1011
+ <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>
1012
+ 注:
1013
+ `1.链接仅单次有效,每次登录需要需要重新创建新的链接`
1014
+ `2.创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义`
1015
+
1009
1016
  */
1010
1017
  ConsoleUrl?: string
1011
1018
  /**
1012
- * 子客企业是否已开通腾讯电子签,true-是,false-否
1013
- 注意:
1014
- 1、企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码
1019
+ * 子客企业是否已开通腾讯电子签,
1020
+ <ul><li> **true** :已经开通腾讯电子签</li>
1021
+ <li> **false** :还未开通腾讯电子签</li></ul>
1022
+
1023
+ 注:`企业是否实名根据传参Agent.ProxyOrganizationOpenId进行判断,非企业名称或者社会信用代码`
1015
1024
  */
1016
1025
  IsActivated?: boolean
1017
1026
  /**
1018
- * 当前经办人是否已认证,true-是,false-否
1019
- 注意:
1020
- 1、经办人是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名
1027
+ * 当前经办人是否已认证并加入功能
1028
+ <ul><li> **true** : 已经认证加入公司</li>
1029
+ <li> **false** : 还未认证加入公司</li></ul>
1030
+ 注意:**员工是否实名是根据Agent.ProxyOperator.OpenId判断,非经办人姓名**
1021
1031
  */
1022
1032
  ProxyOperatorIsVerified?: boolean
1023
1033
  /**
@@ -1556,12 +1566,12 @@ export interface FlowApproverDetail {
1556
1566
  */
1557
1567
  export interface DescribeResourceUrlsByFlowsResponse {
1558
1568
  /**
1559
- * 签署流程资源对应链接信息
1569
+ * 合同流程PDF下载链接
1560
1570
  */
1561
1571
  FlowResourceUrlInfos?: Array<FlowResourceUrlInfo>
1562
1572
  /**
1563
- * 创建消息,对应多个合同ID,
1564
- 成功为“”,创建失败则对应失败消息
1573
+ * 如果某个序号的合同流程生成PDF下载链接成功, 对应序号的值为空
1574
+ 如果某个序号的合同流程生成PDF下载链接失败, 对应序号的值为错误的原因
1565
1575
  */
1566
1576
  ErrorMessages?: Array<string>
1567
1577
  /**
@@ -1587,11 +1597,11 @@ export interface ChannelCreateFlowGroupByFilesRequest {
1587
1597
 
1588
1598
  此接口下面信息必填。
1589
1599
  <ul>
1590
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1591
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1592
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1600
+ <li>渠道应用标识: Agent.AppId</li>
1601
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1602
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
1593
1603
  </ul>
1594
- 子客企业和子客企业中的员工比较走完创建和实名过程
1604
+ 第三方平台子客企业和员工必须已经经过实名认证
1595
1605
  */
1596
1606
  Agent?: Agent
1597
1607
  /**
@@ -1879,7 +1889,8 @@ export interface ChannelCreateOrganizationBatchSignUrlRequest {
1879
1889
  */
1880
1890
  export interface GetDownloadFlowUrlResponse {
1881
1891
  /**
1882
- * 合同(流程)下载地址
1892
+ * 跳转控制台合同下载页面链接 , 5分钟之内有效,且只能访问一次
1893
+
1883
1894
  */
1884
1895
  DownLoadUrl?: string
1885
1896
  /**
@@ -2297,82 +2308,89 @@ export interface ChannelVerifyPdfResponse {
2297
2308
  */
2298
2309
  export interface CreateConsoleLoginUrlRequest {
2299
2310
  /**
2300
- * 应用信息
2301
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId 和 Agent. ProxyOperator.OpenId 必填
2311
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容
2312
+ 此接口下面信息必填。
2313
+ <ul>
2314
+ <li>渠道应用标识: Agent.AppId</li>
2315
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2316
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
2317
+ </ul>注:
2318
+ `1. 企业激活时, 此时的Agent.ProxyOrganizationOpenId将会是企业激活后企业的唯一标识, 建议开发者保存企业ProxyOrganizationOpenId,后续各项接口调用皆需要此参数。 `
2319
+ `2. 员工认证时, 此时的Agent.ProxyOrganizationOpenId将会是员工认证加入企业后的唯一标识, 建议开发者保存此员工的penId, 后续各项接口调用皆需要此参数。 `
2320
+ `3. 同渠道应用(Agent.AppId)下,企业唯一标识ProxyOrganizationOpenId需要保持唯一, 员工唯一标识OpenId也要保持唯一 (而不是企业下唯一)`
2302
2321
  */
2303
2322
  Agent: Agent
2304
2323
  /**
2305
- * 子客企业名称,最大长度64个字符
2306
- 注意:
2307
- 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
2308
- 2、该名称需要与Agent.ProxyOrganizationOpenId相匹配。
2324
+ * 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
2325
+
2326
+ 注:
2327
+ `1. 如果名称中包含英文括号(),请使用中文括号()代替。`
2328
+ `2、该名称需要与Agent.ProxyOrganizationOpenId相匹配, 企业激活后Agent.ProxyOrganizationOpenId会跟此企业名称一一绑定; 如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。 `
2309
2329
  */
2310
2330
  ProxyOrganizationName: string
2311
2331
  /**
2312
2332
  * 子客企业统一社会信用代码,最大长度200个字符
2313
- 注意:
2314
- 1、如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效。
2333
+ 注意:`如果您的企业已经在认证授权中或者激活完成,这里修改子客企业名字将不会生效`。
2315
2334
  */
2316
2335
  UniformSocialCreditCode?: string
2317
2336
  /**
2318
- * 子客企业经办人的姓名,最大长度50个字符
2319
- 注意:
2320
- 1、若经办人已经实名,这里修改经办人名字传入将不会生效。
2321
- 2、该名称需要和Agent. ProxyOperator.OpenId相匹配
2337
+ * 子客企业员工的姓名,最大长度50个字符, 员工的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
2338
+
2339
+ 注:`该姓名需要和Agent.ProxyOperator.OpenId相匹配, 当员工完成认证后该姓名会和Agent.ProxyOperator.OpenId一一绑定, 若员工已认证加入企业,这里修改经办人名字传入将不会生效`
2322
2340
  */
2323
2341
  ProxyOperatorName?: string
2324
2342
  /**
2325
- * PC控制台登录后进入该参数指定的模块,如果不传递,将默认进入控制台首页。支持的模块包括:
2326
- 1、DOCUMENT:合同管理模块,
2327
- 2、TEMPLATE:企业模板管理模块,
2328
- 3、SEAL:印章管理模块,
2329
- 4、OPERATOR:组织管理模块,
2330
- 默认将进入企业中心模块
2343
+ * Web控制台登录后进入的功能模块, 支持的模块包括:
2344
+ <ul>
2345
+ <li> **空值** :(默认)企业中心模块</li>
2346
+ <li> **DOCUMENT** :合同管理模块</li>
2347
+ <li> **TEMPLATE** :企业模板管理模块</li>
2348
+ <li> **SEAL** :印章管理模块</li>
2349
+ <li> **OPERATOR** :组织管理模块</li></ul>
2331
2350
  注意:
2332
2351
  1、如果EndPoint选择"CHANNEL"或"APP",该参数仅支持传递"SEAL",进入印章管理模块
2333
- 2、该参数仅在企业和员工激活完成,登录控制台场景才生效。
2352
+ 2、该参数**仅在企业和员工激活已经完成,登录控制台场景才生效**。
2334
2353
  */
2335
2354
  Module?: string
2336
2355
  /**
2337
2356
  * 该参数和Module参数配合使用,用于指定模块下的资源Id,指定后链接登录将展示该资源的详情。
2338
- 根据Module参数的不同所代表的含义不同。当前支持:
2339
- 1、如果Module="SEAL",ModuleId代表印章Id, 登录链接将直接查看指定印章的详情。
2340
- 2、如果Module="TEMPLATE",ModuleId代表模版Id,登录链接将直接查看指定模版的详情。
2341
- 3、如果Module="1、DOCUMENT",ModuleId代表合同Id,登录链接将直接查看指定合同的详情。
2342
- 注意:
2343
- 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
2344
- 2、ModuleId需要和Module对应,ModuleId可以通过API或者控制台获取到。
2357
+
2358
+ 根据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>
2360
+ 注意:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
2361
+
2345
2362
  */
2346
2363
  ModuleId?: string
2347
2364
  /**
2348
2365
  * 是否展示左侧菜单栏
2349
- "ENABLE": 是,展示
2350
- DISABLE”: 否,不展示
2351
- 默认值为ENABLE
2352
- 注意:
2353
- 1、该参数仅在企业和员工激活完成,登录控制台场景才生效。
2366
+ <ul><li> **ENABLE** : (默认)进入web控制台展示左侧菜单栏</li>
2367
+ <li> **DISABLE** : 进入web控制台不展示左侧菜单栏</li></ul>
2368
+ 注:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
2354
2369
  */
2355
2370
  MenuStatus?: string
2356
2371
  /**
2357
2372
  * 生成链接的类型:
2358
- "PC":PC控制台链接
2359
- "CHANNEL":H5跳转到电子签小程序链接
2360
- "APP":第三方APP或小程序跳转电子签小程序链接
2361
- 默认将生成PC控制台链接
2373
+ 生成链接的类型
2374
+ <ul><li>**PC**:(默认)web控制台链接, 需要在PC浏览器中打开</li>
2375
+ <li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
2376
+ <li>**APP**:第三方APP或小程序跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
2362
2377
  */
2363
2378
  Endpoint?: string
2364
2379
  /**
2365
2380
  * 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
2366
- "VERIFIED":企业认证完成/员工认证完成后跳回原App/小程序
2381
+ <ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
2367
2382
  */
2368
2383
  AutoJumpBackEvent?: string
2369
2384
  /**
2370
- * 可选的企业授权方式:
2371
- 1:上传授权书
2372
- 2:转法定代表人授权
2373
- 4:企业实名认证(信任第三方认证源)(此项仅支持单选)
2374
- 未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不生效;选择信任第三方认证源时,请先通过“同步企业信息”接口同步信息。
2375
- 该参数仅在企业激活场景生效
2385
+ * 可选的此企业允许的授权方式, 可以设置的方式有:
2386
+ <ul><li>1:上传授权书</li>
2387
+ <li>2:转法定代表人授权</li>
2388
+ <li>4:企业实名认证(信任第三方认证源)(此项有排他性, 选择后不能增添其他的方式)</li></ul>
2389
+ 注:<ul>
2390
+ <li>未选择信任第三方认证源时,如果是法人进行企业激活,仅支持法人扫脸直接授权,该配置不对此法人生效`</li>
2391
+ <li>选择信任第三方认证源时,请先通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganization" target="_blank">同步企业信息</a>接口同步信息。</li>
2392
+ <li>该参数仅在企业未激活时生效</li>
2393
+ </ul>
2376
2394
  */
2377
2395
  AuthorizationTypes?: Array<number | bigint>
2378
2396
  /**
@@ -2456,9 +2474,9 @@ export interface SignUrlInfo {
2456
2474
  */
2457
2475
  OrganizationName?: string
2458
2476
  /**
2459
- * 参与者类型:
2460
- ORGANIZATION 企业经办人
2461
- PERSON 自然人
2477
+ * 参与者类型, 类型如下:
2478
+ **ORGANIZATION**:企业经办人
2479
+ **PERSON**: 自然人
2462
2480
  注意:此字段可能返回 null,表示取不到有效值。
2463
2481
  */
2464
2482
  ApproverType?: string
@@ -3392,17 +3410,17 @@ export interface ResourceUrlInfo {
3392
3410
  * 资源链接地址,过期时间5分钟
3393
3411
  注意:此字段可能返回 null,表示取不到有效值。
3394
3412
  */
3395
- Url: string
3413
+ Url?: string
3396
3414
  /**
3397
3415
  * 资源名称
3398
3416
  注意:此字段可能返回 null,表示取不到有效值。
3399
3417
  */
3400
- Name: string
3418
+ Name?: string
3401
3419
  /**
3402
3420
  * 资源类型
3403
3421
  注意:此字段可能返回 null,表示取不到有效值。
3404
3422
  */
3405
- Type: string
3423
+ Type?: string
3406
3424
  }
3407
3425
 
3408
3426
  /**
@@ -3522,57 +3540,72 @@ export interface ChannelCreateFlowApproversResponse {
3522
3540
  */
3523
3541
  export interface CreateSignUrlsRequest {
3524
3542
  /**
3525
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
3543
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3544
+
3545
+ 此接口下面信息必填。
3546
+ <ul>
3547
+ <li>渠道应用标识: Agent.AppId</li>
3548
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3549
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3550
+ </ul>
3551
+ 第三方平台子客企业和员工必须已经经过实名认证
3526
3552
  */
3527
3553
  Agent: Agent
3528
3554
  /**
3529
- * 流程(合同)的编号列表,最多支持100个。(备注:该参数和合同组编号必须二选一)
3555
+ * 合同流程ID数组,最多支持100个。
3556
+ 注: `该参数和合同组编号必须二选一`
3530
3557
  */
3531
3558
  FlowIds?: Array<string>
3532
3559
  /**
3533
- * 合同组编号(备注:该参数和合同(流程)编号数组必须二选一)
3560
+ * 合同组编号
3561
+ 注:`该参数和合同流程ID数组必须二选一`
3534
3562
  */
3535
3563
  FlowGroupId?: string
3536
3564
  /**
3537
3565
  * 签署链接类型,可以设置的参数如下
3566
+ <ul><li> **WEIXINAPP** :(默认)跳转电子签小程序的http_url, 短信通知或者H5跳转适合此类型 ,此时返回短链</li>
3567
+ <li> **CHANNEL** :带有H5引导页的跳转电子签小程序的链接</li>
3568
+ <li> **APP** :第三方APP或小程序跳转电子签小程序的path, APP或者小程序跳转适合此类型</li>
3569
+ <li> **LONGURL2WEIXINAPP** :跳转电子签小程序的链接, H5跳转适合此类型,此时返回长链</li></ul>
3538
3570
 
3539
- - WEIXINAPP:短链直接跳小程序 (默认类型)
3540
- - CHANNEL:跳转H5页面
3541
- - APP:第三方APP或小程序跳转电子签小程序
3542
- - LONGURL2WEIXINAPP:长链接跳转小程序
3571
+ 详细使用场景可以参数接口说明中的 **主要使用场景可以更加EndPoint分类如下**
3543
3572
  */
3544
3573
  Endpoint?: string
3545
3574
  /**
3546
3575
  * 签署链接生成类型,可以选择的类型如下
3547
3576
 
3548
- - ALL:全部签署方签署链接,此时不会给自动签署的签署方创建签署链接(默认类型)
3549
- - CHANNEL:第三方平台子客企业企业
3550
- - NOT_CHANNEL:非第三方平台子客企业企业
3551
- - PERSON:个人
3552
- - FOLLOWER:关注方,目前是合同抄送方
3553
- - RECIPIENT:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接
3577
+ <ul><li>**ALL**:(默认)全部签署方签署链接,此时不会给自动签署(静默签署)的签署方创建签署链接</li>
3578
+ <li>**CHANNEL**:第三方子企业员工签署方</li>
3579
+ <li>**NOT_CHANNEL**:SaaS平台企业员工签署方</li>
3580
+ <li>**PERSON**:个人/自然人签署方</li>
3581
+ <li>**FOLLOWER**:关注方,目前是合同抄送方</li>
3582
+ <li>**RECIPIENT**:获取RecipientId对应的签署链接,可用于生成动态签署人补充链接</li></ul>
3554
3583
  */
3555
3584
  GenerateType?: string
3556
3585
  /**
3557
- * 非第三方平台子客企业参与方的企业名称,GenerateType为"NOT_CHANNEL"时必填
3586
+ * SaaS平台企业员工签署方的企业名称
3587
+ 如果名称中包含英文括号(),请使用中文括号()代替。
3588
+
3589
+ 注: `GenerateType为"NOT_CHANNEL"时必填`
3558
3590
  */
3559
3591
  OrganizationName?: string
3560
3592
  /**
3561
- * 参与人姓名
3562
- GenerateType为"PERSON"(即个人签署方)时必填
3593
+ * 合同流程里边参与方的姓名。
3594
+ 注: `GenerateType为"PERSON"(即个人签署方)时必填`
3563
3595
  */
3564
3596
  Name?: string
3565
3597
  /**
3566
- * 参与人手机号
3567
- GenerateType为"PERSON"或"FOLLOWER"时必填
3598
+ * 合同流程里边签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
3599
+ 注: `GenerateType为"PERSON"或"FOLLOWER"时必填`
3568
3600
  */
3569
3601
  Mobile?: string
3570
3602
  /**
3571
- * 第三方平台子客企业的企业OpenId,GenerateType为"CHANNEL"时必填
3603
+ * 第三方平台子客企业的企业的标识, 即OrganizationOpenId
3604
+ 注: `GenerateType为"CHANNEL"时必填`
3572
3605
  */
3573
3606
  OrganizationOpenId?: string
3574
3607
  /**
3575
- * 第三方平台子客企业参与人OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
3608
+ * 第三方平台子客企业员工的标识OpenId,GenerateType为"CHANNEL"时可用,指定到具体参与人, 仅展示已经实名的经办人信息
3576
3609
  */
3577
3610
  OpenId?: string
3578
3611
  /**
@@ -3589,16 +3622,20 @@ GenerateType为"PERSON"或"FOLLOWER"时必填
3589
3622
  */
3590
3623
  Operator?: UserInfo
3591
3624
  /**
3592
- * 生成的签署链接在签署过程隐藏的按钮列表, 可以设置隐藏的按钮列表如下
3625
+ * 生成的签署链接在签署页面隐藏的按钮列表,可设置如下:
3626
+
3627
+ <ul><li> **0** :合同签署页面更多操作按钮</li>
3628
+ <li> **1** :合同签署页面更多操作的拒绝签署按钮</li>
3629
+ <li> **2** :合同签署页面更多操作的转他人处理按钮</li>
3630
+ <li> **3** :签署成功页的查看详情按钮</li></ul>
3593
3631
 
3594
- - 0:合同签署页面更多操作按钮
3595
- - 1:合同签署页面更多操作的拒绝签署按钮
3596
- - 2:合同签署页面更多操作的转他人处理按钮
3597
- - 3:签署成功页的查看详情按钮
3632
+ 注: `字段为数组, 可以传值隐藏多个按钮`
3598
3633
  */
3599
3634
  Hides?: Array<number | bigint>
3600
3635
  /**
3601
- * 签署节点ID,用于补充动态签署人,使用此参数需要与flow_ids数量一致并且一一对应
3636
+ * 参与方角色ID,用于生成动态签署人链接完成领取。
3637
+
3638
+ 注:`使用此参数需要与flow_ids数量一致并且一一对应, 表示在对应同序号的流程中的参与角色ID`,
3602
3639
  */
3603
3640
  RecipientIds?: Array<string>
3604
3641
  }
@@ -4220,15 +4257,15 @@ E_PRESCRIPTION_AUTO_SIGN 电子处方
4220
4257
  */
4221
4258
  export interface FlowResourceUrlInfo {
4222
4259
  /**
4223
- * 流程对应Id
4260
+ * 合同流程的ID
4224
4261
  注意:此字段可能返回 null,表示取不到有效值。
4225
4262
  */
4226
- FlowId: string
4263
+ FlowId?: string
4227
4264
  /**
4228
- * 流程对应资源链接信息数组
4265
+ * 对应的合同流程的PDF下载链接
4229
4266
  注意:此字段可能返回 null,表示取不到有效值。
4230
4267
  */
4231
- ResourceUrlInfos: Array<ResourceUrlInfo>
4268
+ ResourceUrlInfos?: Array<ResourceUrlInfo>
4232
4269
  }
4233
4270
 
4234
4271
  /**
@@ -4394,14 +4431,17 @@ export interface ChannelDeleteRoleRequest {
4394
4431
  export interface UploadFilesResponse {
4395
4432
  /**
4396
4433
  * 上传成功文件数量
4434
+ 注: `如果一个文件上传失败, 则全部文件皆上传失败`
4397
4435
  */
4398
4436
  TotalCount?: number
4399
4437
  /**
4400
- * 文件id数组,有效期一个小时;有效期内此文件id可以反复使用
4438
+ * 文件资源ID数组,每个文件资源ID为32位字符串。
4439
+ 建议开发者保存此资源ID,后续创建合同或创建合同流程需此资源ID。
4440
+ 注:`有效期一个小时, 有效期内此文件id可以反复使用, 超过有效期无法使用`
4401
4441
  */
4402
4442
  FileIds?: Array<string>
4403
4443
  /**
4404
- * 文件Url
4444
+ * 对应上传文件的下载链接,过期时间5分钟
4405
4445
  */
4406
4446
  FileUrls?: Array<string>
4407
4447
  /**
@@ -5009,11 +5049,26 @@ export interface ChannelCreateWebThemeConfigResponse {
5009
5049
  */
5010
5050
  export interface GetDownloadFlowUrlRequest {
5011
5051
  /**
5012
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
5052
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5053
+
5054
+ 此接口下面信息必填。
5055
+ <ul>
5056
+ <li>渠道应用标识: Agent.AppId</li>
5057
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5058
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
5059
+ </ul>
5060
+ 第三方平台子客企业和员工必须已经经过实名认证
5013
5061
  */
5014
5062
  Agent: Agent
5015
5063
  /**
5016
- * 文件夹数组,签署流程总数不能超过50个,一个文件夹下,不能超过20个签署流程
5064
+ * 流程合同ID列表, 可将这些流程ID组织成合同组的形式, 下载时候每个文件夹会是一个zip压缩包, 每个文件夹对多20个合同, 所有文件夹最多50个合同
5065
+
5066
+ 如下列组织形式, 控制台下载页面点击下载按钮后, 会生成**2023采购合同.zip**和**2023入职合同.zip** 两个下载任务(注:`部分浏览器需要授权或不支持创建多下载任务`)
5067
+
5068
+ **2023采购合同.zip**压缩包会有`yDwivUUckpor6wtoUuogwQHCAB0ES0pQ`和`yDwi8UUckpo5fz9cUqI6nGwcuTvt9YSh`两个合同的文件
5069
+ **2023入职合同.zip** 压缩包会有`yDwivUUckpor6wobUuogwQHvdGfvDi5K`的文件
5070
+
5071
+ ![image]( https://dyn.ess.tencent.cn/guide/capi/channel_GetDownloadFlowUrl_DownLoadFlows.png)
5017
5072
  */
5018
5073
  DownLoadFlows?: Array<DownloadFlowInfo>
5019
5074
  /**
@@ -5154,11 +5209,11 @@ export interface ChannelCreateFlowGroupByTemplatesRequest {
5154
5209
 
5155
5210
  此接口下面信息必填。
5156
5211
  <ul>
5157
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
5158
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
5159
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
5212
+ <li>渠道应用标识: Agent.AppId</li>
5213
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5214
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
5160
5215
  </ul>
5161
- 子客企业和子客企业中的员工比较走完创建和实名过程
5216
+ 第三方平台子客企业和员工必须已经经过实名认证
5162
5217
  */
5163
5218
  Agent: Agent
5164
5219
  /**
@@ -5194,23 +5249,36 @@ export interface SignUrl {
5194
5249
  */
5195
5250
  export interface ChannelCancelFlowRequest {
5196
5251
  /**
5197
- * 签署流程编号
5252
+ * 要撤销的合同流程ID
5198
5253
  */
5199
5254
  FlowId: string
5200
5255
  /**
5201
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填。
5256
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5257
+
5258
+ 此接口下面信息必填。
5259
+ <ul>
5260
+ <li>渠道应用标识: Agent.AppId</li>
5261
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5262
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5263
+ </ul>
5264
+ 第三方平台子客企业和员工必须已经经过实名认证
5202
5265
  */
5203
5266
  Agent?: Agent
5204
5267
  /**
5205
- * 撤回原因,最大不超过200字符
5268
+ * 撤回原因,长度不能超过200,只能由中文、字母、数字和下划线组成。
5206
5269
  */
5207
5270
  CancelMessage?: string
5208
5271
  /**
5209
- * 撤销理由自定义格式;选项:
5210
- 0 默认格式
5211
- 1 只保留身份信息:展示为【发起方】
5212
- 2 保留身份信息+企业名称:展示为【发起方xxx公司】
5213
- 3 保留身份信息+企业名称+经办人名称:展示为【发起方xxxx公司-经办人姓名】
5272
+ * 撤销理由自定义格式, 会展示在合同预览的界面中, 可以选择下面的组合方式:
5273
+
5274
+ **0** : 默认格式, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
5275
+ **1** : 合同封面页面会展示为: 发起方以**CancelMessage**的理由撤销当前合同
5276
+ **2** : 保留企业名称, 合同封面页面会展示为: 发起方-企业名称以**CancelMessage**的理由撤销当前合同
5277
+ **3** : 保留企业名称+经办人名字, 合同封面页面会展示为: 发起方-企业名称-撤销的经办人名字以**CancelMessage**的理由撤销当前合同
5278
+
5279
+ 注: `CancelMessage为撤销当前合同的理由`
5280
+
5281
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_ChannelCancelFlow.png)
5214
5282
  */
5215
5283
  CancelMessageFormat?: number
5216
5284
  /**
@@ -5437,17 +5505,26 @@ export interface CreateFlowsByTemplatesRequest {
5437
5505
  */
5438
5506
  export interface UploadFilesRequest {
5439
5507
  /**
5440
- * 应用相关信息,若是第三方应用集成调用 若是第三方应用集成调用,Agent.AppId 和 Agent.ProxyOrganizationOpenId 必填
5508
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5509
+
5510
+ 此接口下面信息必填。
5511
+ <ul>
5512
+ <li>渠道应用标识: Agent.AppId</li>
5513
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5514
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
5515
+ </ul>
5516
+ 第三方平台子客企业和员工必须已经经过实名认证
5441
5517
  */
5442
5518
  Agent: Agent
5443
5519
  /**
5444
- * 文件对应业务类型
5445
- 1. TEMPLATE - 模板; 文件类型:.pdf/.doc/.docx/.html
5446
- 2. DOCUMENT - 签署过程及签署后的合同文档/图片控件 文件类型:.pdf/.doc/.docx/.jpg/.png/.xls.xlsx/.html
5520
+ *
5521
+ 文件对应业务类型,可以选择的类型如下
5522
+ <ul><li> **TEMPLATE** : 此上传的文件用户生成合同模板,文件类型支持.pdf/.doc/.docx/.html格式,如果非pdf文件需要通过<a href="https://qian.tencent.com/developers/partnerApis/files/ChannelGetTaskResultApi" target="_blank">创建文件转换任务</a>转换后才能使用</li>
5523
+ <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>
5447
5524
  */
5448
5525
  BusinessType: string
5449
5526
  /**
5450
- * 上传文件内容数组,最多支持20个文件
5527
+ * 上传文件内容数组,最多支持上传20个文件。
5451
5528
  */
5452
5529
  FileInfos?: Array<UploadFile>
5453
5530
  /**
@@ -5769,9 +5846,9 @@ export interface CreateSealByImageRequest {
5769
5846
 
5770
5847
  此接口下面信息必填。
5771
5848
  <ul>
5772
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
5773
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
5774
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
5849
+ <li>渠道应用标识: Agent.AppId</li>
5850
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
5851
+ <li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
5775
5852
  </ul>
5776
5853
  第三方平台子客企业和员工必须已经经过实名认证
5777
5854
  */
@@ -5806,7 +5883,7 @@ export interface CreateSealByImageRequest {
5806
5883
  * 电子印章类型 , 可选类型如下:
5807
5884
  <ul><li>**OFFICIAL**: (默认)公章</li>
5808
5885
  <li>**CONTRACT**: 合同专用章;</li>
5809
- <li>**FINANCE**: 合财务专用章;</li>
5886
+ <li>**FINANCE**: 财务专用章;</li>
5810
5887
  <li>**PERSONNEL**: 人事专用章</li>
5811
5888
  </ul>
5812
5889
  注: `同企业下只能有一个公章, 重复创建会报错`