tencentcloud-sdk-nodejs 4.0.726 → 4.0.728

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.
Files changed (60) hide show
  1. package/CHANGELOG.md +455 -0
  2. package/SERVICE_CHANGELOG.md +367 -82
  3. package/package.json +1 -1
  4. package/products.md +16 -16
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/as/v20180419/as_client.ts +1 -0
  7. package/src/services/as/v20180419/as_models.ts +60 -31
  8. package/src/services/cfg/v20210820/cfg_models.ts +30 -7
  9. package/src/services/cfs/v20190719/cfs_client.ts +3 -2
  10. package/src/services/cfs/v20190719/cfs_models.ts +3 -2
  11. package/src/services/cls/v20201016/cls_models.ts +11 -8
  12. package/src/services/drm/v20181115/drm_client.ts +12 -0
  13. package/src/services/drm/v20181115/drm_models.ts +40 -0
  14. package/src/services/ess/v20201111/ess_client.ts +12 -10
  15. package/src/services/ess/v20201111/ess_models.ts +53 -58
  16. package/src/services/essbasic/v20210526/essbasic_client.ts +72 -24
  17. package/src/services/essbasic/v20210526/essbasic_models.ts +329 -140
  18. package/src/services/faceid/v20180301/faceid_models.ts +38 -38
  19. package/src/services/live/v20180801/live_models.ts +23 -23
  20. package/src/services/ocr/v20181119/ocr_client.ts +10 -7
  21. package/src/services/ocr/v20181119/ocr_models.ts +403 -129
  22. package/src/services/vm/v20210922/vm_client.ts +43 -9
  23. package/src/services/vm/v20210922/vm_models.ts +84 -37
  24. package/src/services/wedata/v20210820/wedata_client.ts +3 -3
  25. package/src/services/wedata/v20210820/wedata_models.ts +13 -13
  26. package/src/services/weilingwith/v20230427/weilingwith_client.ts +652 -24
  27. package/src/services/weilingwith/v20230427/weilingwith_models.ts +1031 -30
  28. package/tencentcloud/common/sdk_version.d.ts +1 -1
  29. package/tencentcloud/common/sdk_version.js +1 -1
  30. package/tencentcloud/services/as/v20180419/as_models.d.ts +59 -31
  31. package/tencentcloud/services/cfg/v20210820/cfg_models.d.ts +30 -7
  32. package/tencentcloud/services/cfs/v20190719/cfs_client.d.ts +1 -0
  33. package/tencentcloud/services/cfs/v20190719/cfs_client.js +1 -0
  34. package/tencentcloud/services/cfs/v20190719/cfs_models.d.ts +3 -2
  35. package/tencentcloud/services/cls/v20201016/cls_models.d.ts +11 -8
  36. package/tencentcloud/services/drm/v20181115/drm_client.d.ts +5 -1
  37. package/tencentcloud/services/drm/v20181115/drm_client.js +6 -0
  38. package/tencentcloud/services/drm/v20181115/drm_models.d.ts +38 -0
  39. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +12 -10
  40. package/tencentcloud/services/ess/v20201111/ess_client.js +12 -10
  41. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +53 -58
  42. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +58 -19
  43. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +59 -18
  44. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +323 -137
  45. package/tencentcloud/services/faceid/v20180301/faceid_models.d.ts +38 -38
  46. package/tencentcloud/services/live/v20180801/live_models.d.ts +23 -23
  47. package/tencentcloud/services/ocr/v20181119/ocr_client.d.ts +1 -1
  48. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +399 -128
  49. package/tencentcloud/services/vm/v20210922/vm_client.d.ts +41 -8
  50. package/tencentcloud/services/vm/v20210922/vm_client.js +41 -8
  51. package/tencentcloud/services/vm/v20210922/vm_models.d.ts +83 -37
  52. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +3 -3
  53. package/tencentcloud/services/wedata/v20210820/wedata_client.js +3 -3
  54. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +13 -13
  55. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.d.ts +215 -7
  56. package/tencentcloud/services/weilingwith/v20230427/weilingwith_client.js +321 -9
  57. package/tencentcloud/services/weilingwith/v20230427/weilingwith_models.d.ts +921 -28
  58. package/test/drm.v20181115.test.js +10 -0
  59. package/test/essbasic.v20210526.test.js +10 -0
  60. package/test/weilingwith.v20230427.test.js +526 -6
