tencentcloud-sdk-nodejs-essbasic 4.0.725 → 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.
@@ -1,5 +1,5 @@
1
1
  import * as TencentCloudCommon from "tencentcloud-sdk-nodejs-common";
2
- 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";
2
+ 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";
3
3
  /**
4
4
  * essbasic client
5
5
  * @class
@@ -50,21 +50,21 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
50
50
  ModifyExtendedService(req: ModifyExtendedServiceRequest, cb?: (error: string, rep: ModifyExtendedServiceResponse) => void): Promise<ModifyExtendedServiceResponse>;
51
51
  /**
52
52
  * 此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
53
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
54
- 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
55
53
 
56
- **本接口适用于发起方没有填写控件的 B2C或者单C模板**
54
+ **适用场景**:
55
+ 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
57
56
 
58
- **若是B2C模板,还要满足以下任意一个条件**
59
-
60
- - 模板中配置的签署顺序是无序
61
- - B端企业的签署方式是静默签署
62
- - B端企业是非首位签署
63
-
64
- 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
57
+ **注意**:
58
+ 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
59
+ - 模板中配置的签署顺序是无序
60
+ - B端企业的签署方式是静默签署
61
+ - B端企业是非首位签署
62
+ 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
65
63
  ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
64
+ 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)
66
65
 
67
- 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](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)
66
+ 二维码的样式如下图:
67
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
68
68
  */
69
69
  ChannelCreateMultiFlowSignQRCode(req: ChannelCreateMultiFlowSignQRCodeRequest, cb?: (error: string, rep: ChannelCreateMultiFlowSignQRCodeResponse) => void): Promise<ChannelCreateMultiFlowSignQRCodeResponse>;
70
70
  /**
@@ -179,8 +179,9 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
179
179
  */
180
180
  ChannelCreateConvertTaskApi(req: ChannelCreateConvertTaskApiRequest, cb?: (error: string, rep: ChannelCreateConvertTaskApiResponse) => void): Promise<ChannelCreateConvertTaskApiResponse>;
181
181
  /**
182
- * 此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
183
- 注: 此接口每日限频50次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
182
+ * 此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。
183
+
184
+ 注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
184
185
  */
185
186
  DescribeUsage(req: DescribeUsageRequest, cb?: (error: string, rep: DescribeUsageResponse) => void): Promise<DescribeUsageResponse>;
186
187
  /**
@@ -318,6 +319,7 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
318
319
  ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
319
320
 
320
321
  模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
322
+
321
323
  ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
322
324
 
323
325
 
@@ -454,8 +456,26 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
454
456
  */
455
457
  ChannelCreateBatchSignUrl(req: ChannelCreateBatchSignUrlRequest, cb?: (error: string, rep: ChannelCreateBatchSignUrlResponse) => void): Promise<ChannelCreateBatchSignUrlResponse>;
456
458
  /**
457
- * 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
458
- */
459
+ * 此接口(ChannelCreateBoundFlows)用于子客企业领取未归属给员工的合同,将合同领取给当前员工,合同不能重复领取。
460
+
461
+
462
+ **未归属合同发起方式**
463
+ 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下
464
+ ```
465
+ FlowApprovers: []*essbasic.FlowApproverInfo{
466
+ {
467
+ ApproverType: common.StringPtr("ORGANIZATION"),
468
+ OrganizationOpenId: common.StringPtr("org_dianziqian"),
469
+ OrganizationName: common.StringPtr("典子谦示例企业"),
470
+ }
471
+ },
472
+ ```
473
+
474
+ 可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
475
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
476
+
477
+ 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
478
+ */
459
479
  ChannelCreateBoundFlows(req: ChannelCreateBoundFlowsRequest, cb?: (error: string, rep: ChannelCreateBoundFlowsResponse) => void): Promise<ChannelCreateBoundFlowsResponse>;
460
480
  /**
461
481
  * 获取设置自动签印章小程序链接。
@@ -538,8 +558,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
538
558
 
539
559
  注:
540
560
  <ul>
541
- <li>仅支持下载 **本企业** 下合同,链接会 **登录企业控制台** </li>
542
- <li> **链接仅可使用一次**,不可重复使用</li>
561
+ <li>仅支持下载 <b>本企业</b> 下合同,链接会 <b>登录企业控制台</b> </li>
562
+ <li> <b>链接仅可使用一次</b>,不可重复使用</li>
543
563
  </ul>
544
564
  */
