tencentcloud-sdk-python-essbasic 3.0.1018__tar.gz → 3.0.1029__tar.gz
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-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/PKG-INFO +1 -1
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/setup.py +1 -1
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/__init__.py +1 -1
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/v20210526/errorcodes.py +9 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/v20210526/essbasic_client.py +219 -85
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/v20210526/models.py +1166 -221
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +1 -1
- tencentcloud-sdk-python-essbasic-3.0.1029/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
- tencentcloud-sdk-python-essbasic-3.0.1018/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/README.rst +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/setup.cfg +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/v20201222/models.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
{tencentcloud-sdk-python-essbasic-3.0.1018 → tencentcloud-sdk-python-essbasic-3.0.1029}/setup.py
RENAMED
|
@@ -8,7 +8,7 @@ ROOT = os.path.dirname(__file__)
|
|
|
8
8
|
|
|
9
9
|
setup(
|
|
10
10
|
name='tencentcloud-sdk-python-essbasic',
|
|
11
|
-
install_requires=["tencentcloud-sdk-python-common==3.0.
|
|
11
|
+
install_requires=["tencentcloud-sdk-python-common==3.0.1029"],
|
|
12
12
|
version=tencentcloud.__version__,
|
|
13
13
|
description='Tencent Cloud Essbasic SDK for Python',
|
|
14
14
|
long_description=open('README.rst').read(),
|
|
@@ -284,6 +284,12 @@ INVALIDPARAMETER_FFOWIDS = 'InvalidParameter.fFowIds'
|
|
|
284
284
|
# 参数取值错误。
|
|
285
285
|
INVALIDPARAMETERVALUE = 'InvalidParameterValue'
|
|
286
286
|
|
|
287
|
+
# 非法的套餐类型
|
|
288
|
+
INVALIDPARAMETERVALUE_INVALIDQUOTATYPE = 'InvalidParameterValue.InvalidQuotaType'
|
|
289
|
+
|
|
290
|
+
# 非法的时间参数
|
|
291
|
+
INVALIDPARAMETERVALUE_INVALIDTIME = 'InvalidParameterValue.InvalidTime'
|
|
292
|
+
|
|
287
293
|
# 超过配额限制。
|
|
288
294
|
LIMITEXCEEDED = 'LimitExceeded'
|
|
289
295
|
|
|
@@ -482,6 +488,9 @@ RESOURCENOTFOUND_FLOWAPPROVERS = 'ResourceNotFound.FlowApprovers'
|
|
|
482
488
|
# 合同组不存在。
|
|
483
489
|
RESOURCENOTFOUND_FLOWGROUP = 'ResourceNotFound.FlowGroup'
|
|
484
490
|
|
|
491
|
+
# 应用号不存在
|
|
492
|
+
RESOURCENOTFOUND_NOTEXISTAPPLICATION = 'ResourceNotFound.NotExistApplication'
|
|
493
|
+
|
|
485
494
|
# 机构不存在。
|
|
486
495
|
RESOURCENOTFOUND_ORGANIZATION = 'ResourceNotFound.Organization'
|
|
487
496
|
|
|
@@ -170,14 +170,15 @@ class EssbasicClient(AbstractClient):
|
|
|
170
170
|
|
|
171
171
|
|
|
172
172
|
def ChannelCreateBatchQuickSignUrl(self, request):
|
|
173
|
-
"""该接口用于发起合同后,生成个人用户的批量签署链接,
|
|
174
|
-
|
|
175
|
-
|
|
176
|
-
|
|
177
|
-
|
|
178
|
-
|
|
179
|
-
|
|
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
|
+

|
|
250
|
+
|
|
251
|
+
注: `支持批量领取, 如果有一个合同流程无法领取会导致接口报错, 使得所有合同都领取失败`
|
|
233
252
|
|
|
234
253
|
:param request: Request instance for ChannelCreateBoundFlows.
|
|
235
254
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateBoundFlowsRequest`
|
|
@@ -345,7 +364,7 @@ class EssbasicClient(AbstractClient):
|
|
|
345
364
|
<li>此接口需要依赖<a href="https://qian.tencent.com/developers/partnerApis/files/UploadFiles" target="_blank">文件上传接口</a>生成pdf资源编号(FileIds)进行使用。整体的逻辑如下图</li>
|
|
346
365
|
</ul>
|
|
347
366
|
|
|
348
|
-

|
|
349
368
|
|
|
350
369
|
**可以作为发起方和签署方的角色列表**
|
|
351
370
|
<table>
|
|
@@ -580,12 +599,16 @@ class EssbasicClient(AbstractClient):
|
|
|
580
599
|
|
|
581
600
|
|
|
582
601
|
def ChannelCreateFlowReminds(self, request):
|
|
583
|
-
"""指定需要批量催办的签署流程ID,批量催办合同,最多100
|
|
602
|
+
"""指定需要批量催办的签署流程ID,批量催办合同,最多100个。需要符合以下条件的合同才可被催办
|
|
603
|
+
1. 合同中当前状态为 **待签署** 的签署人是催办的对象
|
|
604
|
+
2. **每个合同只能催办一次**
|
|
584
605
|
|
|
585
|
-
|
|
586
|
-
2. 每个合同只能催办一次
|
|
606
|
+
**催办的效果**: 对方会收到如下的短信通知
|
|
587
607
|
|
|
588
|
-
|
|
608
|
+

|
|
609
|
+
|
|
610
|
+
|
|
611
|
+
**注**:`合同催办是白名单功能,请联系客户经理申请开白后使用`
|
|
589
612
|
|
|
590
613
|
:param request: Request instance for ChannelCreateFlowReminds.
|
|
591
614
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowRemindsRequest`
|
|
@@ -635,10 +658,15 @@ class EssbasicClient(AbstractClient):
|
|
|
635
658
|
|
|
636
659
|
|
|
637
660
|
def ChannelCreateFlowSignUrl(self, request):
|
|
638
|
-
"""
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
661
|
+
"""该接口用于发起合同后,生成个人用户的签署链接, 暂时不支持企业端签署 <br/>
|
|
662
|
+
|
|
663
|
+
**注意**
|
|
664
|
+
1. 该接口目前**仅支持签署人类型是个人签署方**的场景(PERSON)。
|
|
665
|
+
2. 该接口可生成签署链接的C端签署人必须仅有手写签名和时间类型的签署控件,**不支持填写控件** 。
|
|
666
|
+
3. 该签署**链接有效期为30分钟**,过期后将失效,如需签署可重新创建签署链接 。
|
|
667
|
+
4. 该接口返回的签署链接适用于APP集成的场景,支持APP打开或浏览器直接打开,**不支持微信小程序嵌入**。
|
|
668
|
+
跳转到小程序的实现,参考微信官方文档(分为<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>。
|
|
669
|
+
5. 因h5涉及人脸身份认证能力基于慧眼人脸核身,对Android和iOS系统均有一定要求, 因此<font color='red'>App嵌入H5签署合同需要按照慧眼提供的<a href="https://cloud.tencent.com/document/product/1007/61076">慧眼人脸核身兼容性文档</a>做兼容性适配</font>。
|
|
642
670
|
|
|
643
671
|
:param request: Request instance for ChannelCreateFlowSignUrl.
|
|
644
672
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateFlowSignUrlRequest`
|
|
@@ -662,21 +690,21 @@ class EssbasicClient(AbstractClient):
|
|
|
662
690
|
|
|
663
691
|
def ChannelCreateMultiFlowSignQRCode(self, request):
|
|
664
692
|
"""此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多扫流程签署二维码。
|
|
665
|
-
适用场景:无需填写签署人信息,可通过模板id生成签署二维码,签署人可通过扫描二维码补充签署信息进行实名签署。
|
|
666
|
-
常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
667
|
-
|
|
668
|
-
**本接口适用于发起方没有填写控件的 B2C或者单C模板**
|
|
669
|
-
|
|
670
|
-
**若是B2C模板,还要满足以下任意一个条件**
|
|
671
693
|
|
|
672
|
-
|
|
673
|
-
|
|
674
|
-
- B端企业是非首位签署
|
|
694
|
+
**适用场景**:
|
|
695
|
+
签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
675
696
|
|
|
676
|
-
|
|
697
|
+
**注意**:
|
|
698
|
+
1. 本接口适用于**发起方没有填写控件的 B2C或者单C模板**, 若是B2C模板,还要满足以下任意一个条件
|
|
699
|
+
- 模板中配置的签署顺序是无序
|
|
700
|
+
- B端企业的签署方式是静默签署
|
|
701
|
+
- B端企业是非首位签署
|
|
702
|
+
2. 通过一码多扫二维码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
|
|
677
703
|
]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
|
|
704
|
+
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)
|
|
678
705
|
|
|
679
|
-
|
|
706
|
+
二维码的样式如下图:
|
|
707
|
+

