tencentcloud-sdk-python-essbasic 3.0.1022__py2.py3-none-any.whl → 3.0.1039__py2.py3-none-any.whl

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.
tencentcloud/__init__.py CHANGED
@@ -14,4 +14,4 @@
14
14
  # limitations under the License.
15
15
 
16
16
 
17
- __version__ = '3.0.1022'
17
+ __version__ = '3.0.1039'
@@ -170,14 +170,15 @@ class EssbasicClient(AbstractClient):
170
170
 
171
171
 
172
172
  def ChannelCreateBatchQuickSignUrl(self, request):
173
- """该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署 <br/>
174
- `注意:`<br/>
175
- `1. 该接口目前仅支持签署人类型是个人签署方的批量签署场景(ApproverType=PERSON)。` <br/>
176
- `2. 该接口可生成批量签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
177
- `3. 请确保C端签署人在批量签署合同中为待签署状态,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。` <br/>
178
- `4. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建批量签署链接 。` <br/>
179
- `5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入。`<br/>
180
- 跳转到小程序的实现,参考微信官方文档(分为<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>
173
+ """该接口用于发起合同后,生成个人用户的批量签署链接, 暂时不支持企业端签署。
174
+ **注意**:
175
+ 1. 该接口目前仅支持签署人类型是**个人签署方的批量签署场景**(ApproverType=PERSON)。
176
+ 2. 该接口可生成批量签署链接的C端签署人**必须仅有手写签名和时间类型的签署控件**,**不支持填写控件** 。
177
+ 3. 请确保C端签署人在批量签署合同中**为待签署状态**,如需顺序签署请待前一位参与人签署完成后,再创建该C端用户的签署链接。
178
+ 4. 该签署链接**有效期为30分钟**,过期后将失效,如需签署可重新创建批量签署链接 。
179
+ 5. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
180
+ 跳转到小程序的实现,参考微信官方文档(分为<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>。
181
+ 6. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
181
182
 
182
183
  :param request: Request instance for ChannelCreateBatchQuickSignUrl.
183
184
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBatchQuickSignUrlRequest`
@@ -229,7 +230,25 @@ class EssbasicClient(AbstractClient):
229
230
 
230
231
 
231
232
  def ChannelCreateBoundFlows(self, request):
232
- """此接口(ChannelCreateBoundFlows)用于子客领取合同,经办人需要有相应的角色,合同不能重复领取。
233
+ """此接口(ChannelCreateBoundFlows)用于子客企业领取未归属给员工的合同,将合同领取给当前员工,合同不能重复领取。
234
+
235
+
236
+ **未归属合同发起方式**
237
+ 指定对应企业的OrganizationOpenId和OrganizationName而不指定具体的参与人(OpenId/名字/手机号等), 则合同进入待领取状态, 示例代码如下
238
+ ```
239
+ FlowApprovers: []*essbasic.FlowApproverInfo{
240
+ {
241
+ ApproverType: common.StringPtr("ORGANIZATION"),
242
+ OrganizationOpenId: common.StringPtr("org_dianziqian"),
243
+ OrganizationName: common.StringPtr("典子谦示例企业"),
244
+ }
245
+ },
246
+ ```
247
+
248
+ 可以<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>登录控制台查看带领取的合同
249
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/a34d0cc56ec871613e94dfc6252bc072.png)
250
+
251
+ 注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
233
252
 
234
253
  :param request: Request instance for ChannelCreateBoundFlows.
235
254
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBoundFlowsRequest`
@@ -283,8 +302,13 @@ class EssbasicClient(AbstractClient):
283
302
 
284
303
  def ChannelCreateEmbedWebUrl(self, request):
285
304
  """本接口(ChannelCreateEmbedWebUrl)用于创建常规模块嵌入web的链接
286
- 本接口支持创建:创建印章,创建模板,修改模板,预览模板,预览合同流程的web链接
287
- 进入web连接后与当前控制台操作保持一致
305
+
306
+ 本接口下面功能的签署页面链接的生成
307
+ - 创建印章
308
+ - 创建模板
309
+ - 修改模板
310
+ - 预览模板
311
+ - 预览合同流程
288
312
 
289
313
  :param request: Request instance for ChannelCreateEmbedWebUrl.
290
314
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateEmbedWebUrlRequest`
@@ -345,7 +369,7 @@ class EssbasicClient(AbstractClient):
345
369
  <li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
346
370
  </ul>
347
371
 
348
- ![image](https://dyn.ess.tencent.cn/guide/capi/ChannelCreateFlowByFiles.png)
372
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/bf86248a2c163228c4e894cf5926af69/ChannelCreateFlowByFiles.png)
349
373
 
350
374
  **可以作为发起方和签署方的角色列表**
351
375
  <table>
@@ -584,7 +608,8 @@ class EssbasicClient(AbstractClient):
584
608
  1. 合同中当前状态为 **待签署** 的签署人是催办的对象
585
609
  2. **每个合同只能催办一次**
586
610
 
587
- **催办的效果**: 对方会受到如下的短信通知
611
+ **催办的效果**: 对方会收到如下的短信通知
612
+
588
613
  ![image](https://qcloudimg.tencent-cloud.cn/raw/3caf94b7f540fa5736270d38528d3a7b.png)
589
614
 
590
615
 
@@ -638,14 +663,15 @@ class EssbasicClient(AbstractClient):
638
663
 
639
664
 
640
665
  def ChannelCreateFlowSignUrl(self, request):
641
- """该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署。 <br/>
666
+ """该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
642
667
 
643
- `注意:`<br/>
644
- `1. 该接口目前仅支持签署人类型是个人签署方的场景(PERSON)。` <br/>
645
- `2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,不支持填写控件 。` <br/>
646
- `3. 该签署链接有效期为30分钟,过期后将失效,如需签署可重新创建签署链接 。` <br/>
647
- `4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,不支持微信小程序嵌入`。<br/>
648
- 跳转到小程序的实现,参考微信官方文档(分为<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>
668
+ **注意**
669
+ 1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
670
+ 2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件** 。
671
+ 3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
672
+ 4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
673
+ 跳转到小程序的实现,参考微信官方文档(分为<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>。
674
+ 5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
649
675
 
650
676
  :param request: Request instance for ChannelCreateFlowSignUrl.
651
677
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest`
@@ -669,21 +695,21 @@ class EssbasicClient(AbstractClient):
669
695
 
670
696
  def ChannelCreateMultiFlowSignQRCode(self, request):
671
697
  """此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
672
- 适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
673
- 常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
674
-
675
- **本接口适用于发起方没有填写控件的 B2C或者单C模板**
676
-
677
- **若是B2C模板,还要满足以下任意一个条件**
678
698
 
679
- - 模板中配置的签署顺序是无序
680
- - B端企业的签署方式是静默签署
681
- - B端企业是非首位签署
699
+ **适用场景**:
700
+ 签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
682
701
 
683
- 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
702
+ **注意**:
703
+ 1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
704
+ - 模板中配置的签署顺序是无序
705
+ - B端企业的签署方式是静默签署
706
+ - B端企业是非首位签署
707
+ 2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
684
708
  ]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