@@ -17,89 +17,82 @@ export interface DescribePersonCertificateResponse {
17
17
  export interface BillUsageDetail {
18
18
  /**
19
19
  * 合同流程ID,为32位字符串。
20
- 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
21
20
  可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
22
- 注意:此字段可能返回 null,表示取不到有效值。
23
21
  */
24
22
  FlowId?: string;
25
23
  /**
26
24
  * 合同经办人名称
27
25
  如果有多个经办人用分号隔开。
28
- 注意:此字段可能返回 null,表示取不到有效值。
29
26
  */
30
27
  OperatorName?: string;
31
28
  /**
32
29
  * 发起方组织机构名称
33
- 注意:此字段可能返回 null,表示取不到有效值。
34
30
  */
35
31
  CreateOrganizationName?: string;
36
32
  /**
37
- * 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
38
- 该名称还将用于合同签署完成后的下载文件名。
39
- 注意:此字段可能返回 null,表示取不到有效值。
33
+ * 合同流程的名称。
40
34
  */
41
35
  FlowName?: string;
42
36
  /**
43
37
  * 当前合同状态,如下是状态码对应的状态。
44
- 0-还没有发起
45
- 1-等待签署
46
- 2-部分签署
47
- 3-拒签
48
- 4-已签署
49
- 5-已过期
50
- 6-已撤销
51
- 7-还没有预发起
52
- 8-等待填写
53
- 9-部分填写
54
- 10-拒填
55
- 11-已解除
56
- 注意:此字段可能返回 null,表示取不到有效值。
38
+ <ul>
39
+ <li>**0**: 还没有发起</li>
40
+ <li>**1**: 等待签署</li>
41
+ <li>**2**: 部分签署 </li>
42
+ <li>**3**: 拒签</li>
43
+ <li>**4**: 已签署 </li>
44
+ <li>**5**: 已过期 </li>
45
+ <li>**6**: 已撤销 </li>
46
+ <li>**7**: 还没有预发起</li>
47
+ <li>**8**: 等待填写</li>
48
+ <li>**9**: 部分填写 </li>
49
+ <li>**10**: 拒填</li>
50
+ <li>**11**: 已解除</li>
51
+ </ul>
57
52
  */
58
53
  Status?: number;
59
54
  /**
60
- * 套餐类型
61
- 对应关系如下
62
- CloudEnterprise-企业版合同
63
- SingleSignature-单方签章
64
- CloudProve-签署报告
65
- CloudOnlineSign-腾讯会议在线签约
66
- ChannelWeCard-微工卡
67
- SignFlow-合同套餐
68
- SignFace-签署意愿(人脸识别)
69
- SignPassword-签署意愿(密码)
70
- SignSMS-签署意愿(短信)
71
- PersonalEssAuth-签署人实名(腾讯电子签认证)
72
- PersonalThirdAuth-签署人实名(信任第三方认证)
73
- OrgEssAuth-签署企业实名
74
- FlowNotify-短信通知
75
- AuthService-企业工商信息查询
76
- 注意:此字段可能返回 null,表示取不到有效值。
55
+ * 查询的套餐类型
56
+ 对应关系如下:
57
+ <ul>
58
+ <li>**CloudEnterprise**: 企业版合同</li>
59
+ <li>**SingleSignature**: 单方签章</li>
60
+ <li>**CloudProve**: 签署报告</li>
61
+ <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
62
+ <li>**ChannelWeCard**: 微工卡</li>
63
+ <li>**SignFlow**: 合同套餐</li>
64
+ <li>**SignFace**: 签署意愿(人脸识别)</li>
65
+ <li>**SignPassword**: 签署意愿(密码)</li>
66
+ <li>**SignSMS**: 签署意愿(短信)</li>
67
+ <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
68
+ <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
69
+ <li>**OrgEssAuth**: 签署企业实名</li>
70
+ <li>**FlowNotify**: 短信通知</li>
71
+ <li>**AuthService**: 企业工商信息查询</li>
72
+ </ul>
77
73
  */
78
74
  QuotaType?: string;
79
75
  /**
80
76
  * 合同使用量
81
- 注意:此字段可能返回 null,表示取不到有效值。
77
+ 注: `如果消耗类型是撤销返还,此值为负值代表返还的合同数量`
82
78
  */
83
79
  UseCount?: number;
84
80
  /**
85
81
  * 消耗的时间戳,格式为Unix标准时间戳(秒)。
86
- 注意:此字段可能返回 null,表示取不到有效值。
87
82
  */
88
83
  CostTime?: number;
89
84
  /**
90
85
  * 消耗的套餐名称
91
- 注意:此字段可能返回 null,表示取不到有效值。
92
86
  */
93
87
  QuotaName?: string;
94
88
  /**
95
89
  * 消耗类型
96
- 1.扣费 2.撤销返还
97
- 注意:此字段可能返回 null,表示取不到有效值。
90
+ **1**.扣费
91
+ **2**.撤销返还
98
92
  */
99
93
  CostType?: number;
100
94
  /**
101
95
  * 备注
102
- 注意:此字段可能返回 null,表示取不到有效值。
103
96
  */
104
97
  Remark?: string;
105
98
  }
@@ -6251,21 +6244,23 @@ export interface DescribeBillUsageDetailRequest {
6251
6244
  Limit?: number;
6252
6245
  /**
6253
6246
  * 查询的套餐类型 (选填 )不传则查询所有套餐;
6254
- 对应关系如下
6255
- CloudEnterprise-企业版合同
6256
- SingleSignature-单方签章
6257
- CloudProve-签署报告
6258
- CloudOnlineSign-腾讯会议在线签约
6259
- ChannelWeCard-微工卡
6260
- SignFlow-合同套餐
6261
- SignFace-签署意愿(人脸识别)
6262
- SignPassword-签署意愿(密码)
6263
- SignSMS-签署意愿(短信)
6264
- PersonalEssAuth-签署人实名(腾讯电子签认证)
6265
- PersonalThirdAuth-签署人实名(信任第三方认证)
6266
- OrgEssAuth-签署企业实名
6267
- FlowNotify-短信通知
6268
- AuthService-企业工商信息查询
6247
+ 目前支持:
6248
+ <ul>
6249
+ <li>**CloudEnterprise**: 企业版合同</li>
6250
+ <li>**SingleSignature**: 单方签章</li>
6251
+ <li>**CloudProve**: 签署报告</li>
6252
+ <li>**CloudOnlineSign**: 腾讯会议在线签约</li>
6253
+ <li>**ChannelWeCard**: 微工卡</li>
6254
+ <li>**SignFlow**: 合同套餐</li>
6255
+ <li>**SignFace**: 签署意愿(人脸识别)</li>
6256
+ <li>**SignPassword**: 签署意愿(密码)</li>
6257
+ <li>**SignSMS**: 签署意愿(短信)</li>
6258
+ <li>**PersonalEssAuth**: 签署人实名(腾讯电子签认证)</li>
6259
+ <li>**PersonalThirdAuth**: 签署人实名(信任第三方认证)</li>
6260
+ <li>**OrgEssAuth**: 签署企业实名</li>
6261
+ <li>**FlowNotify**: 短信通知</li>
6262
+ <li>**AuthService**: 企业工商信息查询</li>
6263
+ </ul>
6269
6264
  */
6270
6265
  QuotaType?: string;
6271
6266
  /**
@@ -1,6 +1,6 @@
1
1
  import { AbstractClient } from "../../../common/abstract_client";
2
2
  import { ClientConfig } from "../../../common/interface";
3
- import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeTemplatesRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, ChannelCreateBatchQuickSignUrlResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, ChannelCancelFlowRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelCreateFlowApproversRequest, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelDescribeUserAutoSignStatusResponse, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
3
+ import { SyncProxyOrganizationResponse, ChannelCreateConvertTaskApiResponse, ChannelCreateFlowRemindsResponse, ChannelDeleteSealPoliciesRequest, ChannelBatchCancelFlowsResponse, ChannelDisableUserAutoSignResponse, ChannelCreateFlowGroupByTemplatesResponse, ChannelCreateFlowSignReviewRequest, DescribeFlowDetailInfoRequest, ChannelCancelUserAutoSignEnableUrlResponse, ModifyExtendedServiceRequest, DescribeResourceUrlsByFlowsRequest, CreateChannelOrganizationInfoChangeUrlResponse, ChannelCreateFlowSignUrlResponse, ChannelCreateBatchSignUrlResponse, ChannelCreatePrepareFlowResponse, OperateChannelTemplateResponse, ChannelCreateRoleRequest, CreateConsoleLoginUrlResponse, ChannelDeleteRoleUsersRequest, ChannelCreateUserRolesResponse, SyncProxyOrganizationRequest, ChannelCreatePrepareFlowRequest, ChannelCreateFlowRemindsRequest, ChannelCreateSealPolicyResponse, ChannelCancelFlowResponse, ChannelCreateWebThemeConfigRequest, ChannelCreateConvertTaskApiRequest, ChannelCreateFlowByFilesRequest, UploadFilesResponse, ChannelCreatePreparedPersonalEsignResponse, DescribeResourceUrlsByFlowsResponse, ChannelCreateFlowGroupByFilesRequest, ChannelCreateOrganizationModifyQrCodeRequest, ChannelCreateFlowByFilesResponse, DescribeFlowDetailInfoResponse, ChannelDescribeRolesRequest, PrepareFlowsResponse, ChannelCancelFlowRequest, ChannelCreateOrganizationBatchSignUrlRequest, GetDownloadFlowUrlResponse, DescribeTemplatesResponse, ChannelVerifyPdfRequest, CreateChannelFlowEvidenceReportRequest, ChannelDescribeBillUsageDetailRequest, ChannelCancelUserAutoSignEnableUrlRequest, DescribeTemplatesRequest, ChannelVerifyPdfResponse, CreateConsoleLoginUrlRequest, ChannelCreateUserAutoSignSealUrlRequest, ChannelCreateUserAutoSignEnableUrlRequest, ChannelCancelMultiFlowSignQRCodeRequest, ChannelDescribeOrganizationSealsRequest, DescribeUsageRequest, DescribeExtendedServiceAuthInfoRequest, ChannelCreateBoundFlowsResponse, ChannelCreateUserAutoSignSealUrlResponse, ChannelCreateBatchQuickSignUrlRequest, ChannelCreateBoundFlowsRequest, ChannelDescribeEmployeesRequest, ChannelDeleteRoleUsersResponse, SyncProxyOrganizationOperatorsRequest, ChannelCreateFlowApproversResponse, DescribeBillUsageDetailResponse, CreateSignUrlsRequest, ChannelCreateMultiFlowSignQRCodeRequest, ChannelCreateUserAutoSignEnableUrlResponse, ChannelGetTaskResultApiRequest, ChannelCreatePreparedPersonalEsignRequest, ChannelDescribeBillUsageDetailResponse, CreateFlowsByTemplatesResponse, DescribeChannelFlowEvidenceReportRequest, ChannelCreateRoleResponse, SyncProxyOrganizationOperatorsResponse, ChannelDescribeUserAutoSignStatusRequest, ChannelModifyRoleResponse, CreateSignUrlsResponse, ChannelDeleteRoleRequest, ChannelCreateBatchQuickSignUrlResponse, ChannelCreateBatchCancelFlowUrlRequest, PrepareFlowsRequest, ChannelCreateFlowSignReviewResponse, ChannelDisableUserAutoSignRequest, ChannelDescribeOrganizationSealsResponse, CreateSealByImageResponse, ChannelCancelMultiFlowSignQRCodeResponse, ChannelDescribeRolesResponse, ChannelCreateReleaseFlowRequest, ChannelDescribeFlowComponentsResponse, ChannelCreateFlowGroupByFilesResponse, ChannelCreateMultiFlowSignQRCodeResponse, ChannelDescribeUserAutoSignStatusResponse, ModifyExtendedServiceResponse, ChannelCreateUserRolesRequest, ChannelGetTaskResultApiResponse, ChannelCreateBatchSignUrlRequest, ChannelCreateOrganizationModifyQrCodeResponse, ChannelDeleteSealPoliciesResponse, ChannelCreateWebThemeConfigResponse, GetDownloadFlowUrlRequest, ChannelCreateEmbedWebUrlResponse, ChannelBatchCancelFlowsRequest, CreateChannelOrganizationInfoChangeUrlRequest, ChannelModifyRoleRequest, ChannelUpdateSealStatusRequest, ChannelCreateFlowGroupByTemplatesRequest, DescribeBillUsageDetailRequest, ChannelCreateSealPolicyRequest, CreateFlowsByTemplatesRequest, UploadFilesRequest, DescribeUsageResponse, ChannelCreateOrganizationBatchSignUrlResponse, ChannelCreateBatchCancelFlowUrlResponse, OperateChannelTemplateRequest, CreateChannelFlowEvidenceReportResponse, ChannelDescribeEmployeesResponse, ChannelDeleteRoleResponse, ChannelCreateReleaseFlowResponse, DescribeChannelFlowEvidenceReportResponse, CreateSealByImageRequest, ChannelCreateFlowApproversRequest, ChannelUpdateSealStatusResponse, ChannelCreateFlowSignUrlRequest, DescribeExtendedServiceAuthInfoResponse, ChannelCreateEmbedWebUrlRequest, ChannelDescribeFlowComponentsRequest } from "./essbasic_models";
4
4
  /**
5
5
  * essbasic client
6
6
  * @class
@@ -51,21 +51,21 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
51
51
  ModifyExtendedService(req: ModifyExtendedServiceRequest, cb?: (error: string, rep: ModifyExtendedServiceResponse) => void): Promise<ModifyExtendedServiceResponse>;
52
52
  /**
53
53
  * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
54
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
55
- 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
56
54
 
57
- **本接口适用于发起方没有填写控件的 B2C或者单C模板**
55
+ **适用场景**:
56
+ 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
58
57
 
59
- **若是B2C模板,还要满足以下任意一个条件**
60
-
61
- - 模板中配置的签署顺序是无序
62
- - B端企业的签署方式是静默签署
63
- - B端企业是非首位签署
64
-
65
- 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
58
+ **注意**:
59
+ 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
60
+ - 模板中配置的签署顺序是无序
61
+ - B端企业的签署方式是静默签署
62
+ - B端企业是非首位签署
63
+ 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
66
64
  ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
65
+ 3. 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
67
66
 
68
- 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
67
+ 二维码的样式如下图:
68
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
69
69
  */
70
70
  ChannelCreateMultiFlowSignQRCode(req: ChannelCreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCreateMultiFlowSignQRCodeResponse) => void): Promise<ChannelCreateMultiFlowSignQRCodeResponse>;
71
71
  /**
@@ -180,8 +180,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
180
180
  */
181
181
  ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
182
182
  /**
183
- * 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
184
- 注: 此接口每日限频50次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
183
+ * 此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。
184
+
185
+ 注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
185
186
  */
186
187
  DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
187
188
  /**
@@ -319,6 +320,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
319
320
  ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
320
321
 
321
322
  模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
323
+
322
324
  ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
323
325
 
324
326
 
@@ -455,7 +457,25 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
455
457
  */
456
458
  ChannelCreateBatchSignUrl(req: ChannelCreateBatchSignUrlRequest, cb?: (error: string, rep: ChannelCreateBatchSignUrlResponse) => void): Promise<ChannelCreateBatchSignUrlResponse>;
457
459
  /**
458
- * 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
460
+ * 此接口(ChannelCreateBoundFlows)用于子客企业领取未归属给员工的合同,将合同领取给当前员工,合同不能重复领取。
461
+
462
+
463
+ **未归属合同发起方式**
464
+ 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下
465
+ ```
466
+ FlowApprovers: []*essbasic.FlowApproverInfo{
467
+ {
468
+ ApproverType: common.StringPtr("ORGANIZATION"),
469
+ OrganizationOpenId: common.StringPtr("org_dianziqian"),
470
+ OrganizationName: common.StringPtr("典子谦示例企业"),
471
+ }
472
+ },
473
+ ```
474
+
475
+ 可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
476
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
477
+
478
+ 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
459
479
  */
460
480
  ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
461
481
  /**
@@ -539,8 +559,8 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
539
559
 
540
560
  注:
541
561
  <ul>
542
- <li>仅支持下载 **本企业** 下合同,链接会 **登录企业控制台** </li>
543
- <li> **链接仅可使用一次**,不可重复使用</li>
562
+ <li>仅支持下载 <b>本企业</b> 下合同,链接会 <b>登录企业控制台</b> </li>
563
+ <li> <b>链接仅可使用一次</b>,不可重复使用</li>
544
564
  </ul>
545
565
  */
546
566
  GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
@@ -605,7 +625,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
605
625
  1. 合同中当前状态为 **待签署** 的签署人是催办的对象
606
626
  2. **每个合同只能催办一次**
607
627
 
608
- **催办的效果**: 对方会受到如下的短信通知
628
+ **催办的效果**: 对方会收到如下的短信通知
629
+
609
630
  ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
610
631
 
611
632
 
@@ -861,6 +882,10 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
861
882
  注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
862
883
  */
863
884
  DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
885
+ /**
886
+ * 通过此接口(ChannelDescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
887
+ */
888
+ ChannelDescribeBillUsageDetail(req: ChannelDescribeBillUsageDetailRequest, cb?: (error: string, rep: ChannelDescribeBillUsageDetailResponse) => void): Promise<ChannelDescribeBillUsageDetailResponse>;
864
889
  /**
865
890
  * 获取个人用户自动签的开通链接。
866
891
 
@@ -868,7 +893,21 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
868
893
  */
869
894
  ChannelCreateUserAutoSignEnableUrl(req: ChannelCreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: ChannelCreateUserAutoSignEnableUrlResponse) => void): Promise<ChannelCreateUserAutoSignEnableUrlResponse>;
