tencentcloud-sdk-python-essbasic 3.0.1062__tar.gz → 3.0.1070__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.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/PKG-INFO +1 -1
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/setup.py +1 -1
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/__init__.py +1 -1
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/v20210526/essbasic_client.py +83 -35
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/v20210526/models.py +231 -221
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud_sdk_python_essbasic.egg-info/PKG-INFO +1 -1
- tencentcloud-sdk-python-essbasic-3.0.1070/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +1 -0
- tencentcloud-sdk-python-essbasic-3.0.1062/tencentcloud_sdk_python_essbasic.egg-info/requires.txt +0 -1
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/README.rst +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/setup.cfg +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/v20201222/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/v20201222/errorcodes.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/v20201222/essbasic_client.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/v20201222/models.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/v20210526/__init__.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud/essbasic/v20210526/errorcodes.py +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud_sdk_python_essbasic.egg-info/SOURCES.txt +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud_sdk_python_essbasic.egg-info/dependency_links.txt +0 -0
- {tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/tencentcloud_sdk_python_essbasic.egg-info/top_level.txt +0 -0
{tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/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.1070"],
|
|
12
12
|
version=tencentcloud.__version__,
|
|
13
13
|
description='Tencent Cloud Essbasic SDK for Python',
|
|
14
14
|
long_description=open('README.rst').read(),
|
|
@@ -91,9 +91,9 @@ class EssbasicClient(AbstractClient):
|
|
|
91
91
|
|
|
92
92
|
|
|
93
93
|
def ChannelCancelMultiFlowSignQRCode(self, request):
|
|
94
|
-
"""此接口(CancelMultiFlowSignQRCode
|
|
95
|
-
该接口所需的二维码ID,源自[
|
|
96
|
-
|
|
94
|
+
"""此接口(CancelMultiFlowSignQRCode)用于废除取消一码多签签署码。
|
|
95
|
+
该接口所需的二维码ID,源自[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)生成的。
|
|
96
|
+
如果该签署码尚处于有效期内,可通过本接口将其设置为失效状态。
|
|
97
97
|
|
|
98
98
|
:param request: Request instance for ChannelCancelMultiFlowSignQRCode.
|
|
99
99
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.ChannelCancelMultiFlowSignQRCodeRequest`
|
|
@@ -207,7 +207,7 @@ class EssbasicClient(AbstractClient):
|
|
|
207
207
|
注:
|
|
208
208
|
- 使用此接口生成链接,需要提前开通 `使用手机号验证签署方身份` 功能,在 `腾讯电子签网页端-企业设置-拓展服务` 中可以找到。
|
|
209
209
|
- 参与人点击链接后需短信验证码才能查看合同内容。
|
|
210
|
-
- 企业用户批量签署,需要传OrganizationName
|
|
210
|
+
- 企业用户批量签署,需要传OrganizationName(参与方所在企业名称)参数生成签署链接,`请确保此企业已完成腾讯电子签企业认证`。暂时仅支持给`自建应用集成企业` 生成员工批签链接,不支持子客企业。
|
|
211
211
|
- 个人批量签署,签名区`仅支持手写签名`。
|
|
212
212
|
|
|
213
213
|
:param request: Request instance for ChannelCreateBatchSignUrl.
|
|
@@ -721,7 +721,7 @@ class EssbasicClient(AbstractClient):
|
|
|
721
721
|
|
|
722
722
|
|
|
723
723
|
def ChannelCreateMultiFlowSignQRCode(self, request):
|
|
724
|
-
"""此接口(ChannelCreateMultiFlowSignQRCode
|
|
724
|
+
"""此接口(ChannelCreateMultiFlowSignQRCode)用于创建一码多签签署码。
|
|
725
725
|
|
|
726
726
|
**适用场景**:
|
|
727
727
|
签署人可通过扫描二维码补充签署信息进行实名签署。常用于提前不知道签署人的身份信息场景,例如:劳务工招工、大批量员工入职等场景。
|
|
@@ -731,11 +731,11 @@ class EssbasicClient(AbstractClient):
|
|
|
731
731
|
- 模板中配置的签署顺序是无序
|
|
732
732
|
- B端企业的签署方式是静默签署
|
|
733
733
|
- B端企业是非首位签署
|
|
734
|
-
2.
|
|
734
|
+
2. 通过扫描一码多签签署码发起的合同,合同涉及到的回调消息可参考文档[合同发起及签署相关回调
|
|
735
735
|
]( https://qian.tencent.com/developers/partner/callback_types_contracts_sign)
|
|
736
|
-
3.
|
|
736
|
+
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)
|
|
737
737
|
|
|
738
|
-
|
|
738
|
+
签署码的样式如下图:
|
|
739
739
|

|
|
740
740
|
|
|
741
741
|
:param request: Request instance for ChannelCreateMultiFlowSignQRCode.
|
|
@@ -815,6 +815,41 @@ class EssbasicClient(AbstractClient):
|
|
|
815
815
|
注意:
|
|
816
816
|
1. 只支持PC浏览器操作使用
|
|
817
817
|
|
|
818
|
+
**嵌入式签署人-各种场景传参说明**:
|
|
819
|
+
|
|
820
|
+
<table>
|
|
821
|
+
<thead>
|
|
822
|
+
<tr>
|
|
823
|
+
<th>场景编号</th>
|
|
824
|
+
<th>可作为签署方的类型</th>
|
|
825
|
+
<th>签署方传参说明</th>
|
|
826
|
+
</tr>
|
|
827
|
+
</thead>
|
|
828
|
+
|
|
829
|
+
<tbody>
|
|
830
|
+
<tr>
|
|
831
|
+
<td>场景一</td>
|
|
832
|
+
<td>第三方子企业A员工</td>
|
|
833
|
+
<td>OpenId、OrganizationName、OrganizationOpenId必传 ,ApproverType设置为ORGANIZATION</td>
|
|
834
|
+
</tr>
|
|
835
|
+
<tr>
|
|
836
|
+
<td>场景二</td>
|
|
837
|
+
<td>第三方子企业B员工</td>
|
|
838
|
+
<td>OpenId、OrganizationOpenId、OrganizationName必传, ApproverType设置为ORGANIZATION</td>
|
|
839
|
+
</tr>
|
|
840
|
+
<tr>
|
|
841
|
+
<td>场景三</td>
|
|
842
|
+
<td>SaaS平台企业员工</td>
|
|
843
|
+
<td>Name、Mobile、OrganizationName必传,NotChannelOrganization=True。 ApproverType设置为ORGANIZATION</td>
|
|
844
|
+
</tr>
|
|
845
|
+
<tr>
|
|
846
|
+
<td>场景四</td>
|
|
847
|
+
<td>个人/自然人</td>
|
|
848
|
+
<td>Name、Mobile必传, ApproverType设置为PERSON</td>
|
|
849
|
+
</tr>
|
|
850
|
+
</tbody>
|
|
851
|
+
</table>
|
|
852
|
+
|
|
818
853
|
嵌入的页面样式如下:
|
|
819
854
|

|
|
820
855
|
|
|
@@ -1489,16 +1524,26 @@ class EssbasicClient(AbstractClient):
|
|
|
1489
1524
|
|
|
1490
1525
|
|
|
1491
1526
|
def CreateChannelOrganizationInfoChangeUrl(self, request):
|
|
1492
|
-
"""此接口(CreateChannelOrganizationInfoChangeUrl
|
|
1527
|
+
"""此接口(CreateChannelOrganizationInfoChangeUrl)用于创建子客企业信息变更链接。
|
|
1493
1528
|
|
|
1529
|
+
<h3 id="1">支持变更链接类型,通过入参 Endpoint 指定,默认为WEIXINAPP。</h3>
|
|
1494
1530
|
|
|
1495
|
-
<
|
|
1531
|
+
<h4 id="WEIXINAPP">WEIXINAPP</h4>
|
|
1532
|
+
<p>创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。</p>
|
|
1533
|
+
|
|
1534
|
+
<h4 id="APP">APP</h4>
|
|
1535
|
+
<p>创建变更小程序链接,可从第三方APP跳转到微信腾讯电子签小程序进行更换。</p>
|
|
1536
|
+
|
|
1537
|
+
|
|
1538
|
+
<h3 id="2">支持创建企业超管变更链接或企业基础信息变更链接,通过入参 ChangeType 指定。</h3>
|
|
1539
|
+
|
|
1540
|
+
<h4 id="1-企业超管变更">1. 企业超管变更</h4>
|
|
1496
1541
|
|
|
1497
1542
|
<p>换成企业的其他员工来当超管</p>
|
|
1498
1543
|
|
|
1499
|
-
<
|
|
1544
|
+
<h4 id="2-企业基础信息变更">2. 企业基础信息变更</h4>
|
|
1500
1545
|
|
|
1501
|
-
<
|
|
1546
|
+
<h5 id="可以变动">可以变动</h5>
|
|
1502
1547
|
|
|
1503
1548
|
<ul>
|
|
1504
1549
|
<li>企业名称<br>
|
|
@@ -1508,7 +1553,7 @@ class EssbasicClient(AbstractClient):
|
|
|
1508
1553
|
<li>企业地址和所在地</li>
|
|
1509
1554
|
</ul>
|
|
1510
1555
|
|
|
1511
|
-
<
|
|
1556
|
+
<h5 id="不可变动">不可变动</h5>
|
|
1512
1557
|
|
|
1513
1558
|
<ul>
|
|
1514
1559
|
<li>统一社会信用代码<br>
|
|
@@ -1520,7 +1565,7 @@ class EssbasicClient(AbstractClient):
|
|
|
1520
1565
|
|
|
1521
1566
|
<ul>
|
|
1522
1567
|
<li>合同: 老合同不做任何处理, 新发起的合同需要用新的企业名字作为签署方, 否则无法签署</li>
|
|
1523
|
-
<li>印章:
|
|
1568
|
+
<li>印章: 会删除所有的印章所有的机构公章,合同专用章,财务专用章和人事专用章, 然后用新企业名称生成新的机构公章,合同专用章,财务专用章和人事专用章, 而法人章不会处理</li>
|
|
1524
1569
|
<li>证书: 企业证书会重新请求CA机构用新企业名称生成新的证书</li>
|
|
1525
1570
|
</ul>
|
|
1526
1571
|
|
|
@@ -1559,6 +1604,7 @@ class EssbasicClient(AbstractClient):
|
|
|
1559
1604
|
<th>子客企业状态</th>
|
|
1560
1605
|
<th>子客企业员工状态</th>
|
|
1561
1606
|
<th>点击链接进入的流程</th>
|
|
1607
|
+
<th>视频样例</th>
|
|
1562
1608
|
</tr>
|
|
1563
1609
|
</thead>
|
|
1564
1610
|
<tbody>
|
|
@@ -1566,16 +1612,19 @@ class EssbasicClient(AbstractClient):
|
|
|
1566
1612
|
<td>企业未激活</td>
|
|
1567
1613
|
<td>员工未认证</td>
|
|
1568
1614
|
<td>进入企业激活流程,首次完成企业激活流程的员工会成为超管</td>
|
|
1615
|
+
<td><a href="https://dyn.ess.tencent.cn/guide/apivideo/CreateConsoleLoginUrl_noverify.mp4" target="_blank">打开</a></td>
|
|
1569
1616
|
</tr>
|
|
1570
1617
|
<tr>
|
|
1571
1618
|
<td>企业已激活</td>
|
|
1572
1619
|
<td>员工未认证</td>
|
|
1573
1620
|
<td>进入员认证并加入企业流程</td>
|
|
1621
|
+
<td>-</td>
|
|
1574
1622
|
</tr>
|
|
1575
1623
|
<tr>
|
|
1576
1624
|
<td>企业已激活</td>
|
|
1577
1625
|
<td>员工已认证</td>
|
|
1578
1626
|
<td>进入子客企业Web控制台</td>
|
|
1627
|
+
<td>-</td>
|
|
1579
1628
|
</tr>
|
|
1580
1629
|
</tbody>
|
|
1581
1630
|
</table>
|
|
@@ -1790,8 +1839,8 @@ class EssbasicClient(AbstractClient):
|
|
|
1790
1839
|
| WEIXINAPP | 短链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序(与腾讯电子签官方短信提醒用户签署形式一样)<br> 示例: https://essurl.cn/x9nvWU8fTg|
|
|
1791
1840
|
| LONGURL2WEIXINAPP | 长链跳转腾讯电子签小程序签署场景 | 点击链接打开电子签小程序, 是WEIXINAPP生成短链代表的那个长链|
|
|
1792
1841
|
| CHANNEL | 带有H5引导页的跳转腾讯电子签小程序签署场景 | 点击链接打开一个H5引导页面, 页面中有个"前往小程序"的按钮, 点击后会跳转到腾讯电子签小程序签署场景; 签署完成会回到H5引导页面, 然后跳转到指定创建链接指定的JumpUrl<br>示例: https://res.ess.tencent.cn/cdn/h5-activity-beta/jump-mp.html?use=channel-guide&type=warning&token=uIFKIU8fTd |
|
|
1793
|
-
|APP|
|
|
1794
|
-
|APP|
|
|
1842
|
+
|APP| <font color="red">贵方APP</font>跳转腾讯电子签小程序签署场景| 贵方App直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方App的场景<br>跳转到腾讯电子签小程序的实现可以参考微信的官方文档:<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html" target="_blank">开放能力/打开 App</a> <br> 示例: pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
|
|
1843
|
+
|APP| <font color="red">贵方小程序</font>跳转腾讯电子签小程序签署场景| 贵方小程序直接跳转到小程序后, 在腾讯电子签小程序签署完成后返回贵方小程序的场景<br>跳转到腾讯电子签小程序的实现可以参考微信官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html" target="_blank">全屏方式</a>和<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html " target="_blank">半屏方式</a><br>此时返回的SignUrl就是官方文档中的path<br> 示例:pages/guide?from=default&where=mini& to=CONTRACT_DETAIL& id=yDwiBUUc*duRvquCSX8wd& shortKey=yDwivUA**W1yRsTre3 |
|
|
1795
1844
|
|
|
1796
1845
|
:param request: Request instance for CreateSignUrls.
|
|
1797
1846
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.CreateSignUrlsRequest`
|
|
@@ -1976,14 +2025,20 @@ class EssbasicClient(AbstractClient):
|
|
|
1976
2025
|
|
|
1977
2026
|
def DescribeExtendedServiceAuthInfo(self, request):
|
|
1978
2027
|
"""查询企业扩展服务的开通和授权情况,当前支持查询以下内容:
|
|
1979
|
-
1. 企业自动签
|
|
1980
|
-
2. 企业与港澳台居民签署合同
|
|
1981
|
-
3. 使用手机号验证签署方身份
|
|
1982
|
-
4. 骑缝章
|
|
1983
|
-
5. 拓宽签署方年龄限制
|
|
1984
|
-
6. 下载企业合同/文件
|
|
1985
2028
|
|
|
1986
|
-
|
|
2029
|
+
1. **企业自动签**
|
|
2030
|
+
2. **企业与港澳台居民签署合同**
|
|
2031
|
+
3. **使用手机号验证签署方身份**
|
|
2032
|
+
4. **骑缝章**
|
|
2033
|
+
5. **拓宽签署方年龄限制**
|
|
2034
|
+
6. **下载企业合同/文件**
|
|
2035
|
+
7. **隐藏合同经办人姓名**
|
|
2036
|
+
|
|
2037
|
+
对应能力开通页面在子客控制台-企业中心-拓展服务,如下图所示:
|
|
2038
|
+
|
|
2039
|
+

|
|
2040
|
+
|
|
2041
|
+
注: <font color='red'>所在企业的超管、法人才有权限调用此接口</font>(Agent.ProxyOperator.OpenId 需要传递超管或者法人的OpenId)
|
|
1987
2042
|
|
|
1988
2043
|
:param request: Request instance for DescribeExtendedServiceAuthInfo.
|
|
1989
2044
|
:type request: :class:`tencentcloud.essbasic.v20210526.models.DescribeExtendedServiceAuthInfoRequest`
|
|
@@ -2173,28 +2228,21 @@ class EssbasicClient(AbstractClient):
|
|
|
2173
2228
|
|
|
2174
2229
|
|
|
2175
2230
|
def ModifyExtendedService(self, request):
|
|
2176
|
-
"""
|
|
2231
|
+
"""管理企业扩展服务 ,企业经办人需要是企业超管或者法人。
|
|
2177
2232
|
|
|
2178
2233
|
跳转小程序的几种方式:主要是设置不同的EndPoint
|
|
2179
2234
|
1. 通过链接Url直接跳转到小程序,不需要返回
|
|
2180
2235
|
设置EndPoint为WEIXINAPP,得到链接打开即可。
|
|
2181
2236
|
|
|
2182
2237
|
2. 客户App直接跳转到小程序-->腾讯电子签小程序操作完成-->返回App
|
|
2183
|
-
|
|
2184
|
-
https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html
|
|
2185
|
-
其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
|
2238
|
+
跳转到小程序的实现,参考官方文档<a href="https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/launchApp.html">打开 App</a>
|
|
2186
2239
|
设置EndPoint为APP,得到path。
|
|
2187
2240
|
|
|
2188
|
-
|
|
2189
|
-
|
|
2190
|
-
全屏方式:
|
|
2191
|
-
(https://developers.weixin.qq.com/miniprogram/dev/api/navigate/wx.navigateToMiniProgram.html)
|
|
2192
|
-
半屏方式:
|
|
2193
|
-
(https://developers.weixin.qq.com/miniprogram/dev/framework/open-ability/openEmbeddedMiniProgram.html)
|
|
2194
|
-
其中小程序的原始Id,请联系<对接技术人员>获取,或者查看小程序信息自助获取。
|
|
2241
|
+
3. 客户小程序直接跳到电子签小程序-->腾讯电子签小程序操作完成--->回到客户小程序
|
|
2242
|
+
跳转到小程序的实现,参考官方文档(分为<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>
|
|
2195
2243
|
设置EndPoint为APP,得到path。
|
|
2196
2244
|
|
|
2197
|
-
|
|
2245
|
+
4.其中小程序的原始Id如下,或者查看小程序信息自助获取。
|
|
2198
2246
|
|
|
2199
2247
|
| 小程序 | AppID | 原始ID |
|
|
2200
2248
|
| ------------ | ------------ | ------------ |
|
|
@@ -1642,7 +1642,7 @@ class ChannelCancelMultiFlowSignQRCodeRequest(AbstractModel):
|
|
|
1642
1642
|
</ul>
|
|
1643
1643
|
第三方平台子客企业和员工必须已经经过实名认证
|
|
1644
1644
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
1645
|
-
:param _QrCodeId:
|
|
1645
|
+
:param _QrCodeId: 需要取消的签署码ID,为32位字符串。由[创建一码多签签署码](https://qian.tencent.com/developers/partnerApis/templates/ChannelCreateMultiFlowSignQRCode)返回
|
|
1646
1646
|
:type QrCodeId: str
|
|
1647
1647
|
:param _Operator: 暂未开放
|
|
1648
1648
|
:type Operator: :class:`tencentcloud.essbasic.v20210526.models.UserInfo`
|
|
@@ -1837,9 +1837,9 @@ class ChannelCreateBatchCancelFlowUrlRequest(AbstractModel):
|
|
|
1837
1837
|
<ul>
|
|
1838
1838
|
<li>渠道应用标识: Agent.AppId</li>
|
|
1839
1839
|
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
1840
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
1840
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
1841
1841
|
</ul>
|
|
1842
|
-
|
|
1842
|
+
第三方平台子客企业和员工必须已经过实名认证
|
|
1843
1843
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
1844
1844
|
:param _FlowIds: 要撤销的合同流程ID列表,最多100个,超过100不处理
|
|
1845
1845
|
:type FlowIds: list of str
|
|
@@ -1905,6 +1905,8 @@ class ChannelCreateBatchCancelFlowUrlResponse(AbstractModel):
|
|
|
1905
1905
|
def __init__(self):
|
|
1906
1906
|
r"""
|
|
1907
1907
|
:param _BatchCancelFlowUrl: 批量撤销合同的URL链接, 需要在手机端打开, 有效期24小时
|
|
1908
|
+
|
|
1909
|
+
注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
1908
1910
|
:type BatchCancelFlowUrl: str
|
|
1909
1911
|
:param _FailMessages: 与入参的FlowIds数组一致, 成功生成到撤销链接中,则为"", 不能撤销合同则为失败原因
|
|
1910
1912
|
:type FailMessages: list of str
|
|
@@ -2152,7 +2154,15 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
2152
2154
|
|
|
2153
2155
|
def __init__(self):
|
|
2154
2156
|
r"""
|
|
2155
|
-
:param _Agent:
|
|
2157
|
+
:param _Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
|
2158
|
+
|
|
2159
|
+
此接口下面信息必填。
|
|
2160
|
+
<ul>
|
|
2161
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
2162
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
2163
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
2164
|
+
</ul>
|
|
2165
|
+
第三方平台子客企业和员工必须已经过实名认证
|
|
2156
2166
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
2157
2167
|
:param _Name: 签署方经办人的姓名。
|
|
2158
2168
|
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
@@ -2198,7 +2208,7 @@ class ChannelCreateBatchSignUrlRequest(AbstractModel):
|
|
|
2198
2208
|
<li>请确认该名称与企业营业执照中注册的名称一致。</li>
|
|
2199
2209
|
<li>如果名称中包含英文括号(),请使用中文括号()代替。</li>
|
|
2200
2210
|
<li>请确保此企业已完成腾讯电子签企业认证。</li>
|
|
2201
|
-
<li
|
|
2211
|
+
<li>暂时仅支持给`自建应用集成企业` 生成员工批签链接,不支持子客企业。</li>
|
|
2202
2212
|
</ul>
|
|
2203
2213
|
:type OrganizationName: str
|
|
2204
2214
|
:param _JumpToDetail: 是否直接跳转至合同内容页面进行签署
|
|
@@ -2334,13 +2344,17 @@ class ChannelCreateBatchSignUrlResponse(AbstractModel):
|
|
|
2334
2344
|
r"""
|
|
2335
2345
|
:param _SignUrl: 批量签署链接,以短链形式返回,短链的有效期参考回参中的 ExpiredTime。
|
|
2336
2346
|
|
|
2337
|
-
注:
|
|
2347
|
+
注:
|
|
2348
|
+
1. 非小程序和APP集成使用
|
|
2349
|
+
2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
2338
2350
|
:type SignUrl: str
|
|
2339
2351
|
:param _ExpiredTime: 链接过期时间以 Unix 时间戳格式表示,从生成链接时间起,往后7天有效期。过期后短链将失效,无法打开。
|
|
2340
2352
|
:type ExpiredTime: int
|
|
2341
2353
|
:param _MiniAppPath: 从客户小程序或者客户APP跳转至腾讯电子签小程序进行批量签署的跳转路径
|
|
2342
2354
|
|
|
2343
|
-
注:
|
|
2355
|
+
注:
|
|
2356
|
+
1. 小程序和APP集成使用
|
|
2357
|
+
2. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
2344
2358
|
:type MiniAppPath: str
|
|
2345
2359
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2346
2360
|
:type RequestId: str
|
|
@@ -2988,9 +3002,9 @@ class ChannelCreateFlowByFilesRequest(AbstractModel):
|
|
|
2988
3002
|
|
|
2989
3003
|
此接口下面信息必填。
|
|
2990
3004
|
<ul>
|
|
2991
|
-
<li>渠道应用标识: Agent.
|
|
2992
|
-
<li>第三方平台子客企业标识: Agent.
|
|
2993
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
3005
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
3006
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
3007
|
+
<li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
|
|
2994
3008
|
</ul>
|
|
2995
3009
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
2996
3010
|
:param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
@@ -4279,9 +4293,9 @@ class ChannelCreateMultiFlowSignQRCodeResponse(AbstractModel):
|
|
|
4279
4293
|
|
|
4280
4294
|
def __init__(self):
|
|
4281
4295
|
r"""
|
|
4282
|
-
:param _QrCode:
|
|
4296
|
+
:param _QrCode: 一码多签签署码的基本信息,用户可扫描该二维码进行签署操作。
|
|
4283
4297
|
:type QrCode: :class:`tencentcloud.essbasic.v20210526.models.SignQrCode`
|
|
4284
|
-
:param _SignUrls:
|
|
4298
|
+
:param _SignUrls: 一码多签签署码链接信息,适用于客户系统整合二维码功能。通过链接,用户可直接访问电子签名小程序并签署合同。
|
|
4285
4299
|
:type SignUrls: :class:`tencentcloud.essbasic.v20210526.models.SignUrl`
|
|
4286
4300
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4287
4301
|
:type RequestId: str
|
|
@@ -8710,223 +8724,188 @@ class Component(AbstractModel):
|
|
|
8710
8724
|
|
|
8711
8725
|
def __init__(self):
|
|
8712
8726
|
r"""
|
|
8713
|
-
:param _ComponentId:
|
|
8727
|
+
:param _ComponentId: 控件唯一ID。
|
|
8714
8728
|
|
|
8715
|
-
|
|
8729
|
+
**在绝对定位方式方式下**,ComponentId为控件的ID,长度不能超过30,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
|
|
8730
|
+
|
|
8731
|
+
**在关键字定位方式下**,ComponentId不仅为控件的ID,也是关键字整词。此方式下可以通过"^"来决定是否使用关键字整词匹配能力。
|
|
8732
|
+
|
|
8733
|
+
例:
|
|
8734
|
+
|
|
8735
|
+
- 如传入的关键字<font color="red">"^甲方签署^"</font >,则会在PDF文件中有且仅有"甲方签署"关键字的地方(<font color="red">前后不能有其他字符</font >)进行对应操作。
|
|
8736
|
+
- 如传入的关键字为<font color="red">"甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前后可以有其他字符</font >)都会执行相应操作。
|
|
8737
|
+
- 如传入的关键字为<font color="red">"^甲方签署</font >",则PDF文件中每个出现关键字的位置(<font color="red">前面不能有其他字符</font >)都会执行相应操作。
|
|
8738
|
+
- 如传入的关键字为<font color="red">"甲方签署^</font >",则PDF文件中每个出现关键字的位置(<font color="red">后面不能有其他字符</font >)都会执行相应操作。
|
|
8716
8739
|
|
|
8717
|
-
注:
|
|
8718
|
-
当GenerateMode=KEYWORD时,通过"^"来决定是否使用关键字整词匹配能力。
|
|
8719
|
-
例:当GenerateMode=KEYWORD时,如果传入关键字"^甲方签署^",则会在PDF文件中有且仅有"甲方签署"关键字的地方进行对应操作。
|
|
8720
|
-
如传入的关键字为"甲方签署",则PDF文件中每个出现关键字的位置都会执行相应操作。
|
|
8721
8740
|
|
|
8722
|
-
|
|
8723
|
-
|
|
8741
|
+
注:`控件ID可以在一个PDF中不可重复`
|
|
8742
|
+
|
|
8724
8743
|
:type ComponentId: str
|
|
8725
|
-
:param _ComponentType:
|
|
8726
|
-
|
|
8727
|
-
|
|
8728
|
-
|
|
8729
|
-
|
|
8730
|
-
|
|
8731
|
-
|
|
8732
|
-
|
|
8733
|
-
|
|
8734
|
-
|
|
8735
|
-
|
|
8736
|
-
|
|
8737
|
-
|
|
8738
|
-
|
|
8739
|
-
|
|
8740
|
-
|
|
8741
|
-
|
|
8742
|
-
|
|
8743
|
-
|
|
8744
|
-
|
|
8745
|
-
|
|
8744
|
+
:param _ComponentType: **如果是Component填写控件类型,则可选的字段为**:
|
|
8745
|
+
|
|
8746
|
+
<ul><li> <b>TEXT</b> : 普通文本控件,输入文本字符串;</li>
|
|
8747
|
+
<li> <b>MULTI_LINE_TEXT</b> : 多行文本控件,输入文本字符串;</li>
|
|
8748
|
+
<li> <b>CHECK_BOX</b> : 勾选框控件,若选中填写ComponentValue 填写 true或者 false 字符串;</li>
|
|
8749
|
+
<li> <b>FILL_IMAGE</b> : 图片控件,ComponentValue 填写图片的资源 ID;</li>
|
|
8750
|
+
<li> <b>DYNAMIC_TABLE</b> : 动态表格控件;</li>
|
|
8751
|
+
<li> <b>ATTACHMENT</b> : 附件控件,ComponentValue 填写附件图片的资源 ID列表,以逗号分隔;</li>
|
|
8752
|
+
<li> <b>SELECTOR</b> : 选择器控件,ComponentValue填写选择的字符串内容;</li>
|
|
8753
|
+
<li> <b>DATE</b> : 日期控件;默认是格式化为xxxx年xx月xx日字符串;</li>
|
|
8754
|
+
<li> <b>DISTRICT</b> : 省市区行政区控件,ComponentValue填写省市区行政区字符串内容;</li></ul>
|
|
8755
|
+
|
|
8756
|
+
**如果是SignComponent签署控件类型,则可选的字段为**
|
|
8757
|
+
|
|
8758
|
+
<ul><li> <b>SIGN_SEAL</b> : 签署印章控件;</li>
|
|
8759
|
+
<li> <b>SIGN_DATE</b> : 签署日期控件;</li>
|
|
8760
|
+
<li> <b>SIGN_SIGNATURE</b> : 用户签名控件;</li>
|
|
8761
|
+
<li> <b>SIGN_PERSONAL_SEAL</b> : 个人签署印章控件(使用文件发起暂不支持此类型);</li>
|
|
8762
|
+
<li> <b>SIGN_PAGING_SEAL</b> : 骑缝章;若文件发起,需要对应填充ComponentPosY、ComponentWidth、ComponentHeight</li>
|
|
8763
|
+
<li> <b>SIGN_OPINION</b> : 签署意见控件,用户需要根据配置的签署意见内容,完成对意见内容的确认;</li>
|
|
8764
|
+
<li> <b>SIGN_LEGAL_PERSON_SEAL</b> : 企业法定代表人控件。</li></ul>
|
|
8765
|
+
注:` 表单域的控件不能作为印章和签名控件`
|
|
8746
8766
|
:type ComponentType: str
|
|
8747
|
-
:param _ComponentName:
|
|
8767
|
+
:param _ComponentName: **在绝对定位方式方式下**,ComponentName为控件名,长度不能超过20,只能由中文、字母、数字和下划线组成,可以在后续的操作中使用该名称来引用控件。
|
|
8768
|
+
|
|
8769
|
+
**在表单域定位方式下**,ComponentName不仅为控件名,也是表单域名称。
|
|
8770
|
+
|
|
8771
|
+
注:`控件名可以在一个PDF中可以重复`
|
|
8772
|
+
|
|
8748
8773
|
:type ComponentName: str
|
|
8749
|
-
:param _ComponentRequired:
|
|
8750
|
-
|
|
8774
|
+
:param _ComponentRequired: 如果是<b>填写控件</b>,ComponentRequired表示在填写页面此控件是否必填
|
|
8775
|
+
<ul><li>false(默认):可以不填写</li>
|
|
8776
|
+
<li>true :必须填写此填写控件</li></ul>
|
|
8777
|
+
如果是<b>签署控件</b>,签批控件中签署意见等可以不填写, 其他签署控件不受此字段影响
|
|
8751
8778
|
:type ComponentRequired: bool
|
|
8752
|
-
:param _ComponentRecipientId:
|
|
8779
|
+
:param _ComponentRecipientId: **在通过接口拉取控件信息场景下**,为出参参数,此控件归属的参与方的角色ID角色(即RecipientId),**发起合同时候不要填写此字段留空即可**
|
|
8753
8780
|
:type ComponentRecipientId: str
|
|
8754
|
-
:param _FileIndex:
|
|
8781
|
+
:param _FileIndex: <font color="red">【暂未使用】</font>控件所属文件的序号(取值为:0-N)。 目前单文件的情况下,值一直为0
|
|
8755
8782
|
:type FileIndex: int
|
|
8756
8783
|
:param _GenerateMode: 控件生成的方式:
|
|
8757
|
-
NORMAL
|
|
8758
|
-
FIELD
|
|
8759
|
-
KEYWORD
|
|
8784
|
+
<ul><li> <b>NORMAL</b> : 绝对定位控件</li>
|
|
8785
|
+
<li> <b>FIELD</b> : 表单域</li>
|
|
8786
|
+
<li> <b>KEYWORD</b> : 关键字(设置关键字时,请确保PDF原始文件内是关键字以文字形式保存在PDF文件中,不支持对图片内文字进行关键字查找)</li></ul>
|
|
8760
8787
|
:type GenerateMode: str
|
|
8761
|
-
:param _ComponentWidth:
|
|
8762
|
-
|
|
8788
|
+
:param _ComponentWidth: **在绝对定位方式和关键字定位方式下**,指定控件宽度,控件宽度是指控件在PDF文件中的宽度,单位为pt(点)。
|
|
8789
|
+
|
|
8763
8790
|
:type ComponentWidth: float
|
|
8764
|
-
:param _ComponentHeight:
|
|
8765
|
-
|
|
8791
|
+
:param _ComponentHeight: **在绝对定位方式和关键字定位方式下**,指定控件的高度, 控件高度是指控件在PDF文件中的高度,单位为pt(点)。
|
|
8792
|
+
|
|
8766
8793
|
:type ComponentHeight: float
|
|
8767
|
-
:param _ComponentPage:
|
|
8794
|
+
:param _ComponentPage: **在绝对定位方式方式下**,指定控件所在PDF文件上的页码
|
|
8795
|
+
|
|
8796
|
+
注:
|
|
8797
|
+
1. 页码编号是从<font color="red">1</font>开始编号的。
|
|
8798
|
+
2. <font color="red">页面编号不能超过PDF文件的页码总数</font>。如果指定的页码超过了PDF文件的页码总数,在填写和签署时会出现错误,导致无法正常进行操作。
|
|
8768
8799
|
:type ComponentPage: int
|
|
8769
|
-
:param _ComponentPosX:
|
|
8800
|
+
:param _ComponentPosX: **在绝对定位方式和关键字定位方式下**,可以指定控件横向位置的位置,单位为pt(点)。
|
|
8770
8801
|
:type ComponentPosX: float
|
|
8771
|
-
:param _ComponentPosY:
|
|
8802
|
+
:param _ComponentPosY: **在绝对定位方式和关键字定位方式下**,可以指定控件纵向位置的位置,单位为pt(点)。
|
|
8772
8803
|
:type ComponentPosY: float
|
|
8773
|
-
:param _ComponentExtra:
|
|
8774
|
-
|
|
8775
|
-
|
|
8776
|
-
|
|
8777
|
-
|
|
8778
|
-
|
|
8779
|
-
|
|
8780
|
-
|
|
8781
|
-
|
|
8782
|
-
|
|
8783
|
-
|
|
8784
|
-
|
|
8785
|
-
|
|
8786
|
-
|
|
8787
|
-
|
|
8788
|
-
|
|
8789
|
-
|
|
8790
|
-
|
|
8791
|
-
|
|
8792
|
-
|
|
8793
|
-
|
|
8794
|
-
|
|
8795
|
-
|
|
8796
|
-
|
|
8797
|
-
|
|
8798
|
-
|
|
8799
|
-
|
|
8800
|
-
|
|
8801
|
-
|
|
8802
|
-
5 Gaps:: 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数
|
|
8804
|
+
:param _ComponentExtra: **在所有的定位方式下**,控件的扩展参数,为<font color="red">JSON格式</font>,不同类型的控件会有部分非通用参数。
|
|
8805
|
+
|
|
8806
|
+
<font color="red">ComponentType为TEXT、MULTI_LINE_TEXT时</font>,支持以下参数:
|
|
8807
|
+
<ul><li> <b>Font</b>:目前只支持黑体、宋体</li>
|
|
8808
|
+
<li> <b>FontSize</b>: 范围12 :72</li>
|
|
8809
|
+
<li> <b>FontAlign</b>: Left/Right/Center,左对齐/居中/右对齐</li>
|
|
8810
|
+
<li> <b>FontColor</b>:字符串类型,格式为RGB颜色数字</li></ul>
|
|
8811
|
+
<b>参数样例</b>:`{"FontColor":"255,0,0","FontSize":12}`
|
|
8812
|
+
|
|
8813
|
+
<font color="red">ComponentType为FILL_IMAGE时</font>,支持以下参数:
|
|
8814
|
+
<ul><li> <b>NotMakeImageCenter</b>:bool。是否设置图片居中。false:居中(默认)。 true : 不居中</li>
|
|
8815
|
+
<li> <b>FillMethod</b> : int. 填充方式。0-铺满(默认);1-等比例缩放</li></ul>
|
|
8816
|
+
|
|
8817
|
+
<font color="red">ComponentType为SIGN_SIGNATURE类型时</font>,可以**ComponentTypeLimit**参数控制签署方式
|
|
8818
|
+
<ul><li> <b>HANDWRITE</b> : 手写签名</li>
|
|
8819
|
+
<li> <b>OCR_ESIGN</b> : AI智能识别手写签名</li>
|
|
8820
|
+
<li> <b>ESIGN</b> : 个人印章类型</li>
|
|
8821
|
+
<li> <b>SYSTEM_ESIGN</b> : 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)</li>
|
|
8822
|
+
<li> <b>IMG_ESIGN</b> : 图片印章(该类型支持用户在签署将上传的PNG格式的图片作为签名)</li></ul>
|
|
8823
|
+
<b>参考样例</b>:`{"ComponentTypeLimit": ["SYSTEM_ESIGN"]}`
|
|
8824
|
+
印章的对应关系参考下图
|
|
8825
|
+

|
|
8826
|
+
|
|
8827
|
+
<font color="red">ComponentType为SIGN_DATE时</font>,支持以下参数:
|
|
8828
|
+
<ul><li> <b>Font</b> :字符串类型目前只支持"黑体"、"宋体",如果不填默认为"黑体"</li>
|
|
8829
|
+
<li> <b>FontSize</b> : 数字类型,范围6-72,默认值为12</li>
|
|
8830
|
+
<li> <b>FontAlign</b> : 字符串类型,可取Left/Right/Center,对应左对齐/居中/右对齐</li>
|
|
8831
|
+
<li> <b>Format</b> : 字符串类型,日期格式,必须是以下五种之一 “yyyy m d”,”yyyy年m月d日”,”yyyy/m/d”,”yyyy-m-d”,”yyyy.m.d”。</li>
|
|
8832
|
+
<li> <b>Gaps</b> : 字符串类型,仅在Format为“yyyy m d”时起作用,格式为用逗号分开的两个整数,例如”2,2”,两个数字分别是日期格式的前后两个空隙中的空格个数</li></ul>
|
|
8803
8833
|
如果extra参数为空,默认为”yyyy年m月d日”格式的居中日期
|
|
8804
8834
|
特别地,如果extra中Format字段为空或无法被识别,则extra参数会被当作默认值处理(Font,FontSize,Gaps和FontAlign都不会起效)
|
|
8805
|
-
|
|
8806
|
-
|
|
8807
|
-
ComponentType为SIGN_SEAL类型时,支持以下参数:
|
|
8808
|
-
1.PageRanges:PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)
|
|
8809
|
-
参数样例: "ComponentExtra":"{"PageRanges":[{"BeginPage":1,"EndPage":-1}]}"
|
|
8810
|
-
:type ComponentExtra: str
|
|
8811
|
-
:param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
8812
|
-
TEXT - 文本内容
|
|
8813
|
-
MULTI_LINE_TEXT - 文本内容
|
|
8814
|
-
CHECK_BOX - true/false
|
|
8815
|
-
FILL_IMAGE、ATTACHMENT - 附件的FileId,需要通过UploadFiles接口上传获取
|
|
8816
|
-
SELECTOR - 选项值
|
|
8817
|
-
DATE - 默认是格式化为xxxx年xx月xx日
|
|
8818
|
-
DYNAMIC_TABLE - 传入json格式的表格内容,具体见数据结构FlowInfo:https://cloud.tencent.com/document/api/1420/61525#FlowInfo
|
|
8819
|
-
SIGN_SEAL - 印章ID
|
|
8820
|
-
SIGN_PAGING_SEAL - 可以指定印章ID
|
|
8821
|
-
|
|
8822
|
-
控件值约束说明:
|
|
8823
|
-
企业全称控件:
|
|
8824
|
-
约束:企业名称中文字符中文括号
|
|
8825
|
-
检查正则表达式:/^[\u3400-\u4dbf\u4e00-\u9fa5()]+$/
|
|
8826
|
-
|
|
8827
|
-
统一社会信用代码控件:
|
|
8828
|
-
检查正则表达式:/^[A-Z0-9]{1,18}$/
|
|
8829
|
-
|
|
8830
|
-
法人名称控件:
|
|
8831
|
-
约束:最大50个字符,2到25个汉字或者1到50个字母
|
|
8832
|
-
检查正则表达式:/^([\u3400-\u4dbf\u4e00-\u9fa5.·]{2,25}|[a-zA-Z·,\s-]{1,50})$/
|
|
8833
|
-
|
|
8834
|
-
签署意见控件:
|
|
8835
|
-
约束:签署意见最大长度为50字符
|
|
8836
|
-
|
|
8837
|
-
签署人手机号控件:
|
|
8838
|
-
约束:国内手机号 13,14,15,16,17,18,19号段长度11位
|
|
8839
|
-
|
|
8840
|
-
签署人身份证控件:
|
|
8841
|
-
约束:合法的身份证号码检查
|
|
8842
|
-
|
|
8843
|
-
控件名称:
|
|
8844
|
-
约束:控件名称最大长度为20字符
|
|
8845
|
-
|
|
8846
|
-
单行文本控件:
|
|
8847
|
-
约束:只允许输入中文,英文,数字,中英文标点符号
|
|
8848
|
-
|
|
8849
|
-
多行文本控件:
|
|
8850
|
-
约束:只允许输入中文,英文,数字,中英文标点符号
|
|
8851
|
-
|
|
8852
|
-
勾选框控件:
|
|
8853
|
-
约束:选择填字符串true,不选填字符串false
|
|
8854
|
-
|
|
8855
|
-
选择器控件:
|
|
8856
|
-
约束:同单行文本控件约束,填写选择值中的字符串
|
|
8857
|
-
|
|
8858
|
-
数字控件:
|
|
8859
|
-
约束:请输入有效的数字(可带小数点)
|
|
8860
|
-
检查正则表达式:/^(-|\+)?\d+(\.\d+)?$/
|
|
8835
|
+
<b>参数样例</b>: ` "{"Format":"yyyy m d","FontSize":12,"Gaps":"2,2", "FontAlign":"Right"}"`
|
|
8861
8836
|
|
|
8862
|
-
|
|
8863
|
-
|
|
8837
|
+
<font color="red">ComponentType为SIGN_SEAL类型时</font>,支持以下参数:
|
|
8838
|
+
<ul><li> <b>PageRanges</b> :PageRange的数组,通过PageRanges属性设置该印章在PDF所有页面上盖章(适用于标书在所有页面盖章的情况)</li></ul>
|
|
8839
|
+
<b>参数样例</b>:` "{"PageRange":[{"BeginPage":1,"EndPage":-1}]}"`
|
|
8864
8840
|
|
|
8865
|
-
附件控件:
|
|
8866
|
-
约束:JPG或PNG图片,上传数量限制,1到6个,最大6个附件
|
|
8867
8841
|
|
|
8868
|
-
|
|
8869
|
-
|
|
8870
|
-
|
|
8871
|
-
|
|
8872
|
-
|
|
8873
|
-
|
|
8874
|
-
|
|
8875
|
-
|
|
8876
|
-
|
|
8877
|
-
|
|
8878
|
-
|
|
8879
|
-
|
|
8880
|
-
|
|
8881
|
-
|
|
8882
|
-
|
|
8883
|
-
|
|
8884
|
-
|
|
8885
|
-
|
|
8886
|
-
|
|
8842
|
+
<font color="red">关键字模式下支持关键字找不到的情况下不进行报错的设置</font>
|
|
8843
|
+
<ul><li> <b>IgnoreKeywordError</b> :1-关键字查找不到时不进行报错</li></ul>
|
|
8844
|
+
场景说明:如果使用关键字进行定位,但是指定的PDF文件中又没有设置的关键字时,发起合同会进行关键字是否存在的校验,如果关键字不存在,会进行报错返回。如果不希望进行报错,可以设置"IgnoreKeywordError"来忽略错误。请注意,如果关键字签署控件对应的签署方在整个PDF文件中一个签署控件都没有,还是会触发报错逻辑。
|
|
8845
|
+
<b>参数样例</b>:` "{"IgnoreKeywordError":1}"`
|
|
8846
|
+
:type ComponentExtra: str
|
|
8847
|
+
:param _ComponentValue: 控件填充vaule,ComponentType和传入值类型对应关系:
|
|
8848
|
+
<ul><li> <b>TEXT</b> : 文本内容</li>
|
|
8849
|
+
<li> <b>MULTI_LINE_TEXT</b> : 文本内容</li>
|
|
8850
|
+
<li> <b>CHECK_BOX</b> : true/false</li>
|
|
8851
|
+
<li> <b>FILL_IMAGE、ATTACHMENT</b> : 附件的FileId,需要通过UploadFiles接口上传获取</li>
|
|
8852
|
+
<li> <b>SELECTOR</b> : 选项值</li>
|
|
8853
|
+
<li> <b>DYNAMIC_TABLE</b> - 传入json格式的表格内容,详见说明:[数据表格](https://qian.tencent.com/developers/company/dynamic_table)</li>
|
|
8854
|
+
<li> <b>DATE</b> : 默认是格式化为xxxx年xx月xx日</li>
|
|
8855
|
+
<li> <b>SIGN_SEAL</b> : 印章ID,于控制台查询获取</li>
|
|
8856
|
+
<li> <b>SIGN_PAGING_SEAL</b> : 可以指定印章ID,于控制台查询获取</li></ul>
|
|
8857
|
+
|
|
8858
|
+
|
|
8859
|
+
<b>控件值约束说明</b>:
|
|
8860
|
+
<table> <thead> <tr> <th>特殊控件</th> <th>填写约束</th> </tr> </thead> <tbody> <tr> <td>企业全称控件</td> <td>企业名称中文字符中文括号</td> </tr> <tr> <td>统一社会信用代码控件</td> <td>企业注册的统一社会信用代码</td> </tr> <tr> <td>法人名称控件</td> <td>最大50个字符,2到25个汉字或者1到50个字母</td> </tr> <tr> <td>签署意见控件</td> <td>签署意见最大长度为50字符</td> </tr> <tr> <td>签署人手机号控件</td> <td>国内手机号 13,14,15,16,17,18,19号段长度11位</td> </tr> <tr> <td>签署人身份证控件</td> <td>合法的身份证号码检查</td> </tr> <tr> <td>控件名称</td> <td>控件名称最大长度为20字符,不支持表情</td> </tr> <tr> <td>单行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>多行文本控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>勾选框控件</td> <td>选择填字符串true,不选填字符串false</td> </tr> <tr> <td>选择器控件</td> <td>同单行文本控件约束,填写选择值中的字符串</td> </tr> <tr> <td>数字控件</td> <td>请输入有效的数字(可带小数点)</td> </tr> <tr> <td>日期控件</td> <td>格式:yyyy年mm月dd日</td> </tr> <tr> <td>附件控件</td> <td>JPG或PNG图片,上传数量限制,1到6个,最大6个附件,填写上传的资源ID</td> </tr> <tr> <td>图片控件</td> <td>JPG或PNG图片,填写上传的图片资源ID</td> </tr> <tr> <td>邮箱控件</td> <td>有效的邮箱地址, w3c标准</td> </tr> <tr> <td>地址控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>省市区控件</td> <td>只允许输入中文,英文,数字,中英文标点符号,不支持表情</td> </tr> <tr> <td>性别控件</td> <td>选择值中的字符串</td> </tr> <tr> <td>学历控件</td> <td>选择值中的字符串</td> </tr> </tbody> </table>
|
|
8861
|
+
注: `部分特殊控件需要在控制台配置模板形式创建`
|
|
8887
8862
|
:type ComponentValue: str
|
|
8888
|
-
:param _ComponentDateFontSize:
|
|
8889
|
-
|
|
8890
|
-
签署区日期控件会转换成图片格式并带存证,需要通过字体决定图片大小
|
|
8863
|
+
:param _ComponentDateFontSize: <font color="red">【暂未使用】</font>日期签署控件的字号,默认为 12
|
|
8891
8864
|
:type ComponentDateFontSize: int
|
|
8892
|
-
:param _DocumentId:
|
|
8865
|
+
:param _DocumentId: <font color="red">【暂未使用】</font>控件归属的文档的ID, **发起合同时候不要填写此字段留空即可**
|
|
8893
8866
|
:type DocumentId: str
|
|
8894
|
-
:param _ComponentDescription:
|
|
8867
|
+
:param _ComponentDescription: <font color="red">【暂未使用】</font>控件描述,用户自定义,不影响合同发起流程
|
|
8895
8868
|
:type ComponentDescription: str
|
|
8896
|
-
:param _OffsetX:
|
|
8869
|
+
:param _OffsetX: **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行横坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏左或偏右,可以通过调整横坐标方向的参数来使控件位置更加准确。
|
|
8870
|
+
注意: `向左调整设置为负数, 向右调整设置成正数`
|
|
8897
8871
|
:type OffsetX: float
|
|
8898
|
-
:param _OffsetY:
|
|
8872
|
+
:param _OffsetY: **如果控件是关键字定位方式**,可以对关键字定位出来的区域进行纵坐标方向的调整,单位为pt(点)。例如,如果关键字定位出来的区域偏上或偏下,可以通过调整纵坐标方向的参数来使控件位置更加准确。
|
|
8873
|
+
注意: `向上调整设置为负数, 向下调整设置成正数`
|
|
8899
8874
|
:type OffsetY: float
|
|
8900
|
-
:param _ChannelComponentId:
|
|
8901
|
-
如果不为空,属于平台企业预设控件;
|
|
8875
|
+
:param _ChannelComponentId: <font color="red">【暂未使用】</font>第三方应用集成平台模板控件 ID 标识
|
|
8902
8876
|
:type ChannelComponentId: str
|
|
8903
|
-
:param _KeywordOrder:
|
|
8904
|
-
Positive
|
|
8905
|
-
Reverse
|
|
8906
|
-
|
|
8907
|
-
|
|
8877
|
+
:param _KeywordOrder: **如果控件是关键字定位方式**,指定关键字排序规则时,可以选择Positive或Reverse两种排序方式。
|
|
8878
|
+
<ul><li> <b>Positive</b> :表示正序,即根据关键字在PDF文件内的顺序进行排列</li>
|
|
8879
|
+
<li> <b>Reverse</b> :表示倒序,即根据关键字在PDF文件内的反序进行排列</li></ul>
|
|
8880
|
+
|
|
8881
|
+
在指定KeywordIndexes时,如果使用Positive排序方式,0代表在PDF内查找内容时,查找到的第一个关键字;如果使用Reverse排序方式,0代表在PDF内查找内容时,查找到的最后一个关键字。
|
|
8908
8882
|
:type KeywordOrder: str
|
|
8909
|
-
:param _KeywordPage:
|
|
8910
|
-
指定页码后,将只在指定的页码内查找关键字,非该页码的关键字将不会查询出来
|
|
8883
|
+
:param _KeywordPage: **如果控件是关键字定位方式**,在KeywordPage中指定关键字页码时,将只会在该页码中查找关键字,非该页码的关键字将不会查询出来。如果不设置查找所有页面中的关键字。
|
|
8911
8884
|
:type KeywordPage: int
|
|
8912
|
-
:param _RelativeLocation:
|
|
8913
|
-
Middle
|
|
8914
|
-
Below
|
|
8915
|
-
Right
|
|
8916
|
-
LowerRight
|
|
8917
|
-
UpperRight
|
|
8885
|
+
:param _RelativeLocation: **如果控件是关键字定位方式**,关键字生成的区域的对齐方式, 可以设置下面的值
|
|
8886
|
+
<ul><li> <b>Middle</b> :居中</li>
|
|
8887
|
+
<li> <b>Below</b> :正下方</li>
|
|
8888
|
+
<li> <b>Right</b> :正右方</li>
|
|
8889
|
+
<li> <b>LowerRight</b> :右上角</li>
|
|
8890
|
+
<li> <b>UpperRight</b> :右下角。</li></ul>
|
|
8918
8891
|
示例:如果设置Middle的关键字盖章,则印章的中心会和关键字的中心重合,如果设置Below,则印章在关键字的正下方
|
|
8919
8892
|
:type RelativeLocation: str
|
|
8920
|
-
:param _KeywordIndexes:
|
|
8921
|
-
|
|
8893
|
+
:param _KeywordIndexes: **如果控件是关键字定位方式**,关键字索引是指在PDF文件中存在多个相同的关键字时,通过索引指定使用哪一个关键字作为最后的结果。可以通过指定多个索引来同时使用多个关键字。例如,[0,2]表示使用PDF文件内第1个和第3个关键字位置作为最后的结果。
|
|
8894
|
+
|
|
8895
|
+
注意:关键字索引是从0开始计数的
|
|
8922
8896
|
:type KeywordIndexes: list of int
|
|
8923
|
-
:param _Placeholder:
|
|
8897
|
+
:param _Placeholder: 填写控件在腾讯电子签小程序填写界面展示的提示信息,例如,在身份证号码填写控件中,提示信息可以设置成“请输入18位身份证号码”。
|
|
8898
|
+
注:`签署控件设置此字段无效`
|
|
8924
8899
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
8925
8900
|
:type Placeholder: str
|
|
8926
|
-
:param _LockComponentValue:
|
|
8901
|
+
:param _LockComponentValue: **web嵌入发起合同场景下**, 是否锁定填写和签署控件值不允许嵌入页面进行编辑
|
|
8902
|
+
<ul><li>false(默认):不锁定控件值,允许在页面编辑控件值</li>
|
|
8903
|
+
<li>true:锁定控件值,在页面编辑控件值</li></ul>
|
|
8927
8904
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
8928
8905
|
:type LockComponentValue: bool
|
|
8929
|
-
:param _ForbidMoveAndDelete:
|
|
8906
|
+
:param _ForbidMoveAndDelete: **web嵌入发起合同场景下**,是否禁止移动和删除填写和签署控件
|
|
8907
|
+
<ul><li> <b>false(默认)</b> :不禁止移动和删除控件</li>
|
|
8908
|
+
<li> <b>true</b> : 可以移动和删除控件</li></ul>
|
|
8930
8909
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
8931
8910
|
:type ForbidMoveAndDelete: bool
|
|
8932
8911
|
"""
|
|
@@ -9559,17 +9538,25 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
|
|
|
9559
9538
|
此接口下面信息必填。
|
|
9560
9539
|
<ul>
|
|
9561
9540
|
<li>渠道应用标识: Agent.AppId</li>
|
|
9562
|
-
<li>第三方平台子客企业标识: Agent.
|
|
9563
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
9541
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
9542
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
9564
9543
|
</ul>
|
|
9544
|
+
第三方平台子客企业和员工必须已经过实名认证
|
|
9565
9545
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
9566
9546
|
:param _ChangeType: 企业信息变更类型,可选类型如下:
|
|
9567
9547
|
<ul><li>**1**:企业超管变更, 可以将超管换成同企业的其他员工</li>
|
|
9568
9548
|
<li>**2**:企业基础信息变更, 可以改企业名称 , 所在地址 , 法人名字等信息</li></ul>
|
|
9569
9549
|
:type ChangeType: int
|
|
9550
|
+
:param _Endpoint: 变更链接类型:
|
|
9551
|
+
<ul>
|
|
9552
|
+
<li>**WEIXINAPP** : 创建变更短链。需要在移动端打开,会跳转到微信腾讯电子签小程序进行更换。(默认)</li>
|
|
9553
|
+
<li>**APP** : 创建变更小程序链接,可从第三方APP跳转到微信腾讯电子签小程序进行更换。</li>
|
|
9554
|
+
</ul>
|
|
9555
|
+
:type Endpoint: str
|
|
9570
9556
|
"""
|
|
9571
9557
|
self._Agent = None
|
|
9572
9558
|
self._ChangeType = None
|
|
9559
|
+
self._Endpoint = None
|
|
9573
9560
|
|
|
9574
9561
|
@property
|
|
9575
9562
|
def Agent(self):
|
|
@@ -9587,12 +9574,21 @@ class CreateChannelOrganizationInfoChangeUrlRequest(AbstractModel):
|
|
|
9587
9574
|
def ChangeType(self, ChangeType):
|
|
9588
9575
|
self._ChangeType = ChangeType
|
|
9589
9576
|
|
|
9577
|
+
@property
|
|
9578
|
+
def Endpoint(self):
|
|
9579
|
+
return self._Endpoint
|
|
9580
|
+
|
|
9581
|
+
@Endpoint.setter
|
|
9582
|
+
def Endpoint(self, Endpoint):
|
|
9583
|
+
self._Endpoint = Endpoint
|
|
9584
|
+
|
|
9590
9585
|
|
|
9591
9586
|
def _deserialize(self, params):
|
|
9592
9587
|
if params.get("Agent") is not None:
|
|
9593
9588
|
self._Agent = Agent()
|
|
9594
9589
|
self._Agent._deserialize(params.get("Agent"))
|
|
9595
9590
|
self._ChangeType = params.get("ChangeType")
|
|
9591
|
+
self._Endpoint = params.get("Endpoint")
|
|
9596
9592
|
memeber_set = set(params.keys())
|
|
9597
9593
|
for name, value in vars(self).items():
|
|
9598
9594
|
property_name = name[1:]
|
|
@@ -9707,10 +9703,10 @@ class CreateConsoleLoginUrlRequest(AbstractModel):
|
|
|
9707
9703
|
注:该参数**仅在企业和员工激活完成,登录控制台场景才生效**。
|
|
9708
9704
|
:type MenuStatus: str
|
|
9709
9705
|
:param _Endpoint: 生成链接的类型:
|
|
9710
|
-
<ul><li>**PC**:(默认)web
|
|
9706
|
+
<ul><li>**PC**:(默认)<font color="red">web控制台</font>链接, 需要在PC浏览器中打开</li>
|
|
9711
9707
|
<li>**CHANNEL**:H5跳转到电子签小程序链接, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
|
|
9712
|
-
<li>**SHORT_URL
|
|
9713
|
-
<li>**APP
|
|
9708
|
+
<li>**SHORT_URL**:<font color="red">H5</font>跳转到电子签小程序链接的短链形式, 一般用于发送短信中带的链接, 打开后进入腾讯电子签小程序</li>
|
|
9709
|
+
<li>**APP**:<font color="red">APP或小程序</font>跳转电子签小程序链接, 一般用于贵方小程序或者APP跳转过来, 打开后进入腾讯电子签小程序</li></ul>
|
|
9714
9710
|
:type Endpoint: str
|
|
9715
9711
|
:param _AutoJumpBackEvent: 触发自动跳转事件,仅对EndPoint为App类型有效,可选值包括:
|
|
9716
9712
|
<ul><li> **VERIFIED** :企业认证完成/员工认证完成后跳回原App/小程序</li></ul>
|
|
@@ -9868,9 +9864,11 @@ class CreateConsoleLoginUrlResponse(AbstractModel):
|
|
|
9868
9864
|
r"""
|
|
9869
9865
|
:param _ConsoleUrl: 跳转链接, 链接的有效期根据企业,员工状态和终端等有区别, 可以参考下表
|
|
9870
9866
|
<table> <thead> <tr> <th>子客企业状态</th> <th>子客企业员工状态</th> <th>Endpoint</th> <th>链接有效期限</th> </tr> </thead> <tbody> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业未激活</td> <td>员工未认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/PC_SHORT_URL</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工未认证</td> <td>PC/CHANNEL/APP</td> <td>一年</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>PC</td> <td>5分钟</td> </tr> <tr> <td>企业已激活</td> <td>员工已认证</td> <td>CHANNEL/APP</td> <td>一年</td> </tr> </tbody> </table>
|
|
9867
|
+
|
|
9871
9868
|
注:
|
|
9872
|
-
|
|
9873
|
-
|
|
9869
|
+
1. <font color="red">链接仅单次有效</font>,每次登录需要需要重新创建新的链接
|
|
9870
|
+
2. 创建的链接应避免被转义,如:&被转义为\u0026;如使用Postman请求后,请选择响应类型为 JSON,否则链接将被转义
|
|
9871
|
+
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
9874
9872
|
|
|
9875
9873
|
:type ConsoleUrl: str
|
|
9876
9874
|
:param _IsActivated: 子客企业是否已开通腾讯电子签,
|
|
@@ -10804,7 +10802,7 @@ class CreateSignUrlsRequest(AbstractModel):
|
|
|
10804
10802
|
<ul>
|
|
10805
10803
|
<li>渠道应用标识: Agent.AppId</li>
|
|
10806
10804
|
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
10807
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
10805
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
10808
10806
|
</ul>
|
|
10809
10807
|
第三方平台子客企业和员工必须已经过实名认证
|
|
10810
10808
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
@@ -11979,10 +11977,11 @@ class DescribeExtendedServiceAuthInfoRequest(AbstractModel):
|
|
|
11979
11977
|
|
|
11980
11978
|
此接口下面信息必填。
|
|
11981
11979
|
<ul>
|
|
11982
|
-
<li>渠道应用标识: Agent.
|
|
11983
|
-
<li>第三方平台子客企业标识: Agent.
|
|
11984
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
11980
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
11981
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
11982
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
11985
11983
|
</ul>
|
|
11984
|
+
第三方平台子客企业和员工必须已经过实名认证
|
|
11986
11985
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
11987
11986
|
"""
|
|
11988
11987
|
self._Agent = None
|
|
@@ -12893,11 +12892,12 @@ class ExtentServiceAuthInfo(AbstractModel):
|
|
|
12893
12892
|
:param _Type: 扩展服务类型
|
|
12894
12893
|
<ul>
|
|
12895
12894
|
<li>AUTO_SIGN 企业自动签(自动签署)</li>
|
|
12896
|
-
<li> OVERSEA_SIGN
|
|
12895
|
+
<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
|
|
12897
12896
|
<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
|
|
12898
12897
|
<li> PAGING_SEAL 骑缝章</li>
|
|
12899
12898
|
<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
|
|
12900
12899
|
<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
|
|
12900
|
+
<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
|
|
12901
12901
|
</ul>
|
|
12902
12902
|
:type Type: str
|
|
12903
12903
|
:param _Name: 扩展服务名称
|
|
@@ -14029,10 +14029,12 @@ class FlowApproverUrlInfo(AbstractModel):
|
|
|
14029
14029
|
|
|
14030
14030
|
def __init__(self):
|
|
14031
14031
|
r"""
|
|
14032
|
-
:param _SignUrl:
|
|
14032
|
+
:param _SignUrl: 签署短链接。
|
|
14033
|
+
|
|
14033
14034
|
注意:
|
|
14034
|
-
|
|
14035
|
-
|
|
14035
|
+
1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
14036
|
+
2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
14037
|
+
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
14036
14038
|
:type SignUrl: str
|
|
14037
14039
|
:param _ApproverType: 签署人类型。
|
|
14038
14040
|
- **PERSON**: 个人
|
|
@@ -14041,10 +14043,12 @@ class FlowApproverUrlInfo(AbstractModel):
|
|
|
14041
14043
|
:type Name: str
|
|
14042
14044
|
:param _Mobile: 签署人手机号。
|
|
14043
14045
|
:type Mobile: str
|
|
14044
|
-
:param _LongUrl:
|
|
14046
|
+
:param _LongUrl: 签署长链接。
|
|
14047
|
+
|
|
14045
14048
|
注意:
|
|
14046
|
-
|
|
14047
|
-
|
|
14049
|
+
1. 该链接有效期为**30分钟**,同时需要注意保密,不要外泄给无关用户。
|
|
14050
|
+
2. 该链接不支持小程序嵌入,仅支持**移动端浏览器**打开。
|
|
14051
|
+
3. <font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
14048
14052
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
14049
14053
|
:type LongUrl: str
|
|
14050
14054
|
"""
|
|
@@ -15370,24 +15374,28 @@ class ModifyExtendedServiceRequest(AbstractModel):
|
|
|
15370
15374
|
|
|
15371
15375
|
此接口下面信息必填。
|
|
15372
15376
|
<ul>
|
|
15373
|
-
<li>渠道应用标识: Agent.
|
|
15374
|
-
<li>第三方平台子客企业标识: Agent.
|
|
15375
|
-
<li>第三方平台子客企业中的员工标识: Agent.
|
|
15377
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
15378
|
+
<li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
|
|
15379
|
+
<li>第三方平台子客企业中的员工标识: Agent.ProxyOperator.OpenId</li>
|
|
15376
15380
|
</ul>
|
|
15381
|
+
第三方平台子客企业和员工必须已经过实名认证
|
|
15377
15382
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
15378
15383
|
:param _ServiceType: 扩展服务类型
|
|
15379
15384
|
<ul>
|
|
15380
15385
|
<li>AUTO_SIGN 企业自动签(自动签署)</li>
|
|
15381
|
-
<li> OVERSEA_SIGN
|
|
15386
|
+
<li> OVERSEA_SIGN 企业与港澳台居民签署合同</li>
|
|
15382
15387
|
<li> MOBILE_CHECK_APPROVER 使用手机号验证签署方身份</li>
|
|
15383
15388
|
<li> PAGING_SEAL 骑缝章</li>
|
|
15384
15389
|
<li> DOWNLOAD_FLOW 授权渠道下载合同 </li>
|
|
15385
15390
|
<li>AGE_LIMIT_EXPANSION 拓宽签署方年龄限制</li>
|
|
15391
|
+
<li>HIDE_OPERATOR_DISPLAY 隐藏合同经办人姓名</li>
|
|
15386
15392
|
</ul>
|
|
15387
15393
|
:type ServiceType: str
|
|
15388
|
-
:param _Operate: 操作类型
|
|
15389
|
-
|
|
15390
|
-
|
|
15394
|
+
:param _Operate: 操作类型
|
|
15395
|
+
<ul>
|
|
15396
|
+
<li>OPEN : 开通</li>
|
|
15397
|
+
<li>CLOSE : 关闭</li>
|
|
15398
|
+
</ul>
|
|
15391
15399
|
:type Operate: str
|
|
15392
15400
|
:param _Endpoint: 链接跳转类型,支持以下类型
|
|
15393
15401
|
<ul>
|
|
@@ -15461,8 +15469,8 @@ class ModifyExtendedServiceResponse(AbstractModel):
|
|
|
15461
15469
|
:param _OperateUrl: 操作跳转链接,有效期24小时
|
|
15462
15470
|
若操作时没有返回跳转链接,表示无需跳转操作,此时会直接开通/关闭服务。
|
|
15463
15471
|
|
|
15464
|
-
当操作类型是 OPEN 且 扩展服务类型是
|
|
15465
|
-
|
|
15472
|
+
当操作类型是 OPEN 且 扩展服务类型是 AUTO_SIGN 或 DOWNLOAD_FLOW 或者 OVERSEA_SIGN 时返回操作链接,
|
|
15473
|
+
返回的链接需要平台方自行触达超管或法人,超管或法人点击链接完成服务开通操作
|
|
15466
15474
|
:type OperateUrl: str
|
|
15467
15475
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
15468
15476
|
:type RequestId: str
|
|
@@ -15770,7 +15778,7 @@ class OperateChannelTemplateRequest(AbstractModel):
|
|
|
15770
15778
|
|
|
15771
15779
|
此接口下面信息必填。
|
|
15772
15780
|
<ul>
|
|
15773
|
-
<li
|
|
15781
|
+
<li>渠道应用标识: Agent.AppId</li>
|
|
15774
15782
|
</ul>
|
|
15775
15783
|
:type Agent: :class:`tencentcloud.essbasic.v20210526.models.Agent`
|
|
15776
15784
|
:param _OperateType: 操作类型,可取值如下:
|
|
@@ -17722,6 +17730,8 @@ class SignUrlInfo(AbstractModel):
|
|
|
17722
17730
|
def __init__(self):
|
|
17723
17731
|
r"""
|
|
17724
17732
|
:param _SignUrl: 签署链接,过期时间为90天
|
|
17733
|
+
|
|
17734
|
+
注:<font color="red">生成的链路后面不能再增加参数</font>(会出现覆盖链接中已有参数导致错误)
|
|
17725
17735
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
17726
17736
|
:type SignUrl: str
|
|
17727
17737
|
:param _Deadline: 合同过期时间戳,单位秒
|
|
@@ -18578,7 +18588,7 @@ class TemplateInfo(AbstractModel):
|
|
|
18578
18588
|
:type Components: list of Component
|
|
18579
18589
|
:param _Recipients: 此模块需要签署的各个参与方的角色列表。RecipientId标识每个参与方角色对应的唯一标识符,用于确定此角色的信息。
|
|
18580
18590
|
:type Recipients: list of Recipient
|
|
18581
|
-
:param _SignComponents:
|
|
18591
|
+
:param _SignComponents: 此模板中的签署控件列表
|
|
18582
18592
|
:type SignComponents: list of Component
|
|
18583
18593
|
:param _TemplateType: 模板类型:1-静默签;3-普通模板
|
|
18584
18594
|
:type TemplateType: int
|
tencentcloud-sdk-python-essbasic-3.0.1070/tencentcloud_sdk_python_essbasic.egg-info/requires.txt
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
tencentcloud-sdk-python-common==3.0.1070
|
tencentcloud-sdk-python-essbasic-3.0.1062/tencentcloud_sdk_python_essbasic.egg-info/requires.txt
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
tencentcloud-sdk-python-common==3.0.1062
|
{tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/README.rst
RENAMED
|
File without changes
|
{tencentcloud-sdk-python-essbasic-3.0.1062 → tencentcloud-sdk-python-essbasic-3.0.1070}/setup.cfg
RENAMED
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|
|
File without changes
|