545
565
  GetDownloadFlowUrl(req: GetDownloadFlowUrlRequest, cb?: (error: string, rep: GetDownloadFlowUrlResponse) => void): Promise<GetDownloadFlowUrlResponse>;
@@ -604,7 +624,8 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
604
624
  1. 合同中当前状态为 **待签署** 的签署人是催办的对象
605
625
  2. **每个合同只能催办一次**
606
626
 
607
- **催办的效果**: 对方会受到如下的短信通知
627
+ **催办的效果**: 对方会收到如下的短信通知
628
+
608
629
  ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
609
630
 
610
631
 
@@ -860,6 +881,10 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
860
881
  注: `只能查询本企业创建的合同(创建合同用的Agent和此接口用的Agent数据最好一致) `
861
882
  */
862
883
  DescribeFlowDetailInfo(req: DescribeFlowDetailInfoRequest, cb?: (error: string, rep: DescribeFlowDetailInfoResponse) => void): Promise<DescribeFlowDetailInfoResponse>;
884
+ /**
885
+ * 通过此接口(ChannelDescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
886
+ */
887
+ ChannelDescribeBillUsageDetail(req: ChannelDescribeBillUsageDetailRequest, cb?: (error: string, rep: ChannelDescribeBillUsageDetailResponse) => void): Promise<ChannelDescribeBillUsageDetailResponse>;
863
888
  /**
864
889
  * 获取个人用户自动签的开通链接。
865
890
 
@@ -867,7 +892,21 @@ export declare class Client extends TencentCloudCommon.AbstractClient {
867
892
  */
868
893
  ChannelCreateUserAutoSignEnableUrl(req: ChannelCreateUserAutoSignEnableUrlRequest, cb?: (error: string, rep: ChannelCreateUserAutoSignEnableUrlResponse) => void): Promise<ChannelCreateUserAutoSignEnableUrlResponse>;
869
894
  /**
870
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
871
- */
895
+ * 用于获取合同中填写控件填写状态和填写的内容。
896
+
897
+ **注意**: `附件控件不会出现在结果列表中`
898
+
899
+
900
+ **授权**:
901
+ 此接口需要授权, 有两种开通权限的途径
902
+
903
+ **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
904
+ 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
905
+
906
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
907
+
908
+ **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
909
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
910
+ */
872
911
  ChannelDescribeFlowComponents(req: ChannelDescribeFlowComponentsRequest, cb?: (error: string, rep: ChannelDescribeFlowComponentsResponse) => void): Promise<ChannelDescribeFlowComponentsResponse>;
873
912
  }
@@ -77,21 +77,21 @@ class Client extends TencentCloudCommon.AbstractClient {
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 @@ class Client extends TencentCloudCommon.AbstractClient {
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 @@ class Client extends TencentCloudCommon.AbstractClient {
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,8 +539,26 @@ class Client extends TencentCloudCommon.AbstractClient {
537
539
  return this.request("ChannelCreateBatchSignUrl", req, cb);
538
540
  }
539
541
  /**
540
- * 此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
541
- */
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
+ 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
561
+ */
542
562
  async ChannelCreateBoundFlows(req, cb) {
543
563
  return this.request("ChannelCreateBoundFlows", req, cb);
544
564
  }
@@ -641,8 +661,8 @@ class Client extends TencentCloudCommon.AbstractClient {
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 @@ class Client extends TencentCloudCommon.AbstractClient {
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 @@ class Client extends TencentCloudCommon.AbstractClient {
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,8 +1037,22 @@ class Client extends TencentCloudCommon.AbstractClient {
1010
1037
  return this.request("ChannelCreateUserAutoSignEnableUrl", req, cb);
1011
1038
  }
1012
1039
  /**
1013
- * 查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
1014
- */
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)
1055
+ */
1015
1056
  async ChannelDescribeFlowComponents(req, cb) {
1016
1057
  return this.request("ChannelDescribeFlowComponents", req, cb);
1017
1058
  }