870
895
  /**
871
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
896
+ * 用于获取合同中填写控件填写状态和填写的内容。
897
+
898
+ **注意**: `附件控件不会出现在结果列表中`
899
+
900
+
901
+ **授权**:
902
+ 此接口需要授权, 有两种开通权限的途径
903
+
904
+ **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
905
+ 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
906
+
907
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
908
+
909
+ **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
910
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
872
911
  */
873
912
  ChannelDescribeFlowComponents(req: ChannelDescribeFlowComponentsRequest, cb?: (error: string, rep: ChannelDescribeFlowComponentsResponse) => void): Promise<ChannelDescribeFlowComponentsResponse>;
874
913
  }
@@ -77,21 +77,21 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
77
77
  }
78
78
  /**
79
79
  * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
80
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
81
- 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
82
80
 
83
- **本接口适用于发起方没有填写控件的 B2C或者单C模板**
81
+ **适用场景**:
82
+ 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
84
83
 
85
- **若是B2C模板,还要满足以下任意一个条件**
86
-
87
- - 模板中配置的签署顺序是无序
88
- - B端企业的签署方式是静默签署
89
- - B端企业是非首位签署
90
-
91
- 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
84
+ **注意**:
85
+ 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
86
+ - 模板中配置的签署顺序是无序
87
+ - B端企业的签署方式是静默签署
88
+ - B端企业是非首位签署
89
+ 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
92
90
  ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
91
+ 3. 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
93
92
 
94
- 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](https://qian.tencent.com/developers/partner/callback_types_commons#%E7%AD%BE%E7%BD%B2%E4%BA%8C%E7%BB%B4%E7%A0%81%E7%9B%B8%E5%85%B3%E5%9B%9E%E8%B0%83)
93
+ 二维码的样式如下图:
94
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
95
95
  */