709
+ 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)
685
710
 
686
- 用户通过签署二维码发起合同时,因企业额度不足导致失败 会触发签署二维码相关回调,具体参考文档[签署二维码相关回调](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)
711
+ 二维码的样式如下图:
712
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/27317cf5aacb094fb1dc6f94179a5148.png )
687
713
 
688
714
  :param request: Request instance for ChannelCreateMultiFlowSignQRCode.
689
715
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateMultiFlowSignQRCodeRequest`
@@ -757,11 +783,14 @@ class EssbasicClient(AbstractClient):
757
783
 
758
784
 
759
785
  def ChannelCreatePrepareFlow(self, request):
760
- """创建预发起合同
761
- 通过此接口指定:合同,签署人,填写控件信息,生成预创建合同链接,点击后跳转到web页面完成合同创建并发起
762
- 可指定合同信息不可更改,签署人信息不可更改
763
- 合同发起后,填写及签署流程与现有操作流程一致
764
- 注意:目前仅支持模板发起
786
+ """通过此接口指定合同、签署人、填写控件等信息,生成嵌入式链接,此链接可以嵌入到其他网页或者直接打开,打开后进入发起页面。在此页面上,合同信息和签署人信息均不可更改。
787
+
788
+ 注意:
789
+ 1. **仅支持模板**发起
790
+ 2. 只支持PC浏览器操作使用
791
+
792
+ 嵌入的页面样式如下:
793
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/b2ae013fb4d747891dd3815bbe897208.png)
765
794
 
766
795
  :param request: Request instance for ChannelCreatePrepareFlow.
767
796
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreatePrepareFlowRequest`
@@ -843,7 +872,7 @@ class EssbasicClient(AbstractClient):
843
872
 