|
|
680
708
|
|
|
681
709
|
:param request: Request instance for ChannelCreateMultiFlowSignQRCode.
|
|
682
710
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateMultiFlowSignQRCodeRequest`
|
|
@@ -699,12 +727,12 @@ class EssbasicClient(AbstractClient):
|
|
|
699
727
|
|
|
700
728
|
|
|
701
729
|
def ChannelCreateOrganizationBatchSignUrl(self, request):
|
|
702
|
-
"""
|
|
730
|
+
"""通过此接口,可以创建企业批量签署链接,员工只需点击链接即可跳转至控制台进行批量签署。
|
|
703
731
|
|
|
704
732
|
注:
|
|
705
733
|
- 员工必须在企业下完成实名认证,且需作为批量签署合同的签署方或者领取方。
|
|
706
734
|
- 仅支持传入待签署或者待领取的合同,待填写暂不支持。
|
|
707
|
-
-
|
|
735
|
+
- 员工批量签署,支持多种签名方式,包括手写签名、临摹签名、系统签名、个人印章、签批控件等。
|
|
708
736
|
|
|
709
737
|
:param request: Request instance for ChannelCreateOrganizationBatchSignUrl.
|
|
710
738
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateOrganizationBatchSignUrlRequest`
|
|
@@ -836,7 +864,7 @@ class EssbasicClient(AbstractClient):
|
|
|
836
864
|
|
|
837
865
|
适用场景1:创建当前企业的自定义角色,并且创建时不进行权限的设置(PermissionGroups 参数不传),角色中的权限内容可通过接口 ChannelModifyRole 完成更新。
|
|
838
866
|
|
|
839
|
-
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups
|
|
867
|
+
适用场景2:创建当前企业的自定义角色,并且创建时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
840
868
|
|
|
841
869
|
:param request: Request instance for ChannelCreateRole.
|
|
842
870
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCreateRoleRequest`
|
|
@@ -1032,7 +1060,7 @@ class EssbasicClient(AbstractClient):
|
|
|
1032
1060
|
|
|
1033
1061
|
|
|
1034
1062
|
def ChannelDeleteSealPolicies(self, request):
|
|
1035
|
-
"""
|
|
1063
|
+
"""此接口(ChannelDeleteSealPolicies)用于删除已指定员工印章授权信息,删除员工的印章授权后,该员工使用印章进行盖章时,将需要提交印章授权申请且通过审核后才能使用该印章进行签署。
|
|
1036
1064
|
|
|
1037
1065
|
:param request: Request instance for ChannelDeleteSealPolicies.
|
|
1038
1066
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDeleteSealPoliciesRequest`
|
|
@@ -1054,8 +1082,33 @@ class EssbasicClient(AbstractClient):
|
|
|
1054
1082
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1055
1083
|
|
|
1056
1084
|
|
|
1085
|
+
def ChannelDescribeBillUsageDetail(self, request):
|
|
1086
|
+
"""通过此接口(ChannelDescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
|
|
1087
|
+
|
|
1088
|
+
:param request: Request instance for ChannelDescribeBillUsageDetail.
|
|
1089
|
+
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeBillUsageDetailRequest`
|
|
1090
|
+
:rtype: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeBillUsageDetailResponse`
|
|
1091
|
+
|
|
1092
|
+
"""
|
|
1093
|
+
try:
|
|
1094
|
+
params = request._serialize()
|
|
1095
|
+
headers = request.headers
|
|
1096
|
+
body = self.call("ChannelDescribeBillUsageDetail", params, headers=headers)
|
|
1097
|
+
response = json.loads(body)
|
|
1098
|
+
model = models.ChannelDescribeBillUsageDetailResponse()
|
|
1099
|
+
model._deserialize(response["Response"])
|
|
1100
|
+
return model
|
|
1101
|
+
except Exception as e:
|
|
1102
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1103
|
+
raise
|
|
1104
|
+
else:
|
|
1105
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1106
|
+
|
|
1107
|
+
|
|
1057
1108
|
def ChannelDescribeEmployees(self, request):
|
|
1058
|
-
"""
|
|
1109
|
+
"""获取企业员工信息, 可以获取员工的名字,OpenId,UserId和简述的角色等信息,支持设置过滤条件以筛选员工查询结果。
|
|
1110
|
+
|
|
1111
|
+
**注**:通过<a href="https://qian.tencent.com/developers/partnerApis/accounts/SyncProxyOrganizationOperators" target="_blank">企业员工新增或离职</a>接口增加的新员工或者离职的员工也会在列表中。
|
|
1059
1112
|
|
|
1060
1113
|
:param request: Request instance for ChannelDescribeEmployees.
|
|
1061
1114
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeEmployeesRequest`
|
|
@@ -1078,7 +1131,21 @@ class EssbasicClient(AbstractClient):
|
|
|
1078
1131
|
|
|
1079
1132
|
|
|
1080
1133
|
def ChannelDescribeFlowComponents(self, request):
|
|
1081
|
-
"""
|
|
1134
|
+
"""用于获取合同中填写控件填写状态和填写的内容。
|
|
1135
|
+
|
|
1136
|
+
**注意**: `附件控件不会出现在结果列表中`
|
|
1137
|
+
|
|
1138
|
+
|
|
1139
|
+
**授权**:
|
|
1140
|
+
此接口需要授权, 有两种开通权限的途径
|
|
1141
|
+
|
|
1142
|
+
**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
|
|
1143
|
+
授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
|
|
1144
|
+
|
|
1145
|
+

|
|
1146
|
+
|
|
1147
|
+
**第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
|
|
1148
|
+

|
|
1082
1149
|
|
|
1083
1150
|
:param request: Request instance for ChannelDescribeFlowComponents.
|
|
1084
1151
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeFlowComponentsRequest`
|
|
@@ -1101,8 +1168,11 @@ class EssbasicClient(AbstractClient):
|
|
|
1101
1168
|
|
|
1102
1169
|
|
|
1103
1170
|
def ChannelDescribeOrganizationSeals(self, request):
|
|
1104
|
-
"""
|
|
1105
|
-
|
|
1171
|
+
"""此接口(ChannelDescribeOrganizationSeals)查询子客企业电子印章。<br />
|
|
1172
|
+
注:
|
|
1173
|
+
1. `查询子客企业电子印章,需要操作者具有管理印章权限`
|
|
1174
|
+
2. `客户指定需要获取的印章数量和偏移量,数量最多100,超过100按100处理`
|
|
1175
|
+
3. `此接口只能查询启用的印章`
|
|
1106
1176
|
|
|
1107
1177
|
:param request: Request instance for ChannelDescribeOrganizationSeals.
|
|
1108
1178
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeOrganizationSealsRequest`
|
|
@@ -1126,7 +1196,16 @@ class EssbasicClient(AbstractClient):
|
|
|
1126
1196
|
|
|
1127
1197
|
def ChannelDescribeRoles(self, request):
|
|
1128
1198
|
"""分页查询企业角色列表,法人的角色是系统保留角色,不会返回,按照角色创建时间升序排列。
|
|
1129
|
-
|
|
1199
|
+
|
|
1200
|
+
|
|
1201
|
+
<font color="red">**系统默认角色**</font>说明可参考下表
|
|
1202
|
+
|
|
1203
|
+
| 角色名称| 建议授予对象 | 角色描述 |
|
|
1204
|
+
| --- | --- | --- |
|
|
1205
|
+
| **超级管理员** |电子签业务最高权限,可以授权给法务/企业法人/业务负责人等 | 所有功能和数据管理权限,只能设置一位超管。 |
|
|
1206
|
+
| **业务管理员**|IT 系统负责人,可以授权给CTO等 | 企业合同模块、印章模块、模板模块等全量功能及数据权限。 |
|
|
1207
|
+
| **经办人**|企业法务负责人等 | 发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看企业所有合同数据。 |
|
|
1208
|
+
| **业务员**|销售员、采购员 等| 发起合同、签署合同(含填写、拒签)、撤销合同、持有印章等权限能力,可查看自己相关所有合同数据。 |
|
|
1130
1209
|
|
|
1131
1210
|
:param request: Request instance for ChannelDescribeRoles.
|
|
1132
1211
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelDescribeRolesRequest`
|
|
@@ -1235,7 +1314,7 @@ class EssbasicClient(AbstractClient):
|
|
|
1235
1314
|
|
|
1236
1315
|
适用场景1:更新当前企业的自定义角色的名称或描述等其他信息,更新时不进行权限的设置(PermissionGroups 参数不传)。
|
|
1237
1316
|
|
|
1238
|
-
适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups
|
|
1317
|
+
适用场景2:更新当前企业的自定义角色的权限信息,更新时进行权限的设置(PermissionGroups 参数要传),权限树内容 PermissionGroups 可参考[查询角色列表接口](https://qian.tencent.com/developers/partnerApis/accounts/ChannelDescribeRoles) 的输出。此处注意权限树内容可能会更新,需尽量拉取最新的权限树内容,并且权限树内容 PermissionGroups 必须是一颗完整的权限树。
|
|
1239
1318
|
|
|
1240
1319
|
:param request: Request instance for ChannelModifyRole.
|
|
1241
1320
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelModifyRoleRequest`
|
|
@@ -1258,7 +1337,7 @@ class EssbasicClient(AbstractClient):
|
|
|
1258
1337
|
|
|
1259
1338
|
|
|
1260
1339
|
def ChannelUpdateSealStatus(self, request):
|
|
1261
|
-
"""
|
|
1340
|
+
"""此接口(ChannelUpdateSealStatus)用于第三方应用平台为子客企业更新印章状态。
|
|
1262
1341
|
|
|
1263
1342
|
:param request: Request instance for ChannelUpdateSealStatus.
|
|
1264
1343
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelUpdateSealStatusRequest`
|
|
@@ -1307,12 +1386,13 @@ class EssbasicClient(AbstractClient):
|
|
|
1307
1386
|
"""提交申请出证报告任务并返回报告ID。
|
|
1308
1387
|
|
|
1309
1388
|
注意:
|
|
1310
|
-
|
|
1311
|
-
|
|
1312
|
-
|
|
1313
|
-
|
|
1389
|
+
- 使用此功能**需搭配出证套餐** ,使用前请联系对接的客户经理沟通。
|
|
1390
|
+
- 操作人必须是**发起方或者签署方企业的(非走授权书认证)法人或者超管**。
|
|
1391
|
+
- 合同流程必须**所有参与方已经签署完成**。
|
|
1392
|
+
- 出证过程需一定时间,建议在**提交出证任务后的24小时之后**,通过<a href="https://qian.tencent.com/developers/partnerApis/certificate/DescribeChannelFlowEvidenceReport" target="_blank">获取出证报告任务执行结果</a>接口进行查询执行结果和出证报告的下载URL。
|
|
1314
1393
|
|
|
1315
|
-
|
|
1394
|
+
|
|
1395
|
+

|
|
1316
1396
|
|
|
1317
1397
|
:param request: Request instance for CreateChannelFlowEvidenceReport.
|
|
1318
1398
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.CreateChannelFlowEvidenceReportRequest`
|
|
@@ -1425,6 +1505,9 @@ class EssbasicClient(AbstractClient):
|
|
|
1425
1505
|
1. 若在激活过程中,**更换用户OpenID重新生成链接,之前的认证会被清理**。因此不要在企业认证过程生成多个链接给多人同时操作,会导致认证过程互相影响。
|
|
1426
1506
|
2. 若您认证中发现信息有误需要重新认证,**可通过更换用户OpenID重新生成链接的方式,来清理掉已有的流程**。
|
|
1427
1507
|
|
|
1508
|
+
系统的渠道企业, 应用, 子客企业, 子客员工的组织形式
|
|
1509
|
+

|
|
1510
|
+
|
|
1428
1511
|
:param request: Request instance for CreateConsoleLoginUrl.
|
|
1429
1512
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlRequest`
|
|
1430
1513
|
:rtype: :class:`tencentcloud.essbasic.v20210526.models.CreateConsoleLoginUrlResponse`
|
|
@@ -1452,7 +1535,7 @@ class EssbasicClient(AbstractClient):
|
|
|
1452
1535
|
|
|
1453
1536
|
**整体的逻辑如下**
|
|
1454
1537
|
|
|
1455
|
-

|
|
1456
1539
|
|
|
1457
1540
|
**可以作为发起方和签署方的角色列表**
|
|
1458
1541
|
<table>
|
|
@@ -1588,8 +1671,40 @@ class EssbasicClient(AbstractClient):
|
|
|
1588
1671
|
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1589
1672
|
|
|
1590
1673
|
|
|
1674
|
+
def DescribeBillUsageDetail(self, request):
|
|
1675
|
+
"""废弃接口
|
|
1676
|
+
|
|
1677
|
+
通过此接口(DescribeBillUsageDetail)查询该第三方平台子客企业的套餐消耗详情。
|
|
1678
|
+
|
|
1679
|
+
:param request: Request instance for DescribeBillUsageDetail.
|
|
1680
|
+
:type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeBillUsageDetailRequest`
|
|
1681
|
+
:rtype: :class:`tencentcloud.essbasic.v20210526.models.DescribeBillUsageDetailResponse`
|
|
1682
|
+
|
|
1683
|
+
"""
|
|
1684
|
+
try:
|
|
1685
|
+
params = request._serialize()
|
|
1686
|
+
headers = request.headers
|
|
1687
|
+
body = self.call("DescribeBillUsageDetail", params, headers=headers)
|
|
1688
|
+
response = json.loads(body)
|
|
1689
|
+
model = models.DescribeBillUsageDetailResponse()
|
|
1690
|
+
model._deserialize(response["Response"])
|
|
1691
|
+
return model
|
|
1692
|
+
except Exception as e:
|
|
1693
|
+
if isinstance(e, TencentCloudSDKException):
|
|
1694
|
+
raise
|
|
1695
|
+
else:
|
|
1696
|
+
raise TencentCloudSDKException(type(e).__name__, str(e))
|
|
1697
|
+
|
|
1698
|
+
|
|
1591
1699
|
def DescribeChannelFlowEvidenceReport(self, request):
|
|
1592
|
-
"""
|
|
1700
|
+
"""获取出证报告任务执行结果,返回报告 URL。
|
|
1701
|
+
|
|
1702
|
+
注意:
|
|
1703
|
+
|
|
1704
|
+
- 使用此功能`需搭配出证套餐` ,使用前请联系对接的客户经理沟通。
|
|
1705
|
+
- 需调用创建并返回出证报告接口<a href="https://qian.tencent.com/developers/partnerApis/certificate/CreateChannelFlowEvidenceReport" target="_blank">提交申请出证报告任务</a>获取报告编号后调用当前接口获取报告链接。
|
|
1706
|
+
|
|
1707
|
+

|
|
1593
1708
|
|
|
1594
1709
|
:param request: Request instance for DescribeChannelFlowEvidenceReport.
|
|
1595
1710
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeChannelFlowEvidenceReportRequest`
|
|
@@ -1678,10 +1793,10 @@ class EssbasicClient(AbstractClient):
|
|
|
1678
1793
|
**第一种**: 需第三方应用的子企业登录控制台进行授权, 授权在**企业中心**的**授权管理**区域, 界面如下图
|
|
1679
1794
|
授权过程需要**子企业超管**扫描跳转到电子签小程序签署<<渠道端下载渠道子客合同功能授权委托书>>
|
|
1680
1795
|
|
|
1681
|
-

|
|
1682
1797
|
|
|
1683
1798
|
**第二种**: 第三方应用的配置接口打开全第三个应用下的所有自己起开通, 需要**渠道方企业的超管**扫描二维码跳转到电子签小程序签署 <<渠道端下载渠道子客合同功能开通知情同意书>>
|
|
1684
|
-

|
|
1685
1800
|
|
|
1686
1801
|
:param request: Request instance for DescribeResourceUrlsByFlows.
|
|
1687
1802
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeResourceUrlsByFlowsRequest`
|
|
@@ -1706,21 +1821,27 @@ class EssbasicClient(AbstractClient):
|
|
|
1706
1821
|
def DescribeTemplates(self, request):
|
|
1707
1822
|
"""通过此接口(DescribeTemplates)查询该第三方平台子客企业在电子签拥有的有效模板,不包括第三方平台模板。
|
|
1708
1823
|
|
|
1824
|
+
**适用场景**
|
|
1825
|
+
该接口常用来配合<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>接口,作为创建合同的前置接口使用。
|
|
1826
|
+
通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的创建。
|
|
1827
|
+
|
|
1828
|
+
**模板的来源**
|
|
1829
|
+
子客企业的模板有两种途径获取
|
|
1830
|
+
- 渠道方(平台方)配置完成后, 分发给同应用的各个子企业
|
|
1831
|
+
- 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
|
|
1832
|
+
|
|
1709
1833
|
**一个模板通常会包含以下结构信息**
|
|
1710
1834
|
|
|
1711
|
-
-
|
|
1835
|
+
- 模板ID, 模板名字等基本信息
|
|
1712
1836
|
- 发起方参与信息Promoter、签署参与方 Recipients,后者会在模板发起合同时用于指定参与方
|
|
1713
1837
|
- 发起方和签署方的填写控件 Components
|
|
1714
1838
|
- 签署方的签署控件 SignComponents
|
|
1715
1839
|
|
|
1716
|
-
|
|
1717
|
-
该接口常用来配合<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>接口,作为创建合同的前置接口使用。
|
|
1718
|
-
通过此接口查询到模板信息后,再通过调用创建合同的接口,指定模板ID,指定模板中需要的填写控件内容等,完成合同文档的的创建。
|
|
1840
|
+

|
|
1719
1841
|
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
-
|
|
1723
|
-
- 子客企业通过CreateConsoleLoginUrl创建的链接登录子客控制台自己创建
|
|
1842
|
+
模板中各元素的层级关系, 所有的填写控件和签署控件都归属某一个角色(通过控件的ComponentRecipientId来关联)
|
|
1843
|
+
|
|
1844
|
+

|
|
1724
1845
|
|
|
1725
1846
|
|
|
1726
1847
|
**注意**
|
|
@@ -1749,8 +1870,9 @@ class EssbasicClient(AbstractClient):
|
|
|
1749
1870
|
|
|
1750
1871
|
|
|
1751
1872
|
def DescribeUsage(self, request):
|
|
1752
|
-
"""此接口(DescribeUsage
|
|
1753
|
-
|
|
1873
|
+
"""此接口(DescribeUsage)用于获取此应用下子客企业的合同消耗数量。
|
|
1874
|
+
|
|
1875
|
+
注: 此接口**每日限频50次**,若要扩大限制次数,请提前与客服经理或邮件至e-contract@tencent.com进行联系。
|
|
1754
1876
|
|
|
1755
1877
|
:param request: Request instance for DescribeUsage.
|
|
1756
1878
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeUsageRequest`
|
|
@@ -1778,8 +1900,8 @@ class EssbasicClient(AbstractClient):
|
|
|
1778
1900
|
|
|
1779
1901
|
注:
|
|
1780
1902
|
<ul>
|
|
1781
|
-
<li>仅支持下载
|
|
1782
|
-
<li>
|
|
1903
|
+
<li>仅支持下载 <b>本企业</b> 下合同,链接会 <b>登录企业控制台</b> </li>
|
|
1904
|
+
<li> <b>链接仅可使用一次</b>,不可重复使用</li>
|
|
1783
1905
|
</ul>
|
|
1784
1906
|
|
|
1785
1907
|
:param request: Request instance for GetDownloadFlowUrl.
|
|
@@ -1852,23 +1974,24 @@ class EssbasicClient(AbstractClient):
|
|
|
1852
1974
|
|
|
1853
1975
|
|
|
1854
1976
|
def OperateChannelTemplate(self, request):
|
|
1855
|
-
"""此接口(OperateChannelTemplate
|
|
1856
|
-
|
|
1857
|
-
|
|
1858
|
-
|
|
1859
|
-
|
|
1860
|
-
|
|
1861
|
-
|
|
1862
|
-
|
|
1863
|
-
|
|
1864
|
-
|
|
1865
|
-
|
|
1866
|
-
|
|
1867
|
-
|
|
1868
|
-
|
|
1869
|
-
|
|
1870
|
-
|
|
1871
|
-
|
|
1977
|
+
"""此接口(OperateChannelTemplate)用于针对第三方应用平台模板库中的模板对子客企业发布授权的查询和设置。
|
|
1978
|
+
平台模板库中的模板的位置在控制台 企业应用管理 中下面的应用模板库管理目录, 可以参照下图位置
|
|
1979
|
+

|
|
1980
|
+
|
|
1981
|
+
# 支持的操作
|
|
1982
|
+
|
|
1983
|
+
## 1. 查询模板的子客企业授权 (OperateType=SELECT)
|
|
1984
|
+
- 查询模板的授权子企业列表
|
|
1985
|
+
|
|
1986
|
+
## 2. 修改模板的子客企业授权 (OperateType=UPDATE)
|
|
1987
|
+
- 当模板未发布时,可以修改模板的模板授权范围是**所有第三方应用合作企业**(AuthTag设置为all)或者**指定第三方应用合作企业**(AuthTag设置为part),**当模板发布后,不可做此修改**
|
|
1988
|
+
- 如果模板是部分授权, 可通过ProxyOrganizationOpenIds增加子客的授权范围。
|
|
1989
|
+
|
|
1990
|
+
## 3. 取消模板的子客企业授权 (OperateType=DELETE)
|
|
1991
|
+
- 对子客企业进行模板库中模板授权范围的进行删除操作。
|
|
1992
|
+
- 主要对于手动领取的模板,去除授权后子客在模板库中看不到,就无法再领取了。但是**已经领取过成为自有模板的不会同步删除**。
|
|
1993
|
+
- 对于自动领取的模板,由于已经下发,更改授权不会影响。
|
|
1994
|
+
- 如果要同步删除子客自有模板库中的模板,请使用OperateType=UPDATE+Available参数处理。
|
|
1872
1995
|
|
|
1873
1996
|
:param request: Request instance for OperateChannelTemplate.
|
|
1874
1997
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.OperateChannelTemplateRequest`
|
|
@@ -1916,9 +2039,20 @@ class EssbasicClient(AbstractClient):
|
|
|
1916
2039
|
|
|
1917
2040
|
|
|
1918
2041
|
def SyncProxyOrganization(self, request):
|
|
1919
|
-
"""此接口(SyncProxyOrganization
|
|
1920
|
-
|
|
1921
|
-
|
|
2042
|
+
"""此接口(SyncProxyOrganization)用于同步第三方平台子客企业信息,包括企业名称、企业营业执照、企业统一社会信用代码和法人姓名等,便于子客企业在企业激活过程中无需手动上传营业执照或补充企业信息。
|
|
2043
|
+
|
|
2044
|
+
注意:
|
|
2045
|
+
|
|
2046
|
+
- **需要在<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>前同步的企业信息**, 否则会出现信息同步没有用的情形
|
|
2047
|
+
- **企业信息需要和营业执照信息对应**, 否则会出现激活过程验证不通过的问题
|
|
2048
|
+
|
|
2049
|
+

|
|
2050
|
+
|
|
2051
|
+
|
|
2052
|
+
- **企业统一社会信用代码**: 对应上图中的**1**
|
|
2053
|
+
- **第三方平台子客企业名称**: 对应上图中的**2**
|
|
2054
|
+
- **企业法定代表人的名字**:对应上图中的**3**
|
|
2055
|
+
- **企业详细住所**:对应上图中的**4**
|
|
1922
2056
|
|
|
1923
2057
|
:param request: Request instance for SyncProxyOrganization.
|
|
1924
2058
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.SyncProxyOrganizationRequest`
|
|
@@ -1943,16 +2077,16 @@ class EssbasicClient(AbstractClient):
|
|
|
1943
2077
|
def SyncProxyOrganizationOperators(self, request):
|
|
1944
2078
|
"""此接口(SyncProxyOrganizationOperators)用于同步 第三方平台子客企业经办人列表,主要是同步经办人的离职状态。子客Web控制台的组织架构管理,是依赖于第三方应用平台的,无法针对员工做新增/更新/离职等操作。
|
|
1945
2079
|
|
|
1946
|
-
-
|
|
2080
|
+
- **新增员工的场景**: 提前导入员工列表, 然后调用<a href="https://qian.tencent.com/developers/partnerApis/accounts/CreateConsoleLoginUrl" target="_blank">生成子客登录链接</a>分享给对应的员工进行实名, 新增员工后员工的状态为**未实名**, 通过链接实名后状态变为**已实名**, 已实名员工就可以参与合同的发起和签署
|
|
1947
2081
|
|
|
1948
2082
|
- **员工离职的场景**: 将员工置为离职, 员工无法登录控制台和腾讯电子签小程序进行操作了, 同时给此员工分配的openid会被回收可以给其他新员工使用 (离职后员工数据会被置空, 再次加入公司会从零开始) , 若员工信息有误可通过离职后在新增来解决, 离职员工状态为**离职**
|
|
1949
2083
|
|
|
1950
|
-

|
|
1951
2085
|
|
|
1952
2086
|
**注**:
|
|
1953
2087
|
- 新增员工可以配置白名单限制注册使用对应openid的员工必须满足SyncProxyOrganizationOperators导入的(默认生成子客登录链接生成的链接可以任意员工点击注册绑定对应的openid), 此白名单需要咨询接入经理
|
|
1954
2088
|
- <font color='red'>超管和法人无法通过此接口离职</font>, 需要超管和法人将权限转移给其他人后才可通过此接口离职
|
|
1955
|
-
-
|
|
2089
|
+
- 新增员工的场景同ID不同员工会覆盖掉上一个同ID的员工, 如果上一个员工已经实名则不会被覆盖
|
|
1956
2090
|
|
|
1957
2091
|
:param request: Request instance for SyncProxyOrganizationOperators.
|
|
1958
2092
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.SyncProxyOrganizationOperatorsRequest`
|
|
@@ -1983,7 +2117,7 @@ class EssbasicClient(AbstractClient):
|
|
|
1983
2117
|
|
|
1984
2118
|
注:
|
|
1985
2119
|
1. 图片类型(png/jpg/jpeg)限制大小为5M以下, PDF/word/excel等其他格式限制大小为60M以下
|
|
1986
|
-
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为
|
|
2120
|
+
2. <font color='red'>此接口调用时需要单独设置Domain请求域名 </font>, 联调开发环境为 <font color='red'>file.test.ess.tencent.cn</font>,正式环境需要设置为<font color='red'>file.ess.tencent.cn</font>,代码示例
|
|
1987
2121
|
```
|
|
1988
2122
|
HttpProfile httpProfile = new HttpProfile();
|
|
1989
2123
|
httpProfile.setEndpoint("file.test.ess.tencent.cn");
|