96
96
  async ChannelCreateMultiFlowSignQRCode(req, cb) {
97
97
  return this.request("ChannelCreateMultiFlowSignQRCode", req, cb);
@@ -222,8 +222,9 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
222
222
  return this.request("ChannelCreateConvertTaskApi", req, cb);
223
223
  }
224
224
  /**
225
- * 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
226
- 注: 此接口每日限频50次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
225
+ * 此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。
226
+
227
+ 注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
227
228
  */
228
229
  async DescribeUsage(req, cb) {
229
230
  return this.request("DescribeUsage", req, cb);
@@ -379,6 +380,7 @@ https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchAp
379
380
  ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
380
381
 
381
382
  模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
383
+
382
384
  ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
383
385
 
384
386
 
@@ -537,7 +539,25 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
537
539
  return this.request("ChannelCreateBatchSignUrl", req, cb);
538
540
  }
539
541
  /**
540
- * 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
542
+ * 此接口(ChannelCreateBoundFlows)用于子客企业领取未归属给员工的合同,将合同领取给当前员工,合同不能重复领取。
543
+
544
+
545
+ **未归属合同发起方式**
546
+ 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下
547
+ ```
548
+ FlowApprovers: []*essbasic.FlowApproverInfo{
549
+ {
550
+ ApproverType: common.StringPtr("ORGANIZATION"),
551
+ OrganizationOpenId: common.StringPtr("org_dianziqian"),
552
+ OrganizationName: common.StringPtr("典子谦示例企业"),
553
+ }
554
+ },
555
+ ```
556
+
557
+ 可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
558
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
559
+
560
+ 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
541
561
  */