844
873
  适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
845
874
 
846
- 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
875
+ 适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
847
876
 
848
877
  :param request: Request instance for ChannelCreateRole.
849
878
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateRoleRequest`
@@ -1039,7 +1068,7 @@ class EssbasicClient(AbstractClient):
1039
1068
 
1040
1069
 
1041
1070
  def ChannelDeleteSealPolicies(self, request):
1042
- """删除指定印章下多个授权信息
1071
+ """此接口(ChannelDeleteSealPolicies)用于删除已指定员工印章授权信息,删除员工的印章授权后,该员工使用印章进行盖章时,将需要提交印章授权申请且通过审核后才能使用该印章进行签署。
1043
1072
 
1044
1073
  :param request: Request instance for ChannelDeleteSealPolicies.
1045
1074
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDeleteSealPoliciesRequest`
@@ -1061,6 +1090,29 @@ class EssbasicClient(AbstractClient):
1061
1090
  raise TencentCloudSDKException(type(e).__name__, str(e))
1062
1091
 
1063
1092
 
1093
+ def ChannelDescribeBillUsageDetail(self, request):
1094
+ """通过此接口(ChannelDescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1095
+
1096
+ :param request: Request instance for ChannelDescribeBillUsageDetail.
1097
+ :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeBillUsageDetailRequest`
1098
+ :rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeBillUsageDetailResponse`
1099
+
1100
+ """
1101
+ try:
1102
+ params = request._serialize()
1103
+ headers = request.headers
1104
+ body = self.call("ChannelDescribeBillUsageDetail", params, headers=headers)
1105
+ response = json.loads(body)
1106
+ model = models.ChannelDescribeBillUsageDetailResponse()
1107
+ model._deserialize(response["Response"])
1108
+ return model
1109
+ except Exception as e:
1110
+ if isinstance(e, TencentCloudSDKException):
1111
+ raise
1112
+ else:
1113
+ raise TencentCloudSDKException(type(e).__name__, str(e))
1114
+
1115
+
1064
1116
  def ChannelDescribeEmployees(self, request):
1065
1117
  """获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息,支持设置过滤条件以筛选员工查询结果。
1066
1118
 
@@ -1087,7 +1139,21 @@ class EssbasicClient(AbstractClient):
1087
1139
 
1088
1140
 
1089
1141
  def ChannelDescribeFlowComponents(self, request):
1090
- """查询流程填写控件内容,可以根据流程Id查询该流程相关联的填写控件信息和填写内容。 注意:使用此接口前,需要在【企业应用管理】-【应用集成】-【第三方应用管理】中开通【下载应用内全量合同文件及内容数据】功能。
1142
+ """用于获取合同中填写控件填写状态和填写的内容。
1143
+
1144
+ **注意**: `附件控件不会出现在结果列表中`
1145
+
1146
+
1147
+ **授权**:
1148
+ 此接口需要授权, 有两种开通权限的途径
1149
+
1150
+ **第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
1151
+ 授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
1152
+
1153
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/8b483dfebdeafac85051279406944048.png)
1154
+
1155
+ **第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
1156
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/238979ef51dd381ccbdbc755a593debc/channel_DescribeResourceUrlsByFlows_appilications2.png)
1091
1157
 
1092
1158
  :param request: Request instance for ChannelDescribeFlowComponents.
1093
1159
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeFlowComponentsRequest`
@@ -1110,8 +1176,11 @@ class EssbasicClient(AbstractClient):
1110
1176
 
1111
1177
 
1112
1178
  def ChannelDescribeOrganizationSeals(self, request):
1113
- """查询子客企业电子印章,需要操作者具有管理印章权限
1114
- 客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理;入参InfoType控制印章是否携带授权人信息,为1则携带,为0则返回的授权人信息为空数组。接口调用成功返回印章的信息列表还有企业印章的总数,只返回启用的印章。
1179
+ """此接口(ChannelDescribeOrganizationSeals)查询子客企业电子印章。<br />
1180
+ 注:
1181
+ 1. `查询子客企业电子印章,需要操作者具有管理印章权限`
1182
+ 2. `客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理`
1183
+ 3. `此接口只能查询启用的印章`
1115
1184
 
1116
1185
  :param request: Request instance for ChannelDescribeOrganizationSeals.
1117
1186
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeOrganizationSealsRequest`
@@ -1135,7 +1204,16 @@ class EssbasicClient(AbstractClient):
1135
1204
 
1136
1205
  def ChannelDescribeRoles(self, request):
1137
1206
  """分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
