tencentcloud-sdk-nodejs-essbasic 4.0.708 → 4.0.710

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.
@@ -75,7 +75,62 @@ class Client extends TencentCloudCommon.AbstractClient {
75
75
  /**
76
76
  * 接口(ChannelCreateFlowByFiles)用PDF文件创建签署流程。
77
77
 
78
- 注: `此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。`
78
+ 适用场景:适用非制式的合同文件签署,开发者有每个签署流程的PDF,可以通过该接口传入完整的PDF文件及流程信息生成待签署的合同流程。
79
+
80
+ **注**:
81
+ <ul>
82
+ <li>此接口静默签(企业自动签)能力为白名单功能,使用前请联系对接的客户经理沟通。</li>
83
+ <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
84
+ </ul>
85
+
86
+ ![image](https://dyn.ess.tencent.cn/guide/capi/ChannelCreateFlowByFiles.png)
87
+
88
+ **可以作为发起方和签署方的角色列表**
89
+ <table>
90
+ <thead>
91
+ <tr>
92
+ <th>场景编号</th>
93
+ <th>可作为发起方类型</th>
94
+ <th>可作为签署方的类型</th>
95
+ </tr>
96
+ </thead>
97
+
98
+ <tbody>
99
+ <tr>
100
+ <td>场景一</td>
101
+ <td>第三方子企业A员工</td>
102
+ <td>第三方子企业A员工</td>
103
+ </tr>
104
+
105
+ <tr>
106
+ <td>场景二</td>
107
+ <td>第三方子企业A员工</td>
108
+ <td>第三方子企业B(不指定经办人)</td>
109
+ </tr>
110
+
111
+ <tr>
112
+ <td>场景三</td>
113
+ <td>第三方子企业A员工</td>
114
+ <td>第三方子企业B员工</td>
115
+ </tr>
116
+
117
+ <tr>
118
+ <td>场景四</td>
119
+ <td>第三方子企业A员工</td>
120
+ <td>个人/自然人</td>
121
+ </tr>
122
+
123
+ <tr>
124
+ <td>场景五</td>
125
+ <td>第三方子企业A员工</td>
126
+ <td>SaaS平台企业员工</td>
127
+ </tr>
128
+ </tbody>
129
+ </table>
130
+
131
+ **注**:
132
+ `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
133
+ `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
79
134
  */
80
135
  async ChannelCreateFlowByFiles(req, cb) {
81
136
  return this.request("ChannelCreateFlowByFiles", req, cb);
@@ -93,8 +148,15 @@ class Client extends TencentCloudCommon.AbstractClient {
93
148
  return this.request("ChannelCancelMultiFlowSignQRCode", req, cb);
94
149
  }
95
150
  /**
96
- * 查询企业扩展服务授权信息,企业经办人需要是企业超管或者法人
97
- */
151
+ * 查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
152
+ 1. 企业自动签
153
+ 2. 企业与港澳台居民签署合同
154
+ 3. 使用手机号验证签署方身份
155
+ 4. 骑缝章
156
+ 5. 拓宽签署方年龄限制
157
+
158
+ 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
159
+ */
98
160
  async DescribeExtendedServiceAuthInfo(req, cb) {
99
161
  return this.request("DescribeExtendedServiceAuthInfo", req, cb);
100
162
  }
@@ -182,6 +244,57 @@ class Client extends TencentCloudCommon.AbstractClient {
182
244
  * 接口(CreateFlowsByTemplates)用于使用模板批量创建签署流程。当前可批量发起合同(签署流程)数量为1-20个。
183
245
  如若在模板中配置了动态表格, 上传的附件必须为A4大小
184
246
  合同发起人必须在电子签已经进行实名。
247
+
248
+ **整体的逻辑如下**
249
+
250
+ ![image](https://dyn.ess.tencent.cn/guide/capi/CreateFlowsByTemplates.png)
251
+
252
+ **可以作为发起方和签署方的角色列表**
253
+ <table>
254
+ <thead>
255
+ <tr>
256
+ <th>场景编号</th>
257
+ <th>可作为发起方类型</th>
258
+ <th>可作为签署方的类型</th>
259
+ </tr>
260
+ </thead>
261
+
262
+ <tbody>
263
+ <tr>
264
+ <td>场景一</td>
265
+ <td>第三方子企业A员工</td>
266
+ <td>第三方子企业A员工</td>
267
+ </tr>
268
+
269
+ <tr>
270
+ <td>场景二</td>
271
+ <td>第三方子企业A员工</td>
272
+ <td>第三方子企业B(不指定经办人)</td>
273
+ </tr>
274
+
275
+ <tr>
276
+ <td>场景三</td>
277
+ <td>第三方子企业A员工</td>
278
+ <td>第三方子企业B员工</td>
279
+ </tr>
280
+
281
+ <tr>
282
+ <td>场景四</td>
283
+ <td>第三方子企业A员工</td>
284
+ <td>个人/自然人</td>
285
+ </tr>
286
+
287
+ <tr>
288
+ <td>场景五</td>
289
+ <td>第三方子企业A员工</td>
290
+ <td>SaaS平台企业员工</td>
291
+ </tr>
292
+ </tbody>
293
+ </table>
294
+
295
+ **注**:
296
+ `1. 发起合同时候, 作为发起方的第三方子企业A员工的企业和员工必须经过实名, 而作为签署方的第三方子企业A员工/个人/自然人/SaaS平台企业员工/第三方子企业B员工企业中的企业和个人/员工可以未实名`
297
+ `2. 不同类型的签署方传参不同, 可以参考开发者中心的FlowApproverInfo结构体说明`
185
298
  */
186
299
  async CreateFlowsByTemplates(req, cb) {
187
300
  return this.request("CreateFlowsByTemplates", req, cb);
@@ -317,8 +430,15 @@ class Client extends TencentCloudCommon.AbstractClient {
317
430
  return this.request("ChannelGetTaskResultApi", req, cb);
318
431
  }
319
432
  /**
320
- * 创建出证报告,返回报告 ID。需要配合出证套餐才能调用。
321
- 出证需要一定时间,建议调用创建出证24小时之后再通过DescribeChannelFlowEvidenceReport进行查询。
433
+ * 提交申请出证报告任务并返回报告ID
434
+
435
+ 注意:
436
+ <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
437
+ <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
438
+ <li>合同流程必须所有参与方`已经签署完成`。</li>
439
+ <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
440
+
441
+ <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>
322
442
  */
323
443
  async CreateChannelFlowEvidenceReport(req, cb) {
324
444
  return this.request("CreateChannelFlowEvidenceReport", req, cb);
@@ -507,8 +627,41 @@ class Client extends TencentCloudCommon.AbstractClient {
507
627
  return this.request("ChannelCreateFlowGroupByTemplates", req, cb);
508
628
  }
509
629
  /**
510
- * 此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接,支持创建企业超管变更链接或企业基础信息变更链接,通过入参ChangeType指定。
511
- */
630
+ * 此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接(需要在移动端打开,会跳转到微信小程序),支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。
631
+
632
+
633
+ <h3 id="1-企业超管变更">1. 企业超管变更</h3>
634
+
635
+ <p>换成企业的其他员工来当超管</p>
636
+
637
+ <h3 id="2-企业基础信息变更">2. 企业基础信息变更</h3>
638
+
639
+ <h4 id="可以变动">可以变动</h4>
640
+
641
+ <ul>
642
+ <li>企业名称<br>
643
+ </li>
644
+ <li>法定代表人姓名(新法人有邀请链接)<br>
645
+ </li>
646
+ <li>企业地址和所在地</li>
647
+ </ul>
648
+
649
+ <h4 id="不可变动">不可变动</h4>
650
+
651
+ <ul>
652
+ <li>统一社会信用代码<br>
653
+ </li>
654
+ <li>企业主体类型</li>
655
+ </ul>
656
+
657
+ <p>如果企业名称变动会引起下面的变动</p>
658
+
659
+ <ul>
660
+ <li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>
661
+ <li>印章: 会删除所有的印章所有的机构公章和合同专用章, 然后用新企业名称生成新的机构公章 和合同专用章, 而法人章, 财务专用章和人事专用章不会处理</li>
662
+ <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
663
+ </ul>
664
+ */
512
665
  async CreateChannelOrganizationInfoChangeUrl(req, cb) {
513
666
  return this.request("CreateChannelOrganizationInfoChangeUrl", req, cb);
514
667
  }
@@ -556,7 +556,7 @@ export interface DescribeResourceUrlsByFlowsRequest {
556
556
  */
557
557
  export interface CreateChannelOrganizationInfoChangeUrlResponse {
558
558
  /**
559
- * 创建的企业信息变更链接。
559
+ * 创建的企业信息变更链接。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。
560
560
  */
561
561
  Url?: string;
562
562
  /**
@@ -1274,9 +1274,7 @@ export interface ChannelCreateFlowByFilesRequest {
1274
1274
  * 合同流程的签署顺序类型:
1275
1275
  <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
1276
1276
  <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
1277
-
1278
-
1279
- `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
1277
+ **注**: `有序签署时以传入FlowApprovers数组的顺序作为签署顺序`
1280
1278
  */
1281
1279
  Unordered?: boolean;
1282
1280
  /**
@@ -1328,9 +1326,7 @@ export interface ChannelCreateFlowByFilesRequest {
1328
1326
  * 签署方签署控件(印章/签名等)的生成方式:
1329
1327
  <ul><li> **0**:在合同流程发起时,由发起人指定签署方的签署控件的位置和数量。</li>
1330
1328
  <li> **1**:签署方在签署时自行添加签署控件,可以拖动位置和控制数量。</li></ul>
1331
-
1332
- 注:
1333
- `发起后添加控件功能不支持添加签批控件`
1329
+ **注**: `发起后添加控件功能不支持添加签批控件`
1334
1330
  */
1335
1331
  SignBeanTag?: number;
1336
1332
  /**
@@ -1533,7 +1529,8 @@ export interface ChannelCreateOrganizationModifyQrCodeRequest {
1533
1529
  */
1534
1530
  export interface ChannelCreateFlowByFilesResponse {
1535
1531
  /**
1536
- * 合同签署流程ID
1532
+ * 合同流程ID,为32位字符串。
1533
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1537
1534
  注意:此字段可能返回 null,表示取不到有效值。
1538
1535
  */
1539
1536
  FlowId?: string;
@@ -1956,11 +1953,19 @@ export interface ChannelVerifyPdfRequest {
1956
1953
  */
1957
1954
  export interface CreateChannelFlowEvidenceReportRequest {
1958
1955
  /**
1959
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
1956
+ * 员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1957
+
1958
+ 此接口下面信息必填。
1959
+ <ul>
1960
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
1961
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
1962
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
1963
+ </ul>
1960
1964
  */
1961
1965
  Agent: Agent;
1962
1966
  /**
1963
- * 签署流程编号
1967
+ * 合同流程ID,为32位字符串。
1968
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
1964
1969
  */
1965
1970
  FlowId: string;
1966
1971
  /**
@@ -2732,10 +2737,14 @@ export interface DescribeUsageRequest {
2732
2737
  */
2733
2738
  export interface DescribeExtendedServiceAuthInfoRequest {
2734
2739
  /**
2735
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
2736
-
2737
- 注: 此接口 参数Agent. ProxyOperator.OpenId 需要传递超管或者法人的OpenId
2740
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2738
2741
 
2742
+ 此接口下面信息必填。
2743
+ <ul>
2744
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2745
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2746
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2747
+ </ul>
2739
2748
  */
2740
2749
  Agent: Agent;
2741
2750
  }
@@ -3518,18 +3527,62 @@ export interface SignQrCode {
3518
3527
  /**
3519
3528
  * 创建签署流程签署人入参。
3520
3529
 
3521
- 其中签署方FlowApproverInfo需要传递的参数
3522
- 非单C、单B、B2C合同,ApproverType、RecipientId(模板发起合同时)必传,建议都传。
3530
+ **各种场景传参说明**:
3531
+
3532
+ <table>
3533
+ <thead>
3534
+ <tr>
3535
+ <th>场景编号</th>
3536
+ <th>可作为发起方类型</th>
3537
+ <th>可作为签署方的类型</th>
3538
+ <th>签署方传参说明</th>
3539
+ </tr>
3540
+ </thead>
3523
3541
 
3524
- 其他身份标识,注:`如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息`
3542
+ <tbody>
3543
+ <tr>
3544
+ <td>场景一</td>
3545
+ <td>第三方子企业A员工</td>
3546
+ <td>第三方子企业A员工</td>
3547
+ <td>OpenId、OrgName、OrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3548
+ </tr>
3525
3549
 
3526
- <ul><li>1-个人:Name、Mobile必传</li>
3527
- <li>2-第三方平台子客企业指定经办人:OpenId必传,OrgName必传、OrgOpenId必传;</li>
3528
- <li>3-第三方平台子客企业不指定经办人:OrgName必传、OrgOpenId必传;</li>
3529
- <li>4-非第三方平台子客企业(平台企业):Name、Mobile必传,OrgName必传,且NotChannelOrganization=True。</li></ul>
3550
+ <tr>
3551
+ <td>场景二</td>
3552
+ <td>第三方子企业A员工</td>
3553
+ <td>第三方子企业B(不指定经办人)</td>
3554
+ <td>OrgName、OrgOpenId必传 ,ApproverType设置为ORGANIZATION</td>
3555
+ </tr>
3530
3556
 
3531
- RecipientId参数:
3532
- 从DescribeTemplates接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
3557
+ <tr>
3558
+ <td>场景三</td>
3559
+ <td>第三方子企业A员工</td>
3560
+ <td>第三方子企业B员工</td>
3561
+ <td>OpenId、OrgName、OrgOpenId必传, ApproverType设置为ORGANIZATION</td>
3562
+ </tr>
3563
+
3564
+ <tr>
3565
+ <td>场景四</td>
3566
+ <td>第三方子企业A员工</td>
3567
+ <td>个人/自然人</td>
3568
+ <td>Name、Mobile必传, ApproverType设置为PERSON</td>
3569
+ </tr>
3570
+
3571
+ <tr>
3572
+ <td>场景五</td>
3573
+ <td>第三方子企业A员工</td>
3574
+ <td>SaaS平台企业员工</td>
3575
+ <td>Name、Mobile、OrgName必传,且NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
3576
+ </tr>
3577
+ </tbody>
3578
+ </table>
3579
+
3580
+ **注1**: `使用模板发起合同时,RecipientId(模板发起合同时)必传`
3581
+
3582
+ RecipientId参数获取:
3583
+ 从<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/DescribeFlowTemplates" target="_blank">DescribeFlowTemplates接口</a>接口中,可以得到模板下的签署方Recipient列表,根据模板自定义的Rolename在此结构体中确定其RecipientId。
3584
+
3585
+ **注2**: `如果发起的是动态签署方(即ApproverOption.FillType指定为1),可以不指定具体签署人信息`, 动态签署方可以参考<a href="https://qian.tencent.com/developers/partner/dynamic_signer" target="_blank">此文档</a>
3533
3586
  */
3534
3587
  export interface FlowApproverInfo {
3535
3588
  /**
@@ -3868,7 +3921,8 @@ export interface FlowDetailInfo {
3868
3921
  */
3869
3922
  export interface CreateFlowsByTemplatesResponse {
3870
3923
  /**
3871
- * 多个合同ID
3924
+ * 生成的合同流程ID数组,合同流程ID为32位字符串。
3925
+ 建议开发者妥善保存此流程ID数组,以便于顺利进行后续操作。
3872
3926
  */
3873
3927
  FlowIds?: Array<string>;
3874
3928
  /**
@@ -3881,7 +3935,9 @@ export interface CreateFlowsByTemplatesResponse {
3881
3935
  */
3882
3936
  ErrorMessages?: Array<string>;
3883
3937
  /**
3884
- * 预览模式下返回的预览文件url数组
3938
+ * 合同预览链接URL数组。
3939
+
3940
+ 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
3885
3941
  */
3886
3942
  PreviewUrls?: Array<string>;
3887
3943
  /**
@@ -4016,13 +4072,13 @@ export interface UploadFile {
4016
4072
  FileName?: string;
4017
4073
  }
4018
4074
  /**
4019
- * 企业扩展服务授权信息
4075
+ * 扩展服务开通和授权的详细信息
4020
4076
  */
4021
4077
  export interface ExtentServiceAuthInfo {
4022
4078
  /**
4023
4079
  * 扩展服务类型
4024
4080
  <ul>
4025
- <li>AUTO_SIGN 企业静默签(自动签署)</li>
4081
+ <li>AUTO_SIGN 企业自动签(自动签署)</li>
4026
4082
  <li> OVERSEA_SIGN 企业与港澳台居民*签署合同</li>
4027
4083
  <li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
4028
4084
  <li> PAGING_SEAL 骑缝章</li>
@@ -4036,18 +4092,16 @@ export interface ExtentServiceAuthInfo {
4036
4092
  */
4037
4093
  Name?: string;
4038
4094
  /**
4039
- * 服务状态
4040
- ENABLE 开启
4041
- DISABLE 关闭
4095
+ * 扩展服务的开通状态: ENABLE:开通 DISABLE:未开通
4042
4096
  */
4043
4097
  Status?: string;
4044
4098
  /**
4045
- * 最近操作人第三方应用平台的用户openid
4099
+ * 操作扩展服务的操作人第三方应用平台的用户openid
4046
4100
  注意:此字段可能返回 null,表示取不到有效值。
4047
4101
  */
4048
4102
  OperatorOpenId?: string;
4049
4103
  /**
4050
- * 最近操作时间戳,单位秒
4104
+ * 扩展服务的操作时间,格式为Unix标准时间戳(秒)。
4051
4105
  注意:此字段可能返回 null,表示取不到有效值。
4052
4106
  */
4053
4107
  OperateOn?: number;
@@ -4242,12 +4296,14 @@ export interface ApproverItem {
4242
4296
  /**
4243
4297
  * 签署方唯一编号
4244
4298
 
4245
- 在动态签署人场景下,可以用此编号确定参与方
4299
+ 在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
4246
4300
  注意:此字段可能返回 null,表示取不到有效值。
4247
4301
  */
4248
4302
  SignId?: string;
4249
4303
  /**
4250
4304
  * 签署方角色编号
4305
+
4306
+ 在<a href="https://qian.tencent.com/developers/company/dynamic_signer" target="_blank">动态补充签署人</a>场景下,可以用此编号确定参与方
4251
4307
  注意:此字段可能返回 null,表示取不到有效值。
4252
4308
  */
4253
4309
  RecipientId?: string;
@@ -4464,6 +4520,17 @@ export interface ApproverOption {
4464
4520
  </ul>
4465
4521
  */
4466
4522
  FillType?: number;
4523
+ /**
4524
+ * 签署人阅读合同限制参数
4525
+ <br/>取值:
4526
+ <ul>
4527
+ <li> LimitReadTimeAndBottom,阅读合同必须限制阅读时长并且必须阅读到底</li>
4528
+ <li> LimitReadTime,阅读合同仅限制阅读时长</li>
4529
+ <li> LimitBottom,阅读合同仅限制必须阅读到底</li>
4530
+ <li> NoReadTimeAndBottom,阅读合同不限制阅读时长且不限制阅读到底(白名单功能,请联系客户经理开白使用)</li>
4531
+ </ul>
4532
+ */
4533
+ FlowReadLimit?: string;
4467
4534
  }
4468
4535
  /**
4469
4536
  * 合作企业经办人列表信息
@@ -4793,12 +4860,20 @@ export interface ChannelBatchCancelFlowsRequest {
4793
4860
  */
4794
4861
  export interface CreateChannelOrganizationInfoChangeUrlRequest {
4795
4862
  /**
4796
- * 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4863
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4864
+
4865
+ 此接口下面信息必填。
4866
+ <ul>
4867
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
4868
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
4869
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
4870
+ </ul>
4797
4871
  */
4798
4872
  Agent: Agent;
4799
4873
  /**
4800
4874
  * 企业信息变更类型,可选类型如下:
4801
- <ul><li>**1**:企业超管变更</li><li>**2**:企业基础信息变更</li></ul>
4875
+ <ul><li>**1**:企业超管变更, 可以将超管换成同企业的其他员工</li>
4876
+ <li>**2**:企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
4802
4877
  */
4803
4878
  ChangeType: number;
4804
4879
  }
@@ -5085,7 +5160,14 @@ export interface OccupiedSeal {
5085
5160
  */
5086
5161
  export interface CreateFlowsByTemplatesRequest {
5087
5162
  /**
5088
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 均必填。
5163
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
5164
+
5165
+ 此接口下面信息必填。
5166
+ <ul>
5167
+ <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
5168
+ <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
5169
+ <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
5170
+ </ul>
5089
5171
  */
5090
5172
  Agent: Agent;
5091
5173
  /**
@@ -5093,13 +5175,22 @@ export interface CreateFlowsByTemplatesRequest {
5093
5175
  */
5094
5176
  FlowInfos: Array<FlowInfo>;
5095
5177
  /**
5096
- * 是否为预览模式;默认为false,即非预览模式,此时发起合同并返回FlowIds;若为预览模式,不会发起合同,会返回PreviewUrls;
5097
- 预览链接有效期300秒;
5098
- 同时,如果预览的文件中指定了动态表格控件,需要进行异步合成;此时此接口返回的是合成前的文档预览链接,而合成完成后的文档预览链接会通过:回调通知的方式、或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询;
5178
+ * 是否为预览模式,取值如下:
5179
+ <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
5180
+ <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
5181
+
5182
+ 注:
5183
+
5184
+ `如果预览的文件中指定了动态表格控件,此时此接口返回的是合成前的文档预览链接,合成完成后的文档预览链接需要通过回调通知的方式或使用返回的TaskInfo中的TaskId通过ChannelGetTaskResultApi接口查询得到`
5185
+
5099
5186
  */
5100
5187
  NeedPreview?: boolean;
5101
5188
  /**
5102
- * 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
5189
+ * 预览模式下产生的预览链接类型
5190
+ <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
5191
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
5192
+ 注: `此参数在NeedPreview 为true时有效`
5193
+
5103
5194
  */
5104
5195
  PreviewType?: number;
5105
5196
  /**
@@ -5271,17 +5362,16 @@ export interface OperateChannelTemplateRequest {
5271
5362
  */
5272
5363
  export interface CreateChannelFlowEvidenceReportResponse {
5273
5364
  /**
5274
- * 出证报告 ID,可用户DescribeChannelFlowEvidenceReport接口查询出证PDF的下载地址
5275
-
5365
+ * 出证报告 ID,可用于<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>查询出证任务结果和出证PDF的下载URL
5276
5366
  注意:此字段可能返回 null,表示取不到有效值。
5277
5367
  */
5278
5368
  ReportId?: string;
5279
5369
  /**
5280
- * 出征任务的执行状态,状态列表如下
5370
+ * 出证任务执行的状态, 状态含义如下:
5281
5371
 
5282
- - EvidenceStatusExecuting : 出征任务正在执行中
5283
- - EvidenceStatusSuccess : 出征任务执行成功
5284
- - EvidenceStatusFailed : 出征任务执行失败
5372
+ <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
5373
+ <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
5374
+ <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
5285
5375
  */
5286
5376
  Status?: string;
5287
5377
  /**
@@ -5363,8 +5453,7 @@ export interface ChannelCreateFlowApproversRequest {
5363
5453
  /**
5364
5454
  * 签署人信息补充方式
5365
5455
 
5366
- <ul><li>**0**: 补充或签人,支持补充多个企业经办签署人(默认)注: `不可补充个人签署人`</li>
5367
- <li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
5456
+ <ul><li>**1**: 补充动态签署人,可补充企业和个人签署人。注: `每个签署方节点签署人是唯一的,一个节点只支持传入一个签署人信息`</li></ul>
5368
5457
  */
5369
5458
  FillApproverType?: number;
5370
5459
  }
@@ -5539,7 +5628,7 @@ export interface ChannelCreateFlowSignUrlRequest {
5539
5628
  */
5540
5629
  export interface DescribeExtendedServiceAuthInfoResponse {
5541
5630
  /**
5542
- * 企业扩展服务授权信息
5631
+ * 服务开通和授权的信息列表,根据查询类型返回所有支持的扩展服务开通和授权状况,或者返回特定扩展服务的开通和授权状况。
5543
5632
  注意:此字段可能返回 null,表示取不到有效值。
5544
5633
  */
5545
5634
  AuthInfo?: Array<ExtentServiceAuthInfo>;