542
562
  async ChannelCreateBoundFlows(req, cb) {
543
563
  return this.request("ChannelCreateBoundFlows", req, cb);
@@ -641,8 +661,8 @@ Web链接访问后,会根据子客企业(**Agent中ProxyOrganizationOpenId表
641
661
 
642
662
  注:
643
663
  <ul>
644
- <li>仅支持下载 **本企业** 下合同,链接会 **登录企业控制台** </li>
645
- <li> **链接仅可使用一次**,不可重复使用</li>
664
+ <li>仅支持下载 <b>本企业</b> 下合同,链接会 <b>登录企业控制台</b> </li>
665
+ <li> <b>链接仅可使用一次</b>,不可重复使用</li>
646
666
  </ul>
647
667
  */
648
668
  async GetDownloadFlowUrl(req, cb) {
@@ -721,7 +741,8 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
721
741
  1. 合同中当前状态为 **待签署** 的签署人是催办的对象
722
742
  2. **每个合同只能催办一次**
723
743
 
724
- **催办的效果**: 对方会受到如下的短信通知
744
+ **催办的效果**: 对方会收到如下的短信通知
745
+
725
746
  ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
726
747
 
727
748
 
@@ -1001,6 +1022,12 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1001
1022
  async DescribeFlowDetailInfo(req, cb) {
1002
1023
  return this.request("DescribeFlowDetailInfo", req, cb);
1003
1024
  }
1025
+ /**
1026
+ * 通过此接口(ChannelDescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1027
+ */
1028
+ async ChannelDescribeBillUsageDetail(req, cb) {
1029
+ return this.request("ChannelDescribeBillUsageDetail", req, cb);
1030
+ }
1004
1031
  /**
1005
1032
  * 获取个人用户自动签的开通链接。
1006
1033
 
@@ -1010,7 +1037,21 @@ httpProfile.setEndpoint("file.test.ess.tencent.cn");
1010
1037
  return this.request("ChannelCreateUserAutoSignEnableUrl", req, cb);
1011
1038
  }
1012
1039
  /**
1013
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
1040
+ * 用于获取合同中填写控件填写状态和填写的内容。
1041
+
1042
+ **注意**: `附件控件不会出现在结果列表中`
1043
+
1044
+
1045
+ **授权**:
1046
+ 此接口需要授权, 有两种开通权限的途径
1047
+
1048
+ **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
1049
+ 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
1050
+
1051
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
1052
+
1053
+ **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
1054
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
1014
1055
  */
1015
1056
  async ChannelDescribeFlowComponents(req, cb) {
1016
1057
  return this.request("ChannelDescribeFlowComponents", req, cb);