1138
- 相关系统默认角色说明可参考文档:https://cloud.tencent.com/document/product/1323/61355
1207
+
1208
+
1209
+ <font color="red">**系统默认角色**</font>说明可参考下表
1210
+
1211
+ | 角色名称| 建议授予对象 | 角色描述 |
1212
+ | --- | --- | --- |
1213
+ | **超级管理员** |电子签业务最高权限,可以授权给法务/企业法人/业务负责人等 | 所有功能和数据管理权限,只能设置一位超管。 |
1214
+ | **业务管理员**|IT 系统负责人,可以授权给CTO等 | 企业合同模块、印章模块、模板模块等全量功能及数据权限。 |
1215
+ | **经办人**|企业法务负责人等 | 发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看企业所有合同数据。 |
1216
+ | **业务员**|销售员、采购员 等| 发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看自己相关所有合同数据。 |
1139
1217
 
1140
1218
  :param request: Request instance for ChannelDescribeRoles.
1141
1219
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeRolesRequest`
@@ -1244,7 +1322,7 @@ class EssbasicClient(AbstractClient):
1244
1322
 
1245
1323
  适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
1246
1324
 
1247
- 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考接口 ChannelDescribeRoles 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
1325
+ 适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
1248
1326
 
1249
1327
  :param request: Request instance for ChannelModifyRole.
1250
1328
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelModifyRoleRequest`
@@ -1267,7 +1345,7 @@ class EssbasicClient(AbstractClient):
1267
1345
 
1268
1346
 
1269
1347
  def ChannelUpdateSealStatus(self, request):
1270
- """本接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态
1348
+ """此接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态。
1271
1349
 
1272
1350
  :param request: Request instance for ChannelUpdateSealStatus.
1273
1351
  :type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelUpdateSealStatusRequest`
@@ -1322,7 +1400,7 @@ class EssbasicClient(AbstractClient):
1322
1400
  - 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
1323
1401
 
1324
1402
 
1325
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
1403
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1b4307ed143a992940c41d61192d3a0f/channel_CreateChannelFlowEvidenceReport.png)
1326
1404
 
1327
1405
  :param request: Request instance for CreateChannelFlowEvidenceReport.
1328
1406
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelFlowEvidenceReportRequest`
@@ -1380,6 +1458,11 @@ class EssbasicClient(AbstractClient):
1380
1458
  <li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
1381
1459
  </ul>
1382
1460
 
1461
+
1462
+ 注意:
1463
+ 1. 生成的电子签小程序链接<font color='red'>只能由企业的法人或者超管</font>点击后进行操作, 其他员工打开后会提示“无权查看该内容”
1464
+ 2. 法人可以无需生成链接,直接在电子签小程序中更换本企业的超管
1465
+
1383
1466
  :param request: Request instance for CreateChannelOrganizationInfoChangeUrl.
1384
1467
  :type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelOrganizationInfoChangeUrlRequest`
1385
1468
  :rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelOrganizationInfoChangeUrlResponse`
