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.
@@ -374,6 +374,8 @@ export interface ChannelDeleteSealPoliciesRequest {
374
374
  export interface ChannelBatchCancelFlowsResponse {
375
375
  /**
376
376
  * 签署流程批量撤销失败原因,错误信息与流程Id一一对应,成功为"", 失败则对应失败原因
377
+
378
+ 注: `如果全部撤销成功, 此数组为空数组`
377
379
  */
378
380
  FailMessages?: Array<string>
379
381
  /**
@@ -877,7 +879,7 @@ export interface ChannelCreateRoleRequest {
877
879
  */
878
880
  Description?: string
879
881
  /**
880
- * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
882
+ * 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出
881
883
  */
882
884
  PermissionGroups?: Array<PermissionGroup>
883
885
  }
@@ -977,7 +979,7 @@ export interface ReleasedApprover {
977
979
  * 签署方经办人的证件类型,支持以下类型
978
980
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
979
981
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
980
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
982
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
981
983
  */
982
984
  IdCardType?: string
983
985
  /**
@@ -1101,12 +1103,19 @@ export interface ChannelCreateUserRolesResponse {
1101
1103
  */
1102
1104
  export interface SyncProxyOrganizationRequest {
1103
1105
  /**
1104
- * 应用信息
1105
- 此接口Agent.AppId、Agent.ProxyOrganizationOpenId必填
1106
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
1107
+
1108
+ 此接口下面信息必填。
1109
+ <ul>
1110
+ <li>渠道应用标识: Agent.AppId</li>
1111
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
1112
+ </ul>
1113
+
1106
1114
  */
1107
1115
  Agent: Agent
1108
1116
  /**
1109
- * 第三方平台子客企业名称,最大长度64个字符
1117
+ * 第三方平台子客企业名称,请确认该名称与企业营业执照中注册的名称一致。
1118
+ 注: `如果名称中包含英文括号(),请使用中文括号()代替。`
1110
1119
  */
1111
1120
  ProxyOrganizationName: string
1112
1121
  /**
@@ -1118,7 +1127,7 @@ export interface SyncProxyOrganizationRequest {
1118
1127
  */
1119
1128
  UniformSocialCreditCode?: string
1120
1129
  /**
1121
- * 第三方平台子客企业法人/负责人姓名
1130
+ * 第三方平台子客企业法定代表人的名字
1122
1131
  */
1123
1132
  ProxyLegalName?: string
1124
1133
  /**
@@ -1127,13 +1136,22 @@ export interface SyncProxyOrganizationRequest {
1127
1136
  */
1128
1137
  Operator?: UserInfo
1129
1138
  /**
1130
- * 第三方平台子客企业法人/负责人证件类型,默认居民身份证(ID_CARD)类型,暂不支持其他类型
1139
+ * 第三方平台子客企业法定代表人的证件类型,支持以下类型
1140
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li></ul>
1141
+ 注: `现在仅支持ID_CARD居民身份证类型`
1131
1142
  */
1132
1143
  ProxyLegalIdCardType?: string
1133
1144
  /**
1134
- * 第三方平台子客企业法人/负责人证件号
1145
+ * 第三方平台子客企业法定代表人的证件号码, 应符合以下规则
1146
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
1135
1147
  */
1136
1148
  ProxyLegalIdCardNumber?: string
1149
+ /**
1150
+ * 第三方平台子客企业详细住所,最大长度500个字符
1151
+
1152
+ 注:`需要符合省市区详情的格式例如: XX省XX市XX区街道具体地址`
1153
+ */
1154
+ ProxyAddress?: string
1137
1155
  }
1138
1156
 
1139
1157
  /**
@@ -1246,27 +1264,34 @@ export interface DownloadFlowInfo {
1246
1264
  }
1247
1265
 
1248
1266
  /**
1249
- * 签署人签署链接信息
1267
+ * 签署人签署链接信息。
1250
1268
  */
1251
1269
  export interface FlowApproverUrlInfo {
1252
1270
  /**
1253
- * 签署短链接,不支持小程序嵌入,只支持移动端浏览器打开。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
1271
+ * 签署短链接。</br>
1272
+ 注意:
1273
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1274
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1254
1275
  */
1255
- SignUrl: string
1276
+ SignUrl?: string
1256
1277
  /**
1257
- * 签署人类型 PERSON-个人
1278
+ * 签署人类型。
1279
+ - **PERSON**: 个人
1258
1280
  */
1259
- ApproverType: string
1281
+ ApproverType?: string
1260
1282
  /**
1261
- * 签署人姓名
1283
+ * 签署人姓名。
1262
1284
  */
1263
- Name: string
1285
+ Name?: string
1264
1286
  /**
1265
- * 签署人手机号
1287
+ * 签署人手机号。
1266
1288
  */
1267
- Mobile: string
1289
+ Mobile?: string
1268
1290
  /**
1269
- * 签署长链接,支持小程序嵌入。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
1291
+ * 签署长链接。</br>
1292
+ 注意:
1293
+ - 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
1294
+ - 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
1270
1295
  注意:此字段可能返回 null,表示取不到有效值。
1271
1296
  */
1272
1297
  LongUrl?: string
@@ -2140,12 +2165,18 @@ export interface StaffRole {
2140
2165
  export interface ChannelVerifyPdfRequest {
2141
2166
  /**
2142
2167
  * 合同流程ID,为32位字符串。
2143
- 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
2144
2168
  */
2145
2169
  FlowId: string
2146
2170
  /**
2147
- * 代理企业和员工的信息。
2148
- 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2171
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2172
+
2173
+ 此接口下面信息必填。
2174
+ <ul>
2175
+ <li>渠道应用标识: Agent.AppId</li>
2176
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2177
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2178
+ </ul>
2179
+ 第三方平台子客企业和员工必须已经经过实名认证
2149
2180
  */
2150
2181
  Agent?: Agent
2151
2182
  /**
@@ -2160,14 +2191,15 @@ export interface ChannelVerifyPdfRequest {
2160
2191
  */
2161
2192
  export interface CreateChannelFlowEvidenceReportRequest {
2162
2193
  /**
2163
- * 员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2194
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
2164
2195
 
2165
2196
  此接口下面信息必填。
2166
2197
  <ul>
2167
- <li>渠道应用标识: Agent.ProxyOrganizationOpenId</li>
2168
- <li>第三方平台子客企业标识: Agent. ProxyOperator.OpenId</li>
2169
- <li>第三方平台子客企业中的员工标识: Agent.AppId</li>
2198
+ <li>渠道应用标识: Agent.AppId</li>
2199
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
2200
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
2170
2201
  </ul>
2202
+ 第三方平台子客企业和员工必须已经经过实名认证
2171
2203
  */
2172
2204
  Agent: Agent
2173
2205
  /**
@@ -2358,17 +2390,12 @@ export interface ChannelVerifyPdfResponse {
2358
2390
  <ul><li>**1**:文件未被篡改,全部签名在腾讯电子签完成。</li>
2359
2391
  <li>**2**:文件未被篡改,部分签名在腾讯电子签完成。</li>
2360
2392
  <li>**3**:文件被篡改。</li>
2361
- <li>**4**:异常:文件内没有签名域。</li>
2393
+ <li>**4**:异常:文件内没有签名域。(如果合同还没有签署也会返回此代码)</li>
2362
2394
  <li>**5**:异常:文件签名格式错误。</li></ul>
2363
2395
  */
2364
2396
  VerifyResult?: number
2365
2397
  /**
2366
- * 验签结果详情,每个签名域对应的验签结果。状态值如下
2367
- <ul><li> **1** :验签成功,在电子签签署</li>
2368
- <li> **2** :验签成功,在其他平台签署</li>
2369
- <li> **3** :验签失败</li>
2370
- <li> **4** :pdf文件没有签名域</li>
2371
- <li> **5** :文件签名格式错误</li></ul>
2398
+ * 验签结果详情,所有签署区(包括签名区, 印章区, 日期签署区,骑缝章等)的签署验签结果
2372
2399
  */
2373
2400
  PdfVerifyResults?: Array<PdfVerifyResult>
2374
2401
  /**
@@ -2731,65 +2758,82 @@ export interface ChannelCreateUserAutoSignSealUrlRequest {
2731
2758
  }
2732
2759
 
2733
2760
  /**
2734
- * 合同文件验签单个结果结构体
2761
+ * 合同验签每个签署区的信息
2735
2762
  */
2736
2763
  export interface PdfVerifyResult {
2737
2764
  /**
2738
- * 验签结果。0-签名域未签名;1-验签成功; 3-验签失败;4-未找到签名域:文件内没有签名域;5-签名值格式不正确。
2765
+ * 验签结果详情,每个签名域对应的验签结果。状态值如下
2766
+ <ul><li> **1** :验签成功,在电子签签署</li>
2767
+ <li> **2** :验签成功,在其他平台签署</li>
2768
+ <li> **3** :验签失败</li>
2769
+ <li> **4** :pdf文件没有签名域</li>
2770
+ <li> **5** :文件签名格式错误</li></ul>
2739
2771
  */
2740
- VerifyResult: number
2772
+ VerifyResult?: number
2741
2773
  /**
2742
- * 签署平台,如果文件是在腾讯电子签平台签署,则返回腾讯电子签,如果文件不在腾讯电子签平台签署,则返回其他平台。
2774
+ * 签署平台
2775
+ 如果文件是在腾讯电子签平台签署,则为**腾讯电子签**,
2776
+ 如果文件不在腾讯电子签平台签署,则为**其他平台**。
2743
2777
  */
2744
- SignPlatform: string
2778
+ SignPlatform?: string
2745
2779
  /**
2746
- * 签署人名称
2780
+ * 申请证书的主体的名字
2781
+
2782
+ 如果是在腾讯电子签平台签署, 则对应的主体的名字个数如下
2783
+ **企业**: ESS@企业名称@平台生成的数字编码
2784
+ **个人**: ESS@个人姓名@证件号@平台生成的数字编码
2785
+
2786
+ 如果在其他平台签署的, 主体的名字参考其他平台的说明
2747
2787
  */
2748
- SignerName: string
2788
+ SignerName?: string
2749
2789
  /**
2750
- * 签署时间戳,单位秒
2790
+ * 签署时间的Unix时间戳,单位毫秒
2751
2791
  */
2752
- SignTime: number
2792
+ SignTime?: number
2753
2793
  /**
2754
- * 签名算法
2794
+ * 证书签名算法, 如SHA1withRSA等算法
2755
2795
  */
2756
- SignAlgorithm: string
2796
+ SignAlgorithm?: string
2757
2797
  /**
2758
- * 签名证书序列号
2798
+ * CA供应商下发给用户的证书编号
2799
+
2800
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下`。
2759
2801
  */
2760
- CertSn: string
2802
+ CertSn?: string
2761
2803
  /**
2762
- * 证书起始时间戳,单位秒
2804
+ * 证书起始时间的Unix时间戳,单位毫秒
2763
2805
  */
2764
- CertNotBefore: number
2806
+ CertNotBefore?: number
2765
2807
  /**
2766
- * 证书过期时间戳,单位秒
2808
+ * 证书过期时间的时间戳,单位毫秒
2767
2809
  */
2768
- CertNotAfter: number
2810
+ CertNotAfter?: number
2769
2811
  /**
2770
- * 签名类型
2812
+ * 签名类型, 保留字段, 现在全部为0
2813
+
2814
+
2771
2815
  */
2772
- SignType: number
2816
+ SignType?: number
2773
2817
  /**
2774
2818
  * 签名域横坐标,单位px
2775
2819
  */
2776
- ComponentPosX: number
2820
+ ComponentPosX?: number
2777
2821
  /**
2778
2822
  * 签名域纵坐标,单位px
2779
2823
  */
2780
- ComponentPosY: number
2824
+ ComponentPosY?: number
2781
2825
  /**
2782
2826
  * 签名域宽度,单位px
2783
2827
  */
2784
- ComponentWidth: number
2828
+ ComponentWidth?: number
2785
2829
  /**
2786
2830
  * 签名域高度,单位px
2787
2831
  */
2788
- ComponentHeight: number
2832
+ ComponentHeight?: number
2789
2833
  /**
2790
2834
  * 签名域所在页码,1~N
2791
2835
  */
2792
- ComponentPage: number
2836
+ ComponentPage?: number
2793
2837
  }
2794
2838
 
2795
2839
  /**
@@ -3636,14 +3680,16 @@ export interface ChannelDescribeEmployeesRequest {
3636
3680
  /**
3637
3681
  * 查询的关键字段,支持Key-Values查询。可选键值如下:
3638
3682
  <ul>
3639
- <li>Key:**"Status"**,根据实名状态查询员工,Values可选:
3640
- <ul><li>**["IsVerified"]**:查询已实名的员工</li><li>**["QuiteJob"]**:查询离职员工</li></ul></li>
3641
- <li>Key:**"StaffOpenId"**,根据第三方系统用户OpenId查询员工,Values为第三方系统用户OpenId列表:**["OpenId1","OpenId2",...]**</li>
3683
+ <li>Key:**"Status"**,Values: **["IsVerified"]**, 查询已实名的员工</li>
3684
+ <li>Key:**"Status"**,Values: **["QuiteJob"]**, 查询离职员工</li>
3685
+ <li>Key:**"StaffOpenId"**,Values: **["OpenId1","OpenId2",...]**, 根据第三方系统用户OpenId查询员工</li>
3642
3686
  </ul>
3687
+ 注: `同名字的Key的过滤条件会冲突, 只能填写一个`
3643
3688
  */
3644
3689
  Filters?: Array<Filter>
3645
3690
  /**
3646
- * 指定分页返回第几页的数据,如果不传默认返回第一页。页码从 0 开始,即首页为 0,最大20000。
3691
+ * 指定分页返回第几页的数据,如果不传默认返回第一页。
3692
+ 页码从 0 开始,即首页为 0,最大20000。
3647
3693
  */
3648
3694
  Offset?: number
3649
3695
  /**
@@ -4386,11 +4432,19 @@ export interface CreateFlowsByTemplatesResponse {
4386
4432
  */
4387
4433
  export interface DescribeChannelFlowEvidenceReportRequest {
4388
4434
  /**
4389
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
4435
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
4436
+
4437
+ 此接口下面信息必填。
4438
+ <ul>
4439
+ <li>渠道应用标识: Agent.AppId</li>
4440
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
4441
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
4442
+ </ul>
4443
+ 第三方平台子客企业和员工必须已经经过实名认证
4390
4444
  */
4391
4445
  Agent: Agent
4392
4446
  /**
4393
- * 出证报告编号
4447
+ * 签署报告编号, 由<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>产生
4394
4448
  */
4395
4449
  ReportId: string
4396
4450
  /**
@@ -5045,7 +5099,7 @@ export interface ProxyOrganizationOperator {
5045
5099
  * 签署方经办人的证件类型,支持以下类型
5046
5100
  <ul><li>ID_CARD : 居民身份证 (默认值)</li>
5047
5101
  <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
5048
- <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li>
5102
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
5049
5103
 
5050
5104
  */
5051
5105
  IdCardType?: string
@@ -5438,7 +5492,7 @@ export interface ChannelModifyRoleRequest {
5438
5492
  */
5439
5493
  Description?: string
5440
5494
  /**
5441
- * 权限树,权限树内容 PermissionGroups 可参考接口 DescribeIntegrationRoles 的输出
5495
+ * 权限树,权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles的输出
5442
5496
  */
5443
5497
  PermissionGroups?: Array<PermissionGroup>
5444
5498
  }
@@ -6125,16 +6179,16 @@ export interface ChannelCreateReleaseFlowResponse {
6125
6179
  */
6126
6180
  export interface DescribeChannelFlowEvidenceReportResponse {
6127
6181
  /**
6128
- * 出证报告下载 URL
6182
+ * 出证报告PDF的下载 URL,有效期为5分钟,超过有效期后将无法再下载。
6129
6183
  注意:此字段可能返回 null,表示取不到有效值。
6130
6184
  */
6131
6185
  ReportUrl?: string
6132
6186
  /**
6133
- * 出征任务的执行状态,状态列表如下
6187
+ * 出证任务执行的状态, 状态含义如下:
6134
6188
 
6135
- - EvidenceStatusExecuting : 出征任务正在执行中
6136
- - EvidenceStatusSuccess : 出征任务执行成功
6137
- - EvidenceStatusFailed : 出征任务执行失败
6189
+ <ul><li>**EvidenceStatusExecuting**: 出证任务在执行中</li>
6190
+ <li>**EvidenceStatusSuccess**: 出证任务执行成功</li>
6191
+ <li>**EvidenceStatusFailed** 出征任务执行失败</li></ul>
6138
6192
  */
6139
6193
  Status?: string
6140
6194
  /**
@@ -6265,15 +6319,28 @@ export interface ChannelUpdateSealStatusResponse {
6265
6319
  */
6266
6320
  export interface ChannelCreateFlowSignUrlRequest {
6267
6321
  /**
6268
- * 应用相关信息。 此接口Agent.ProxyOrganizationOpenId、Agent. ProxyOperator.OpenId、Agent.AppId 必填
6322
+ * 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6323
+
6324
+ 此接口下面信息必填。
6325
+ <ul>
6326
+ <li>渠道应用标识: Agent.AppId</li>
6327
+ <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
6328
+ <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
6329
+ </ul>
6330
+ 第三方平台子客企业和员工必须已经经过实名认证
6269
6331
  */
6270
6332
  Agent: Agent
6271
6333
  /**
6272
- * 流程编号
6334
+ * 合同流程ID,为32位字符串。
6335
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
6336
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
6273
6337
  */
6274
6338
  FlowId: string
6275
6339
  /**
6276
- * 流程签署人,其中Name和Mobile必传,其他可不传,ApproverType目前只支持PERSON类型的签署人,如果不传默认为该值。还需注意签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
6340
+ * 流程签署人列表,其中结构体的Name,Mobile和ApproverType必传,其他可不传。
6341
+ 注:
6342
+ `1. ApproverType目前只支持个人(PERSON)类型的签署人。`
6343
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
6277
6344
  */
6278
6345
  FlowApproverInfos: Array<FlowApproverInfo>
6279
6346
  /**
@@ -6287,7 +6354,7 @@ export interface ChannelCreateFlowSignUrlRequest {
6287
6354
  */
6288
6355
  Organization?: OrganizationInfo
6289
6356
  /**
6290
- * 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
6357
+ * 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
6291
6358
  */
6292
6359
  JumpUrl?: string
6293
6360
  }
@@ -306,6 +306,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
306
306
  - 发起方和签署方的填写控件 Components
307
307
  - 签署方的签署控件 SignComponents
308
308
 
309
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
310
+
309
311
  **适用场景**
310
312
  该接口常用来配合<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>接口,作为创建合同的前置接口使用。
311
313
  通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
@@ -422,12 +424,13 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
422
424
  * 提交申请出证报告任务并返回报告ID。
423
425
 
424
426
  注意:
425
- <ul><li>使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。</li>
426
- <li>操作人必须是`发起方或者签署方企业的(非走授权书认证)法人或者超管`。</li>
427
- <li>合同流程必须所有参与方`已经签署完成`。</li>
428
- <li>出证过程需一定时间,建议在`提交出证任务后的24小时之后`,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。</li></ul>
427
+ - 使用此功能**需搭配出证套餐** ,使用前请联系对接的客户经理沟通。
428
+ - 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
429
+ - 合同流程必须**所有参与方已经签署完成**。
430
+ - 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL
431
+
429
432
 
430
- <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>
433
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
431
434
  */
432
435
  CreateChannelFlowEvidenceReport(req: CreateChannelFlowEvidenceReportRequest, cb?: (error: string, rep: CreateChannelFlowEvidenceReportResponse) => void): Promise<CreateChannelFlowEvidenceReportResponse>;
433
436
  /**
@@ -475,10 +478,14 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
475
478
  */
476
479
  ChannelCreateWebThemeConfig(req: ChannelCreateWebThemeConfigRequest, cb?: (error: string, rep: ChannelCreateWebThemeConfigResponse) => void): Promise<ChannelCreateWebThemeConfigResponse>;
477
480
  /**
478
- * 该接口用于发起合同后,生成C端签署人的签署链接<br/>
479
- 注意:该接口目前签署人类型仅支持个人签署方(PERSON)<br/>
480
- 注意:该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件<br/>
481
- 注意:该接口返回的签署链接是用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。微信小程序请使用小程序跳转或半屏弹窗的方式<br/>
481
+ * 该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
482
+
483
+ `注意:`<br/>
484
+ `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
485
+ `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
486
+ `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
487
+ `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
488
+ 跳转到小程序的实现,参考微信官方文档(分为<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>
482
489
  */
483
490
  ChannelCreateFlowSignUrl(req: ChannelCreateFlowSignUrlRequest, cb?: (error: string, rep: ChannelCreateFlowSignUrlResponse) => void): Promise<ChannelCreateFlowSignUrlResponse>;
484
491
  /**
@@ -495,8 +502,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
495
502
  */
496
503
  ChannelCreateReleaseFlow(req: ChannelCreateReleaseFlowRequest, cb?: (error: string, rep: ChannelCreateReleaseFlowResponse) => void): Promise<ChannelCreateReleaseFlowResponse>;
497
504
  /**
498
- * 用于分页查询企业员工信息列表,支持设置过滤条件以筛选员工查询结果。
499
- */
505
+ * 获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息,支持设置过滤条件以筛选员工查询结果。
506
+
507
+ **注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
508
+ */
500
509
  ChannelDescribeEmployees(req: ChannelDescribeEmployeesRequest, cb?: (error: string, rep: ChannelDescribeEmployeesResponse) => void): Promise<ChannelDescribeEmployeesResponse>;
501
510
  /**
502
511
  * 通过合同编号批量撤销合同,单次最多支持撤销100份合同。
@@ -594,9 +603,20 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
594
603
  */
595
604
  ChannelCreateFlowReminds(req: ChannelCreateFlowRemindsRequest, cb?: (error: string, rep: ChannelCreateFlowRemindsResponse) => void): Promise<ChannelCreateFlowRemindsResponse>;
596
605
  /**
597
- * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称,企业营业执照,企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。注意:
598
- 1. 需要在子客企业激活前调用该接口,如果您的企业已经提交企业信息或者企业已经激活,同步的企业信息将不会生效。
599
- 2. 如果您同时传递了营业执照信息和企业名称等信息,在认证过程中将以营业执照中的企业信息为准,请注意企业信息需要和营业执照信息对应。
606
+ * 此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。
607
+
608
+ 注意:
609
+
610
+ - **需要在<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>前同步的企业信息**, 否则会出现信息同步没有用的情形
611
+ - **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题
612
+
613
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/7ec91b79a0a4860e77c9ff9f4a5f13ad/channel_SyncProxyOrganization2.png)
614
+
615
+
616
+ - **企业统一社会信用代码**: 对应上图中的**1**
617
+ - **第三方平台子客企业名称**: 对应上图中的**2**
618
+ - **企业法定代表人的名字**:对应上图中的**3**
619
+ - **企业详细住所**:对应上图中的**4**
600
620
  */
601
621
  SyncProxyOrganization(req: SyncProxyOrganizationRequest, cb?: (error: string, rep: SyncProxyOrganizationResponse) => void): Promise<SyncProxyOrganizationResponse>;
602
622
  /**
@@ -701,7 +721,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
701
721
  /**
702
722
  * 此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
703
723
 
704
- - **新增员工的的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
724
+ - **新增员工的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
705
725
 
706
726
  - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
707
727
 
@@ -710,12 +730,19 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
710
730
  **注**:
711
731
  - 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
712
732
  - <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
713
- - 新增员工的的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
733
+ - 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
714
734
  */
715
735
  SyncProxyOrganizationOperators(req: SyncProxyOrganizationOperatorsRequest, cb?: (error: string, rep: SyncProxyOrganizationOperatorsResponse) => void): Promise<SyncProxyOrganizationOperatorsResponse>;
716
736
  /**
717
- * 查询出证报告,返回报告 URL。
718
- */
737
+ * 获取出证报告任务执行结果,返回报告 URL。
738
+
739
+ 注意:
740
+
741
+ - 使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
742
+ - 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
743
+
744
+ ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
745
+ */
719
746
  DescribeChannelFlowEvidenceReport(req: DescribeChannelFlowEvidenceReportRequest, cb?: (error: string, rep: DescribeChannelFlowEvidenceReportResponse) => void): Promise<DescribeChannelFlowEvidenceReportResponse>;
720
747
  /**
721
748
  * 此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。