tencentcloud-sdk-nodejs-essbasic 4.0.722 → 4.0.724

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.
@@ -367,6 +367,8 @@ class Client extends TencentCloudCommon.AbstractClient {
367
367
  - 发起方和签署方的填写控件 Components
368
368
  - 签署方的签署控件 SignComponents
369
369
 
370
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
371
+
370
372
  **适用场景**
371
373
  该接口常用来配合<a href="https://qian.tencent.com/developers/partnerApis/startFlows/CreateFlowsByTemplates" target="_blank">用模板创建签署流程</a>和<a href="https://qian.tencent.com/developers/partnerApis/startFlows/ChannelCreateFlowGroupByTemplates" target="_blank">通过多模板创建合同组签署流程</a>接口,作为创建合同的前置接口使用。
372
374
  通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
@@ -499,12 +501,13 @@ class Client extends TencentCloudCommon.AbstractClient {
499
501
  * 提交申请出证报告任务并返回报告ID。
500
502
 
501
503
  注意:
502
- <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
503
- <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
504
- <li>合同流程必须所有参与方`已经签署完成`。</li>
505
- <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
504
+ - 使用此功能**需搭配出证套餐** ,使用前请联系对接的客户经理沟通。
505
+ - 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
506
+ - 合同流程必须**所有参与方已经签署完成**。
507
+ - 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL
508
+
506
509
 
507
- <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>
510
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
508
511
  */
509
512
  async CreateChannelFlowEvidenceReport(req, cb) {
510
513
  return this.request("CreateChannelFlowEvidenceReport", req, cb);
@@ -568,10 +571,14 @@ class Client extends TencentCloudCommon.AbstractClient {
568
571
  return this.request("ChannelCreateWebThemeConfig", req, cb);
569
572
  }
570
573
  /**
571
- * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
572
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
573
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
574
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
574
+ * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
575
+
576
+ `注意:`<br/>
577
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
578
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
579
+ `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
580
+ `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
581
+ 跳转到小程序的实现,参考微信官方文档(分为<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html">全屏</a>、<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html">半屏</a>两种方式),如何配置也可以请参考: <a href="https://qian.tencent.com/developers/company/openwxminiprogram">跳转电子签小程序配置</a>
575
582
  */
576
583
  async ChannelCreateFlowSignUrl(req, cb) {
577
584
  return this.request("ChannelCreateFlowSignUrl", req, cb);
@@ -592,8 +599,10 @@ class Client extends TencentCloudCommon.AbstractClient {
592
599
  return this.request("ChannelCreateReleaseFlow", req, cb);
593
600
  }
594
601
  /**
595
- * 用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
596
- */
602
+ * 获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息,支持设置过滤条件以筛选员工查询结果。
603
+
604
+ **注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
605
+ */
597
606
  async ChannelDescribeEmployees(req, cb) {
598
607
  return this.request("ChannelDescribeEmployees", req, cb);
599
608
  }
@@ -713,9 +722,20 @@ class Client extends TencentCloudCommon.AbstractClient {
713
722
  return this.request("ChannelCreateFlowReminds", req, cb);
714
723
  }
715
724
  /**
716
- * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意:
717
- 1. 需要在子客企业激活前调用该接口,如果您的企业已经提交企业信息或者企业已经激活,同步的企业信息将不会生效。
718
- 2. 如果您同时传递了营业执照信息和企业名称等信息,在认证过程中将以营业执照中的企业信息为准,请注意企业信息需要和营业执照信息对应。
725
+ * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。
726
+
727
+ 注意:
728
+
729
+ - **需要在<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>前同步的企业信息**, 否则会出现信息同步没有用的情形
730
+ - **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题
731
+
732
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/7ec91b79a0a4860e77c9ff9f4a5f13ad/channel_SyncProxyOrganization2.png)
733
+
734
+
735
+ - **企业统一社会信用代码**: 对应上图中的**1**
736
+ - **第三方平台子客企业名称**: 对应上图中的**2**
737
+ - **企业法定代表人的名字**:对应上图中的**3**
738
+ - **企业详细住所**:对应上图中的**4**
719
739
  */
720
740
  async SyncProxyOrganization(req, cb) {
721
741
  return this.request("SyncProxyOrganization", req, cb);
@@ -826,7 +846,7 @@ class Client extends TencentCloudCommon.AbstractClient {
826
846
  /**
827
847
  * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
828
848
 
829
- - **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
849
+ - **新增员工的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
830
850
 
831
851
  - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
832
852
 
@@ -835,14 +855,21 @@ class Client extends TencentCloudCommon.AbstractClient {
835
855
  **注**:
836
856
  - 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
837
857
  - <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
838
- - 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
858
+ - 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
839
859
  */
840
860
  async SyncProxyOrganizationOperators(req, cb) {
841
861
  return this.request("SyncProxyOrganizationOperators", req, cb);
842
862
  }
843
863
  /**
844
- * 查询出证报告,返回报告 URL。
845
- */
864
+ * 获取出证报告任务执行结果,返回报告 URL。
865
+
866
+ 注意:
867
+
868
+ - 使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
869
+ - 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
870
+
871
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
872
+ */
846
873
  async DescribeChannelFlowEvidenceReport(req, cb) {
847
874
  return this.request("DescribeChannelFlowEvidenceReport", req, cb);
848
875
  }
@@ -352,6 +352,8 @@ export interface ChannelDeleteSealPoliciesRequest {
352
352
  export interface ChannelBatchCancelFlowsResponse {
353
353
  /**
354
354
  * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
355
+
356
+ 注: `如果全部撤销成功, 此数组为空数组`
355
357
  */
356
358
  FailMessages?: Array<string>;
357
359
  /**
@@ -835,7 +837,7 @@ export interface ChannelCreateRoleRequest {
835
837
  */
836
838
  Description?: string;
837
839
  /**
838
- * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
840
+ * 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
839
841
  */
840
842
  PermissionGroups?: Array<PermissionGroup>;
841
843
  }
@@ -933,7 +935,7 @@ export interface ReleasedApprover {
933
935
  * 签署方经办人的证件类型,支持以下类型
934
936
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
935
937
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
936
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
938
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
937
939
  */
938
940
  IdCardType?: string;
939
941
  /**
@@ -1053,12 +1055,19 @@ export interface ChannelCreateUserRolesResponse {
1053
1055
  */
1054
1056
  export interface SyncProxyOrganizationRequest {
1055
1057
  /**
1056
- * 应用信息
1057
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
1058
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1059
+
1060
+ 此接口下面信息必填。
1061
+ <ul>
1062
+ <li>渠道应用标识: Agent.AppId</li>
1063
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1064
+ </ul>
1065
+
1058
1066
  */
1059
1067
  Agent: Agent;
1060
1068
  /**
1061
- * 第三方平台子客企业名称,最大长度64个字符
1069
+ * 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
1070
+ 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
1062
1071
  */
1063
1072
  ProxyOrganizationName: string;
1064
1073
  /**
@@ -1070,7 +1079,7 @@ export interface SyncProxyOrganizationRequest {
1070
1079
  */
1071
1080
  UniformSocialCreditCode?: string;
1072
1081
  /**
1073
- * 第三方平台子客企业法人/负责人姓名
1082
+ * 第三方平台子客企业法定代表人的名字
1074
1083
  */
1075
1084
  ProxyLegalName?: string;
1076
1085
  /**
@@ -1079,13 +1088,22 @@ export interface SyncProxyOrganizationRequest {
1079
1088
  */
1080
1089
  Operator?: UserInfo;
1081
1090
  /**
1082
- * 第三方平台子客企业法人/负责人证件类型,默认居民身份证(ID_CARD)类型,暂不支持其他类型
1091
+ * 第三方平台子客企业法定代表人的证件类型,支持以下类型
1092
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
1093
+ 注: `现在仅支持ID_CARD居民身份证类型`
1083
1094
  */
1084
1095
  ProxyLegalIdCardType?: string;
1085
1096
  /**
1086
- * 第三方平台子客企业法人/负责人证件号
1097
+ * 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
1098
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1087
1099
  */
1088
1100
  ProxyLegalIdCardNumber?: string;
1101
+ /**
1102
+ * 第三方平台子客企业详细住所,最大长度500个字符
1103
+
1104
+ 注:`需要符合省市区详情的格式例如: XX省XX市XX区街道具体地址`
1105
+ */
1106
+ ProxyAddress?: string;
1089
1107
  }
1090
1108
  /**
1091
1109
  * ChannelCreatePrepareFlow请求参数结构体
@@ -1192,27 +1210,34 @@ export interface DownloadFlowInfo {
1192
1210
  FlowIdList: Array<string>;
1193
1211
  }
1194
1212
  /**
1195
- * 签署人签署链接信息
1213
+ * 签署人签署链接信息。
1196
1214
  */
1197
1215
  export interface FlowApproverUrlInfo {
1198
1216
  /**
1199
- * 签署短链接,不支持小程序嵌入,只支持移动端浏览器打开。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
1217
+ * 签署短链接。</br>
1218
+ 注意:
1219
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1220
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1200
1221
  */
1201
- SignUrl: string;
1222
+ SignUrl?: string;
1202
1223
  /**
1203
- * 签署人类型 PERSON-个人
1224
+ * 签署人类型。
1225
+ - **PERSON**: 个人
1204
1226
  */
1205
- ApproverType: string;
1227
+ ApproverType?: string;
1206
1228
  /**
1207
- * 签署人姓名
1229
+ * 签署人姓名。
1208
1230
  */
1209
- Name: string;
1231
+ Name?: string;
1210
1232
  /**
1211
- * 签署人手机号
1233
+ * 签署人手机号。
1212
1234
  */
1213
- Mobile: string;
1235
+ Mobile?: string;
1214
1236
  /**
1215
- * 签署长链接,支持小程序嵌入。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
1237
+ * 签署长链接。</br>
1238
+ 注意:
1239
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1240
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1216
1241
  注意:此字段可能返回 null,表示取不到有效值。
1217
1242
  */
1218
1243
  LongUrl?: string;
@@ -2062,12 +2087,18 @@ export interface StaffRole {
2062
2087
  export interface ChannelVerifyPdfRequest {
2063
2088
  /**
2064
2089
  * 合同流程ID,为32位字符串。
2065
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2066
2090
  */
2067
2091
  FlowId: string;
2068
2092
  /**
2069
- * 代理企业和员工的信息。
2070
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2093
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2094
+
2095
+ 此接口下面信息必填。
2096
+ <ul>
2097
+ <li>渠道应用标识: Agent.AppId</li>
2098
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2099
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2100
+ </ul>
2101
+ 第三方平台子客企业和员工必须已经经过实名认证
2071
2102
  */
2072
2103
  Agent?: Agent;
2073
2104
  /**
@@ -2081,14 +2112,15 @@ export interface ChannelVerifyPdfRequest {
2081
2112
  */
2082
2113
  export interface CreateChannelFlowEvidenceReportRequest {
2083
2114
  /**
2084
- * 员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2115
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2085
2116
 
2086
2117
  此接口下面信息必填。
2087
2118
  <ul>
2088
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2089
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2090
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2119
+ <li>渠道应用标识: Agent.AppId</li>
2120
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2121
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2091
2122
  </ul>
2123
+ 第三方平台子客企业和员工必须已经经过实名认证
2092
2124
  */
2093
2125
  Agent: Agent;
2094
2126
  /**
@@ -2274,17 +2306,12 @@ export interface ChannelVerifyPdfResponse {
2274
2306
  <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
2275
2307
  <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
2276
2308
  <li>**3**:文件被篡改。</li>
2277
- <li>**4**:异常:文件内没有签名域。</li>
2309
+ <li>**4**:异常:文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
2278
2310
  <li>**5**:异常:文件签名格式错误。</li></ul>
2279
2311
  */
2280
2312
  VerifyResult?: number;
2281
2313
  /**
2282
- * 验签结果详情,每个签名域对应的验签结果。状态值如下
2283
- <ul><li> **1** :验签成功,在电子签签署</li>
2284
- <li> **2** :验签成功,在其他平台签署</li>
2285
- <li> **3** :验签失败</li>
2286
- <li> **4** :pdf文件没有签名域</li>
2287
- <li> **5** :文件签名格式错误</li></ul>
2314
+ * 验签结果详情,所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
2288
2315
  */
2289
2316
  PdfVerifyResults?: Array<PdfVerifyResult>;
2290
2317
  /**
@@ -2640,65 +2667,82 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
2640
2667
  ExpiredTime?: number;
2641
2668
  }
2642
2669
  /**
2643
- * 合同文件验签单个结果结构体
2670
+ * 合同验签每个签署区的信息
2644
2671
  */
2645
2672
  export interface PdfVerifyResult {
2646
2673
  /**
2647
- * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
2674
+ * 验签结果详情,每个签名域对应的验签结果。状态值如下
2675
+ <ul><li> **1** :验签成功,在电子签签署</li>
2676
+ <li> **2** :验签成功,在其他平台签署</li>
2677
+ <li> **3** :验签失败</li>
2678
+ <li> **4** :pdf文件没有签名域</li>
2679
+ <li> **5** :文件签名格式错误</li></ul>
2648
2680
  */
2649
- VerifyResult: number;
2681
+ VerifyResult?: number;
2650
2682
  /**
2651
- * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
2683
+ * 签署平台
2684
+ 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
2685
+ 如果文件不在腾讯电子签平台签署,则为**其他平台**。
2652
2686
  */
2653
- SignPlatform: string;
2687
+ SignPlatform?: string;
2654
2688
  /**
2655
- * 签署人名称
2689
+ * 申请证书的主体的名字
2690
+
2691
+ 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
2692
+ **企业**: ESS@企业名称@平台生成的数字编码
2693
+ **个人**: ESS@个人姓名@证件号@平台生成的数字编码
2694
+
2695
+ 如果在其他平台签署的, 主体的名字参考其他平台的说明
2656
2696
  */
2657
- SignerName: string;
2697
+ SignerName?: string;
2658
2698
  /**
2659
- * 签署时间戳,单位秒
2699
+ * 签署时间的Unix时间戳,单位毫秒
2660
2700
  */
2661
- SignTime: number;
2701
+ SignTime?: number;
2662
2702
  /**
2663
- * 签名算法
2703
+ * 证书签名算法, 如SHA1withRSA等算法
2664
2704
  */
2665
- SignAlgorithm: string;
2705
+ SignAlgorithm?: string;
2666
2706
  /**
2667
- * 签名证书序列号
2707
+ * CA供应商下发给用户的证书编号
2708
+
2709
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
2668
2710
  */
2669
- CertSn: string;
2711
+ CertSn?: string;
2670
2712
  /**
2671
- * 证书起始时间戳,单位秒
2713
+ * 证书起始时间的Unix时间戳,单位毫秒
2672
2714
  */
2673
- CertNotBefore: number;
2715
+ CertNotBefore?: number;
2674
2716
  /**
2675
- * 证书过期时间戳,单位秒
2717
+ * 证书过期时间的时间戳,单位毫秒
2676
2718
  */
2677
- CertNotAfter: number;
2719
+ CertNotAfter?: number;
2678
2720
  /**
2679
- * 签名类型
2721
+ * 签名类型, 保留字段, 现在全部为0
2722
+
2723
+
2680
2724
  */
2681
- SignType: number;
2725
+ SignType?: number;
2682
2726
  /**
2683
2727
  * 签名域横坐标,单位px
2684
2728
  */
2685
- ComponentPosX: number;
2729
+ ComponentPosX?: number;
2686
2730
  /**
2687
2731
  * 签名域纵坐标,单位px
2688
2732
  */
2689
- ComponentPosY: number;
2733
+ ComponentPosY?: number;
2690
2734
  /**
2691
2735
  * 签名域宽度,单位px
2692
2736
  */
2693
- ComponentWidth: number;
2737
+ ComponentWidth?: number;
2694
2738
  /**
2695
2739
  * 签名域高度,单位px
2696
2740
  */
2697
- ComponentHeight: number;
2741
+ ComponentHeight?: number;
2698
2742
  /**
2699
2743
  * 签名域所在页码,1~N
2700
2744
  */
2701
- ComponentPage: number;
2745
+ ComponentPage?: number;
2702
2746
  }
2703
2747
  /**
2704
2748
  * 用户的三要素:姓名,证件号,证件类型
@@ -3527,14 +3571,16 @@ export interface ChannelDescribeEmployeesRequest {
3527
3571
  /**
3528
3572
  * 查询的关键字段,支持Key-Values查询。可选键值如下:
3529
3573
  <ul>
3530
- <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
3531
- <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["QuiteJob"]**:查询离职员工</li></ul></li>
3532
- <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
3574
+ <li>Key:**"Status"**,Values: **["IsVerified"]**, 查询已实名的员工</li>
3575
+ <li>Key:**"Status"**,Values: **["QuiteJob"]**, 查询离职员工</li>
3576
+ <li>Key:**"StaffOpenId"**,Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
3533
3577
  </ul>
3578
+ 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
3534
3579
  */
3535
3580
  Filters?: Array<Filter>;
3536
3581
  /**
3537
- * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000。
3582
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。
3583
+ 页码从 0 开始,即首页为 0,最大20000。
3538
3584
  */
3539
3585
  Offset?: number;
3540
3586
  /**
@@ -4262,11 +4308,19 @@ export interface CreateFlowsByTemplatesResponse {
4262
4308
  */
4263
4309
  export interface DescribeChannelFlowEvidenceReportRequest {
4264
4310
  /**
4265
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
4311
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4312
+
4313
+ 此接口下面信息必填。
4314
+ <ul>
4315
+ <li>渠道应用标识: Agent.AppId</li>
4316
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4317
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4318
+ </ul>
4319
+ 第三方平台子客企业和员工必须已经经过实名认证
4266
4320
  */
4267
4321
  Agent: Agent;
4268
4322
  /**
4269
- * 出证报告编号
4323
+ * 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
4270
4324
  */
4271
4325
  ReportId: string;
4272
4326
  /**
@@ -4891,7 +4945,7 @@ export interface ProxyOrganizationOperator {
4891
4945
  * 签署方经办人的证件类型,支持以下类型
4892
4946
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
4893
4947
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
4894
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
4948
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
4895
4949
 
4896
4950
  */
4897
4951
  IdCardType?: string;
@@ -5271,7 +5325,7 @@ export interface ChannelModifyRoleRequest {
5271
5325
  */
5272
5326
  Description?: string;
5273
5327
  /**
5274
- * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
5328
+ * 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
5275
5329
  */
5276
5330
  PermissionGroups?: Array<PermissionGroup>;
5277
5331
  }
@@ -5936,16 +5990,16 @@ export interface ChannelCreateReleaseFlowResponse {
5936
5990
  */
5937
5991
  export interface DescribeChannelFlowEvidenceReportResponse {
5938
5992
  /**
5939
- * 出证报告下载 URL
5993
+ * 出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。
5940
5994
  注意:此字段可能返回 null,表示取不到有效值。
5941
5995
  */
5942
5996
  ReportUrl?: string;
5943
5997
  /**
5944
- * 出征任务的执行状态,状态列表如下
5998
+ * 出证任务执行的状态, 状态含义如下:
5945
5999
 
5946
- - EvidenceStatusExecuting : 出征任务正在执行中
5947
- - EvidenceStatusSuccess : 出征任务执行成功
5948
- - EvidenceStatusFailed : 出征任务执行失败
6000
+ <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
6001
+ <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
6002
+ <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
5949
6003
  */
5950
6004
  Status?: string;
5951
6005
  /**
@@ -6072,15 +6126,28 @@ export interface ChannelUpdateSealStatusResponse {
6072
6126
  */
6073
6127
  export interface ChannelCreateFlowSignUrlRequest {
6074
6128
  /**
6075
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
6129
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6130
+
6131
+ 此接口下面信息必填。
6132
+ <ul>
6133
+ <li>渠道应用标识: Agent.AppId</li>
6134
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6135
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6136
+ </ul>
6137
+ 第三方平台子客企业和员工必须已经经过实名认证
6076
6138
  */
6077
6139
  Agent: Agent;
6078
6140
  /**
6079
- * 流程编号
6141
+ * 合同流程ID,为32位字符串。
6142
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
6143
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6080
6144
  */
6081
6145
  FlowId: string;
6082
6146
  /**
6083
- * 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
6147
+ * 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,其他可不传。
6148
+ 注:
6149
+ `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
6150
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
6084
6151
  */
6085
6152
  FlowApproverInfos: Array<FlowApproverInfo>;
6086
6153
  /**
@@ -6094,7 +6161,7 @@ export interface ChannelCreateFlowSignUrlRequest {
6094
6161
  */
6095
6162
  Organization?: OrganizationInfo;
6096
6163
  /**
6097
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
6164
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
6098
6165
  */
6099
6166
  JumpUrl?: string;
6100
6167
  }