@@ -1465,7 +1548,7 @@ class EssbasicClient(AbstractClient):
1465
1548
 
1466
1549
  **整体的逻辑如下**
1467
1550
 
1468
- ![image](https://dyn.ess.tencent.cn/guide/capi/CreateFlowsByTemplates.png)
1551
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/e193519d4383fa74782a9e19147ef01a/CreateFlowsByTemplates.png)
1469
1552
 
1470
1553
  **可以作为发起方和签署方的角色列表**
1471
1554
  <table>
@@ -1602,7 +1685,9 @@ class EssbasicClient(AbstractClient):
1602
1685
 
1603
1686
 
1604
1687
  def DescribeBillUsageDetail(self, request):
1605
- """通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1688
+ """废弃接口
1689
+
1690
+ 通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
1606
1691
 
1607
1692
  :param request: Request instance for DescribeBillUsageDetail.
1608
1693
  :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeBillUsageDetailRequest`
@@ -1632,7 +1717,7 @@ class EssbasicClient(AbstractClient):
1632
1717
  - 使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
1633
1718
  - 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
1634
1719
 
1635
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_CreateChannelFlowEvidenceReport.png)
1720
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/1b4307ed143a992940c41d61192d3a0f/channel_CreateChannelFlowEvidenceReport.png)
1636
1721
 
1637
1722
  :param request: Request instance for DescribeChannelFlowEvidenceReport.
1638
1723
  :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeChannelFlowEvidenceReportRequest`
@@ -1751,23 +1836,24 @@ class EssbasicClient(AbstractClient):
1751
1836
 
1752
1837
  **适用场景**
1753
1838
  该接口常用来配合<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>接口,作为创建合同的前置接口使用。
1754
- 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
1839
+ 通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的创建。
1755
1840
 
1756
- **模版的来源**
1841
+ **模板的来源**
1757
1842
  子客企业的模板有两种途径获取
1758
1843
  - 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
1759
1844
  - 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
1760
1845
 
1761
1846
  **一个模板通常会包含以下结构信息**
1762
1847
 
1763
- - 模板模版ID, 模板名字等基本信息
1848
+ - 模板ID, 模板名字等基本信息
1764
1849
  - 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
1765
1850
  - 发起方和签署方的填写控件 Components
1766
1851
  - 签署方的签署控件 SignComponents
1767
1852
 
1768
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_DescribeTemplates.png)
1853
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/ab81fa948a0a6fea14f48cac91d0e36a/channel_DescribeTemplates.png)
1854
+
1855
+ 模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
1769
1856
 
1770
- 模版中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
1771
1857
  ![image](https://qcloudimg.tencent-cloud.cn/raw/45c638bd93f9c8024763add9ab47c27f.png)
1772
1858
 
1773
1859
 
@@ -1797,8 +1883,9 @@ class EssbasicClient(AbstractClient):
1797
1883
 
1798
1884
 
1799
1885
  def DescribeUsage(self, request):
1800
- """此接口(DescribeUsage)用于获取第三方平台所有合作企业流量消耗情况。
1801
- 注: 此接口每日限频50次,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
1886
+ """此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。
1887
+
1888
+ 注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
1802
1889
 
1803
1890
  :param request: Request instance for DescribeUsage.
1804
1891
  :type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeUsageRequest`
@@ -1826,8 +1913,8 @@ class EssbasicClient(AbstractClient):
1826
1913
 
1827
1914
  注:
1828
1915
  <ul>
1829
- <li>仅支持下载 **本企业** 下合同,链接会 **登录企业控制台** </li>
1830
- <li> **链接仅可使用一次**,不可重复使用</li>
1916
+ <li>仅支持下载 <b>本企业</b> 下合同,链接会 <b>登录企业控制台</b> </li>
1917
+ <li> <b>链接仅可使用一次</b>,不可重复使用</li>
1831
1918
  </ul>
1832
1919
 
1833
1920
  :param request: Request instance for GetDownloadFlowUrl.
@@ -1900,23 +1987,24 @@ class EssbasicClient(AbstractClient):
1900
1987
 
1901
1988
 
1902
1989
  def OperateChannelTemplate(self, request):
1903
- """此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业可见性的查询和设置。
1904
-
1905
- > **使用场景**
1906
- >
1907
- > 1:查询 OperateType=SELECT
1908
- > - 查询第三方应用平台模板库的可见性以及授权的子客列表。
1909
- >
1910
- > 2:修改部分子客授权 OperateType=UPDATE
1911
- > - 对子客企业进行模板库中模板可见性的进行修改操作。
1912
- >- 当模板未发布时,可以修改可见性AuthTag(part/all),当模板发布后,不可做此修改
1913
- > - 若模板已发布且可见性AuthTag是part,可以通过ProxyOrganizationOpenIds增加子客的授权范围。如果是自动领取的模板,增加授权范围后会自动下发。
1914
- >
1915
- > 3:取消部分子客授权 OperateType=DELETE
1916
- > - 对子客企业进行模板库中模板可见性的进行删除操作。
1917
- > - 主要对于手动领取的模板,去除授权后子客在模板库中看不到,就无法再领取了。但是已经领取过成为自有模板的不会同步删除。
1918
- > - 对于自动领取的模板,由于已经下发,更改授权不会影响。
1919
- > - 如果要同步删除子客自有模板库中的模板,请使用OperateType=UPDATE+Available参数处理。
1990
+ """此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业发布授权的查询和设置。
1991
+ 平台模板库中的模板的位置在控制台 企业应用管理 中下面的应用模板库管理目录, 可以参照下图位置
1992
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/7f2b6c94164b3e931efc9a037e0400f7.png)
1993
+
1994
+ # 支持的操作
1995
+
1996
+ ## 1. 查询模板的子客企业授权 (OperateType=SELECT)
1997
+ - 查询模板的授权子企业列表
1998
+
1999
+ ## 2. 修改模板的子客企业授权 (OperateType=UPDATE)
2000
+ - 当模板未发布时,可以修改模板的模板授权范围是**所有第三方应用合作企业**(AuthTag设置为all)或者**指定第三方应用合作企业**(AuthTag设置为part),**当模板发布后,不可做此修改**
2001
+ - 如果模板是部分授权, 可通过ProxyOrganizationOpenIds增加子客的授权范围。
2002
+
2003
+ ## 3. 取消模板的子客企业授权 (OperateType=DELETE)
2004
+ - 对子客企业进行模板库中模板授权范围的进行删除操作。
2005
+ - 主要对于手动领取的模板,去除授权后子客在模板库中看不到,就无法再领取了。但是**已经领取过成为自有模板的不会同步删除**。
2006
+ - 对于自动领取的模板,由于已经下发,更改授权不会影响。
2007
+ - 如果要同步删除子客自有模板库中的模板,请使用OperateType=UPDATE+Available参数处理。
1920
2008
 
1921
2009
  :param request: Request instance for OperateChannelTemplate.
1922
2010
  :type request: :class:`tencentcloud.essbasic.v20210526.models.OperateChannelTemplateRequest`
@@ -2006,7 +2094,7 @@ class EssbasicClient(AbstractClient):
2006
2094
 
2007
2095
  - **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
2008
2096
 
2009
- ![image](https://dyn.ess.tencent.cn/guide/capi/channel_SyncProxyOrganizationOperators.png)
2097
+ ![image](https://qcloudimg.tencent-cloud.cn/raw/7a27a6bb0e4d39c2f6aa2a0b39946181/channel_SyncProxyOrganizationOperators.png)
2010
2098
 
2011
2099
  **注**:
2012
2100
  - 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
@@ -2042,7 +2130,7 @@ class EssbasicClient(AbstractClient):
2042
2130
 
2043
2131
  注:
2044
2132
  1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
2045
- 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 **file.test.ess.tencent.cn**,正式环境需要设置为**file.ess.tencent.cn**,代码示例
2133
+ 2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
2046
2134
  ```
2047
2135
  HttpProfile httpProfile = new HttpProfile();
2048
2136
  httpProfile.setEndpoint("file.test.ess.tencent.cn");