tencentcloud-sdk-python 3.0.976__py2.py3-none-any.whl → 3.0.977__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.
Potentially problematic release.
This version of tencentcloud-sdk-python might be problematic. Click here for more details.
- tencentcloud/__init__.py +1 -1
- tencentcloud/cdwch/v20200915/cdwch_client.py +23 -0
- tencentcloud/cdwch/v20200915/models.py +75 -0
- tencentcloud/cfw/v20190904/cfw_client.py +644 -0
- tencentcloud/cfw/v20190904/models.py +11557 -5960
- tencentcloud/domain/v20180808/errorcodes.py +1 -1
- tencentcloud/eb/v20210416/eb_client.py +92 -0
- tencentcloud/eb/v20210416/models.py +407 -0
- tencentcloud/ess/v20201111/ess_client.py +41 -16
- tencentcloud/ess/v20201111/models.py +312 -185
- tencentcloud/facefusion/v20181201/facefusion_client.py +3 -1
- tencentcloud/iai/v20180301/iai_client.py +0 -1
- tencentcloud/iai/v20180301/models.py +1 -5
- tencentcloud/iai/v20200303/models.py +2 -6
- tencentcloud/sqlserver/v20180328/models.py +315 -0
- tencentcloud/sqlserver/v20180328/sqlserver_client.py +46 -0
- tencentcloud/tcr/v20190924/models.py +17 -3
- tencentcloud/tcr/v20190924/tcr_client.py +1 -1
- tencentcloud/trocket/v20230308/errorcodes.py +9 -0
- tencentcloud/trocket/v20230308/models.py +985 -6
- tencentcloud/trocket/v20230308/trocket_client.py +92 -0
- tencentcloud/trtc/v20190722/models.py +1 -1
- tencentcloud/waf/v20180125/models.py +94 -180
- tencentcloud/waf/v20180125/waf_client.py +23 -46
- {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/METADATA +1 -1
- {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/RECORD +29 -29
- {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/LICENSE +0 -0
- {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/WHEEL +0 -0
- {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/top_level.txt +0 -0
|
@@ -612,46 +612,44 @@ class AutoSignConfig(AbstractModel):
|
|
|
612
612
|
|
|
613
613
|
def __init__(self):
|
|
614
614
|
r"""
|
|
615
|
-
:param _UserInfo:
|
|
615
|
+
:param _UserInfo: 自动签开通个人用户信息, 包括名字,身份证等
|
|
616
616
|
:type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
|
|
617
|
-
:param
|
|
618
|
-
|
|
619
|
-
|
|
620
|
-
:type CallbackUrl: str
|
|
621
|
-
:param _CertInfoCallback: 是否回调证书信息
|
|
622
|
-
false-不需要 (默认值)
|
|
623
|
-
true-需要
|
|
617
|
+
:param _CertInfoCallback: 是否回调证书信息:
|
|
618
|
+
<ul><li>**false**: 不需要(默认)</li>
|
|
619
|
+
<li>**true**:需要</li></ul>
|
|
624
620
|
:type CertInfoCallback: bool
|
|
625
|
-
:param _UserDefineSeal:
|
|
626
|
-
false
|
|
627
|
-
true
|
|
621
|
+
:param _UserDefineSeal: 是否支持用户自定义签名印章:
|
|
622
|
+
<ul><li>**false**: 不能自己定义(默认)</li>
|
|
623
|
+
<li>**true**: 可以自己定义</li></ul>
|
|
628
624
|
:type UserDefineSeal: bool
|
|
629
|
-
:param _SealImgCallback:
|
|
630
|
-
|
|
631
|
-
|
|
632
|
-
true-需要
|
|
625
|
+
:param _SealImgCallback: 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
|
|
626
|
+
<ul><li>**false**: 不需要(默认)</li>
|
|
627
|
+
<li>**true**: 需要</li></ul>
|
|
633
628
|
:type SealImgCallback: bool
|
|
634
|
-
:param
|
|
635
|
-
|
|
636
|
-
|
|
637
|
-
|
|
638
|
-
|
|
639
|
-
|
|
640
|
-
|
|
641
|
-
|
|
642
|
-
|
|
629
|
+
:param _CallbackUrl: 执行结果的回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
|
|
630
|
+
腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
|
|
631
|
+
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
632
|
+
:type CallbackUrl: str
|
|
633
|
+
:param _VerifyChannels: 开通时候的身份验证方式, 取值为:
|
|
634
|
+
<ul><li>**WEIXINAPP** : 微信人脸识别</li>
|
|
635
|
+
<li>**INSIGHT** : 慧眼人脸认别</li>
|
|
636
|
+
<li>**TELECOM** : 运营商三要素验证</li></ul>
|
|
637
|
+
注:
|
|
638
|
+
<ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
|
|
639
|
+
<li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
|
|
643
640
|
:type VerifyChannels: list of str
|
|
644
|
-
:param _LicenseType:
|
|
645
|
-
|
|
646
|
-
1
|
|
641
|
+
:param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
642
|
+
|
|
643
|
+
<ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
|
644
|
+
<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
|
|
647
645
|
|
|
648
646
|
:type LicenseType: int
|
|
649
647
|
"""
|
|
650
648
|
self._UserInfo = None
|
|
651
|
-
self._CallbackUrl = None
|
|
652
649
|
self._CertInfoCallback = None
|
|
653
650
|
self._UserDefineSeal = None
|
|
654
651
|
self._SealImgCallback = None
|
|
652
|
+
self._CallbackUrl = None
|
|
655
653
|
self._VerifyChannels = None
|
|
656
654
|
self._LicenseType = None
|
|
657
655
|
|
|
@@ -663,14 +661,6 @@ TELECOM : 运营商三要素验证
|
|
|
663
661
|
def UserInfo(self, UserInfo):
|
|
664
662
|
self._UserInfo = UserInfo
|
|
665
663
|
|
|
666
|
-
@property
|
|
667
|
-
def CallbackUrl(self):
|
|
668
|
-
return self._CallbackUrl
|
|
669
|
-
|
|
670
|
-
@CallbackUrl.setter
|
|
671
|
-
def CallbackUrl(self, CallbackUrl):
|
|
672
|
-
self._CallbackUrl = CallbackUrl
|
|
673
|
-
|
|
674
664
|
@property
|
|
675
665
|
def CertInfoCallback(self):
|
|
676
666
|
return self._CertInfoCallback
|
|
@@ -695,6 +685,18 @@ TELECOM : 运营商三要素验证
|
|
|
695
685
|
def SealImgCallback(self, SealImgCallback):
|
|
696
686
|
self._SealImgCallback = SealImgCallback
|
|
697
687
|
|
|
688
|
+
@property
|
|
689
|
+
def CallbackUrl(self):
|
|
690
|
+
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
|
|
691
|
+
|
|
692
|
+
return self._CallbackUrl
|
|
693
|
+
|
|
694
|
+
@CallbackUrl.setter
|
|
695
|
+
def CallbackUrl(self, CallbackUrl):
|
|
696
|
+
warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
|
|
697
|
+
|
|
698
|
+
self._CallbackUrl = CallbackUrl
|
|
699
|
+
|
|
698
700
|
@property
|
|
699
701
|
def VerifyChannels(self):
|
|
700
702
|
return self._VerifyChannels
|
|
@@ -716,10 +718,10 @@ TELECOM : 运营商三要素验证
|
|
|
716
718
|
if params.get("UserInfo") is not None:
|
|
717
719
|
self._UserInfo = UserThreeFactor()
|
|
718
720
|
self._UserInfo._deserialize(params.get("UserInfo"))
|
|
719
|
-
self._CallbackUrl = params.get("CallbackUrl")
|
|
720
721
|
self._CertInfoCallback = params.get("CertInfoCallback")
|
|
721
722
|
self._UserDefineSeal = params.get("UserDefineSeal")
|
|
722
723
|
self._SealImgCallback = params.get("SealImgCallback")
|
|
724
|
+
self._CallbackUrl = params.get("CallbackUrl")
|
|
723
725
|
self._VerifyChannels = params.get("VerifyChannels")
|
|
724
726
|
self._LicenseType = params.get("LicenseType")
|
|
725
727
|
memeber_set = set(params.keys())
|
|
@@ -1195,12 +1197,12 @@ class CancelUserAutoSignEnableUrlRequest(AbstractModel):
|
|
|
1195
1197
|
:param _Operator: 执行本接口操作的员工信息。
|
|
1196
1198
|
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
1197
1199
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
1198
|
-
:param _SceneKey:
|
|
1199
|
-
<ul>
|
|
1200
|
-
|
|
1201
|
-
|
|
1200
|
+
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
|
1201
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
1202
|
+
|
|
1203
|
+
注: `现在仅支持电子处方场景`
|
|
1202
1204
|
:type SceneKey: str
|
|
1203
|
-
:param _UserInfo:
|
|
1205
|
+
:param _UserInfo: 预撤销链接的用户信息,包含姓名、证件类型、证件号码等信息。
|
|
1204
1206
|
|
|
1205
1207
|
:type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
|
|
1206
1208
|
:param _Agent: 代理企业和员工的信息。
|
|
@@ -2091,15 +2093,31 @@ class CreateConvertTaskApiRequest(AbstractModel):
|
|
|
2091
2093
|
|
|
2092
2094
|
def __init__(self):
|
|
2093
2095
|
r"""
|
|
2094
|
-
:param _ResourceType:
|
|
2096
|
+
:param _ResourceType: 需要进行转换的资源文件类型
|
|
2097
|
+
支持的文件类型如下:
|
|
2098
|
+
<ul><li>doc</li>
|
|
2099
|
+
<li>docx</li>
|
|
2100
|
+
<li>xls</li>
|
|
2101
|
+
<li>xlsx</li>
|
|
2102
|
+
<li>jpg</li>
|
|
2103
|
+
<li>jpeg</li>
|
|
2104
|
+
<li>png</li>
|
|
2105
|
+
<li>bmp</li>
|
|
2106
|
+
<li>txt</li></ul>
|
|
2095
2107
|
:type ResourceType: str
|
|
2096
|
-
:param _ResourceName:
|
|
2108
|
+
:param _ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
|
|
2109
|
+
|
|
2110
|
+
注: `资源名称长度限制为256个字符`
|
|
2097
2111
|
:type ResourceName: str
|
|
2098
|
-
:param _ResourceId:
|
|
2112
|
+
:param _ResourceId: 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
|
|
2113
|
+
|
|
2114
|
+
注: `目前,此接口仅支持单个文件进行转换。`
|
|
2099
2115
|
:type ResourceId: str
|
|
2100
|
-
:param _Operator:
|
|
2116
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
2117
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
|
2101
2118
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
2102
|
-
:param _Agent: 代理企业和员工的信息。
|
|
2119
|
+
:param _Agent: 代理企业和员工的信息。
|
|
2120
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
2103
2121
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
2104
2122
|
:param _Organization: 暂未开放
|
|
2105
2123
|
:type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
|
|
@@ -2194,7 +2212,7 @@ class CreateConvertTaskApiResponse(AbstractModel):
|
|
|
2194
2212
|
|
|
2195
2213
|
def __init__(self):
|
|
2196
2214
|
r"""
|
|
2197
|
-
:param _TaskId:
|
|
2215
|
+
:param _TaskId: 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
|
|
2198
2216
|
:type TaskId: str
|
|
2199
2217
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
2200
2218
|
:type RequestId: str
|
|
@@ -2233,22 +2251,30 @@ class CreateDocumentRequest(AbstractModel):
|
|
|
2233
2251
|
r"""
|
|
2234
2252
|
:param _Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
|
|
2235
2253
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
2236
|
-
:param _FlowId:
|
|
2254
|
+
:param _FlowId: 合同流程ID,为32位字符串。
|
|
2255
|
+
此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
|
|
2237
2256
|
:type FlowId: str
|
|
2238
|
-
:param _TemplateId:
|
|
2257
|
+
:param _TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
|
|
2258
|
+
可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
|
2239
2259
|
:type TemplateId: str
|
|
2240
2260
|
:param _FileNames: 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
|
|
2241
2261
|
:type FileNames: list of str
|
|
2242
|
-
:param _FormFields:
|
|
2262
|
+
:param _FormFields: 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
|
|
2243
2263
|
:type FormFields: list of FormField
|
|
2244
|
-
:param _NeedPreview:
|
|
2245
|
-
|
|
2264
|
+
:param _NeedPreview: 是否为预览模式,取值如下:
|
|
2265
|
+
<ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
|
2266
|
+
<li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
|
2246
2267
|
:type NeedPreview: bool
|
|
2247
|
-
:param _PreviewType:
|
|
2268
|
+
:param _PreviewType: 预览模式下产生的预览链接类型
|
|
2269
|
+
<ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
|
2270
|
+
<li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
|
2271
|
+
注: `此参数在NeedPreview 为true时有效`
|
|
2272
|
+
|
|
2248
2273
|
:type PreviewType: int
|
|
2249
|
-
:param _Agent:
|
|
2274
|
+
:param _Agent: 代理企业和员工的信息。
|
|
2275
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
2250
2276
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
2251
|
-
:param _ClientToken:
|
|
2277
|
+
:param _ClientToken: 已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
|
|
2252
2278
|
:type ClientToken: str
|
|
2253
2279
|
"""
|
|
2254
2280
|
self._Operator = None
|
|
@@ -2370,9 +2396,14 @@ class CreateDocumentResponse(AbstractModel):
|
|
|
2370
2396
|
|
|
2371
2397
|
def __init__(self):
|
|
2372
2398
|
r"""
|
|
2373
|
-
:param _DocumentId:
|
|
2399
|
+
:param _DocumentId: 合同流程的底层电子文档ID,为32位字符串。
|
|
2400
|
+
|
|
2401
|
+
注:
|
|
2402
|
+
后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>,合同才能进入签署环节
|
|
2374
2403
|
:type DocumentId: str
|
|
2375
|
-
:param _PreviewFileUrl:
|
|
2404
|
+
:param _PreviewFileUrl: 合同预览链接URL。
|
|
2405
|
+
|
|
2406
|
+
注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
|
2376
2407
|
注意:此字段可能返回 null,表示取不到有效值。
|
|
2377
2408
|
:type PreviewFileUrl: str
|
|
2378
2409
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
@@ -3777,45 +3808,75 @@ class CreateFlowRequest(AbstractModel):
|
|
|
3777
3808
|
|
|
3778
3809
|
def __init__(self):
|
|
3779
3810
|
r"""
|
|
3780
|
-
:param _Operator:
|
|
3811
|
+
:param _Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
|
3812
|
+
支持填入集团子公司经办人 userId 代发合同。
|
|
3813
|
+
|
|
3814
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
3781
3815
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
3782
|
-
:param _FlowName:
|
|
3816
|
+
:param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
|
3817
|
+
|
|
3818
|
+
该名称还将用于合同签署完成后的下载文件名。
|
|
3783
3819
|
:type FlowName: str
|
|
3784
|
-
:param _Approvers:
|
|
3785
|
-
|
|
3820
|
+
:param _Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
|
3821
|
+
|
|
3822
|
+
注: `approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效`
|
|
3786
3823
|
:type Approvers: list of FlowCreateApprover
|
|
3787
|
-
:param _FlowDescription:
|
|
3824
|
+
:param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
|
|
3788
3825
|
:type FlowDescription: str
|
|
3789
|
-
:param _FlowType:
|
|
3826
|
+
:param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
|
3790
3827
|
:type FlowType: str
|
|
3791
|
-
:param _ClientToken:
|
|
3828
|
+
:param _ClientToken: 已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
|
|
3792
3829
|
:type ClientToken: str
|
|
3793
|
-
:param _DeadLine:
|
|
3794
|
-
|
|
3795
|
-
值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
|
3830
|
+
:param _DeadLine: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
|
3831
|
+
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
3796
3832
|
:type DeadLine: int
|
|
3797
|
-
:param _RemindedOn:
|
|
3833
|
+
:param _RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
|
3834
|
+
|
|
3835
|
+
到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
|
3798
3836
|
:type RemindedOn: int
|
|
3799
|
-
:param _UserData:
|
|
3837
|
+
:param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
|
3838
|
+
|
|
3839
|
+
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
3800
3840
|
:type UserData: str
|
|
3801
|
-
:param _Unordered:
|
|
3802
|
-
|
|
3803
|
-
|
|
3804
|
-
|
|
3841
|
+
:param _Unordered: 合同流程的签署顺序类型:
|
|
3842
|
+
<ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
|
3843
|
+
<li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
|
3844
|
+
注:`请和模板中的配置保持一致`
|
|
3805
3845
|
:type Unordered: bool
|
|
3806
|
-
:param _CustomShowMap:
|
|
3807
|
-
|
|
3808
|
-
|
|
3809
|
-
|
|
3846
|
+
:param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
|
|
3847
|
+
<ul><li>{合同名称} </li>
|
|
3848
|
+
<li>{发起方企业} </li>
|
|
3849
|
+
<li>{发起方姓名} </li>
|
|
3850
|
+
<li>{签署方N企业}</li>
|
|
3851
|
+
<li>{签署方N姓名}</li></ul>
|
|
3852
|
+
其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
|
3853
|
+
|
|
3854
|
+
例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
|
3810
3855
|
|
|
3811
|
-
|
|
3856
|
+
合同名称:租房合同
|
|
3857
|
+
发起方:腾讯公司(张三)
|
|
3858
|
+
签署方:李四
|
|
3859
|
+
|
|
3860
|
+
|
|
3861
|
+
:type CustomShowMap: str
|
|
3862
|
+
:param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
3863
|
+
<ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
|
3864
|
+
<li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
3865
|
+
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
3866
|
+
<ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
3867
|
+
<li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
3868
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
3812
3869
|
:type NeedSignReview: bool
|
|
3813
|
-
:param _Agent:
|
|
3870
|
+
:param _Agent: 代理企业和员工的信息。
|
|
3871
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
3814
3872
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
3815
|
-
:param _CcInfos:
|
|
3816
|
-
|
|
3873
|
+
:param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
|
3874
|
+
|
|
3875
|
+
注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
|
3817
3876
|
:type CcInfos: list of CcInfo
|
|
3818
|
-
:param _AutoSignScene:
|
|
3877
|
+
:param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
|
3878
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
|
|
3879
|
+
注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
|
3819
3880
|
:type AutoSignScene: str
|
|
3820
3881
|
:param _RelatedFlowId: 暂未开放
|
|
3821
3882
|
:type RelatedFlowId: str
|
|
@@ -4034,11 +4095,13 @@ class CreateFlowResponse(AbstractModel):
|
|
|
4034
4095
|
|
|
4035
4096
|
def __init__(self):
|
|
4036
4097
|
r"""
|
|
4037
|
-
:param _FlowId:
|
|
4098
|
+
:param _FlowId: 合同流程ID,为32位字符串。
|
|
4099
|
+
建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
|
4100
|
+
|
|
4101
|
+
注:
|
|
4102
|
+
此返回的合同流程ID,需再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateDocument" target="_blank">创建电子文档</a>和<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>接口将合同开始后,合同才能进入签署环节
|
|
4038
4103
|
|
|
4039
|
-
返回的流程编号,需要在CreateDocument,StartFlow中使用,
|
|
4040
4104
|
|
|
4041
|
-
注意:这三个接口(CreateFlow,CreateDocument,StartFlow)要一并调用,才算发起成功
|
|
4042
4105
|
:type FlowId: str
|
|
4043
4106
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
4044
4107
|
:type RequestId: str
|
|
@@ -6036,8 +6099,10 @@ class CreateReleaseFlowRequest(AbstractModel):
|
|
|
6036
6099
|
:param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
|
|
6037
6100
|
如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
|
6038
6101
|
:type Deadline: int
|
|
6039
|
-
:param _UserData:
|
|
6102
|
+
:param _UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
|
|
6103
|
+
|
|
6040
6104
|
在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
|
6105
|
+
|
|
6041
6106
|
回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
|
6042
6107
|
:type UserData: str
|
|
6043
6108
|
"""
|
|
@@ -6884,27 +6949,30 @@ class CreateUserAutoSignEnableUrlRequest(AbstractModel):
|
|
|
6884
6949
|
|
|
6885
6950
|
def __init__(self):
|
|
6886
6951
|
r"""
|
|
6887
|
-
:param _Operator:
|
|
6952
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
6953
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
6888
6954
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
6889
|
-
:param _SceneKey:
|
|
6890
|
-
E_PRESCRIPTION_AUTO_SIGN
|
|
6955
|
+
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
|
6956
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
6957
|
+
|
|
6958
|
+
注: `现在仅支持电子处方场景`
|
|
6891
6959
|
:type SceneKey: str
|
|
6892
|
-
:param _AutoSignConfig:
|
|
6960
|
+
:param _AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
|
|
6893
6961
|
:type AutoSignConfig: :class:`tencentcloud.ess.v20201111.models.AutoSignConfig`
|
|
6894
|
-
:param _UrlType:
|
|
6895
|
-
|
|
6896
|
-
H5SIGN
|
|
6962
|
+
:param _UrlType: 生成的链接类型:
|
|
6963
|
+
<ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
|
|
6964
|
+
<li> **H5SIGN** : 生成H5端开通链接</li></ul>
|
|
6897
6965
|
:type UrlType: str
|
|
6898
|
-
:param _NotifyType:
|
|
6899
|
-
|
|
6900
|
-
|
|
6901
|
-
SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
|
|
6966
|
+
:param _NotifyType: 是否通知开通方,通知类型:
|
|
6967
|
+
<ul><li>默认不设置为不通知开通方</li>
|
|
6968
|
+
<li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
|
|
6902
6969
|
:type NotifyType: str
|
|
6903
6970
|
:param _NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
|
|
6904
6971
|
:type NotifyAddress: str
|
|
6905
|
-
:param _ExpiredTime: 链接的过期时间,格式为Unix
|
|
6972
|
+
:param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
|
|
6906
6973
|
:type ExpiredTime: int
|
|
6907
|
-
:param _Agent:
|
|
6974
|
+
:param _Agent: 代理企业和员工的信息。
|
|
6975
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
6908
6976
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
6909
6977
|
"""
|
|
6910
6978
|
self._Operator = None
|
|
@@ -7013,17 +7081,27 @@ class CreateUserAutoSignEnableUrlResponse(AbstractModel):
|
|
|
7013
7081
|
|
|
7014
7082
|
def __init__(self):
|
|
7015
7083
|
r"""
|
|
7016
|
-
:param _Url:
|
|
7084
|
+
:param _Url: 个人用户自动签的开通链接, 短链形式
|
|
7017
7085
|
:type Url: str
|
|
7018
|
-
:param _AppId:
|
|
7086
|
+
:param _AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
7087
|
+
|
|
7088
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
7019
7089
|
:type AppId: str
|
|
7020
|
-
:param _AppOriginalId:
|
|
7090
|
+
:param _AppOriginalId: 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
7091
|
+
|
|
7092
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
7021
7093
|
:type AppOriginalId: str
|
|
7022
|
-
:param _Path:
|
|
7094
|
+
:param _Path: 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
|
7095
|
+
|
|
7096
|
+
注: `如果获取的是H5链接, 则不会返回此值`
|
|
7023
7097
|
:type Path: str
|
|
7024
|
-
:param _QrCode: base64
|
|
7098
|
+
:param _QrCode: base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
|
|
7099
|
+
|
|
7100
|
+
注: `如果获取的是H5链接, 则不会返回此二维码图片`
|
|
7025
7101
|
:type QrCode: str
|
|
7026
|
-
:param _UrlType:
|
|
7102
|
+
:param _UrlType: 返回的链接类型
|
|
7103
|
+
<ul><li> 空: 默认小程序端链接</li>
|
|
7104
|
+
<li> **H5SIGN** : h5端链接</li></ul>
|
|
7027
7105
|
:type UrlType: str
|
|
7028
7106
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
7029
7107
|
:type RequestId: str
|
|
@@ -9833,14 +9911,18 @@ class DescribeUserAutoSignStatusRequest(AbstractModel):
|
|
|
9833
9911
|
|
|
9834
9912
|
def __init__(self):
|
|
9835
9913
|
r"""
|
|
9836
|
-
:param _Operator:
|
|
9914
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
9915
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
9837
9916
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
9838
|
-
:param _SceneKey:
|
|
9839
|
-
E_PRESCRIPTION_AUTO_SIGN
|
|
9917
|
+
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
|
9918
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
|
9919
|
+
|
|
9920
|
+
注: `现在仅支持电子处方场景`
|
|
9840
9921
|
:type SceneKey: str
|
|
9841
|
-
:param _UserInfo:
|
|
9922
|
+
:param _UserInfo: 要查询状态的用户信息, 包括名字,身份证等
|
|
9842
9923
|
:type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
|
|
9843
|
-
:param _Agent:
|
|
9924
|
+
:param _Agent: 代理企业和员工的信息。
|
|
9925
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
9844
9926
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
9845
9927
|
"""
|
|
9846
9928
|
self._Operator = None
|
|
@@ -9911,16 +9993,19 @@ class DescribeUserAutoSignStatusResponse(AbstractModel):
|
|
|
9911
9993
|
r"""
|
|
9912
9994
|
:param _IsOpen: 查询用户是否已开通自动签
|
|
9913
9995
|
:type IsOpen: bool
|
|
9914
|
-
:param _LicenseFrom:
|
|
9996
|
+
:param _LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
|
|
9915
9997
|
|
|
9916
9998
|
值为unix时间戳,单位为秒。
|
|
9917
9999
|
:type LicenseFrom: int
|
|
9918
|
-
:param _LicenseTo:
|
|
10000
|
+
:param _LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
|
|
10001
|
+
|
|
9919
10002
|
值为unix时间戳,单位为秒。
|
|
9920
10003
|
:type LicenseTo: int
|
|
9921
|
-
:param _LicenseType:
|
|
9922
|
-
|
|
9923
|
-
1
|
|
10004
|
+
:param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
|
|
10005
|
+
|
|
10006
|
+
<ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
|
10007
|
+
<li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
|
|
10008
|
+
|
|
9924
10009
|
:type LicenseType: int
|
|
9925
10010
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
9926
10011
|
:type RequestId: str
|
|
@@ -9987,14 +10072,16 @@ class DisableUserAutoSignRequest(AbstractModel):
|
|
|
9987
10072
|
|
|
9988
10073
|
def __init__(self):
|
|
9989
10074
|
r"""
|
|
9990
|
-
:param _Operator:
|
|
10075
|
+
:param _Operator: 执行本接口操作的员工信息。
|
|
10076
|
+
注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
|
9991
10077
|
:type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
|
|
9992
|
-
:param _SceneKey:
|
|
9993
|
-
E_PRESCRIPTION_AUTO_SIGN
|
|
10078
|
+
:param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
|
10079
|
+
<ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
|
|
9994
10080
|
:type SceneKey: str
|
|
9995
|
-
:param _UserInfo:
|
|
10081
|
+
:param _UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
|
|
9996
10082
|
:type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
|
|
9997
|
-
:param _Agent:
|
|
10083
|
+
:param _Agent: 代理企业和员工的信息。
|
|
10084
|
+
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
9998
10085
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
9999
10086
|
"""
|
|
10000
10087
|
self._Operator = None
|
|
@@ -11297,49 +11384,57 @@ class FlowCreateApprover(AbstractModel):
|
|
|
11297
11384
|
|
|
11298
11385
|
def __init__(self):
|
|
11299
11386
|
r"""
|
|
11300
|
-
:param _ApproverType:
|
|
11387
|
+
:param _ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
|
|
11301
11388
|
0:企业
|
|
11302
11389
|
1:个人
|
|
11303
|
-
3
|
|
11304
|
-
注:类型为3
|
|
11305
|
-
自动签署仅进行盖章操作,不能是手写签名。
|
|
11306
|
-
本方企业自动签署的签署人会默认是当前的发起人
|
|
11307
|
-
他方企业自动签署的签署人是自动签模板的他方企业授权人
|
|
11390
|
+
3:企业静默签署
|
|
11391
|
+
注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
|
|
11308
11392
|
7: 个人自动签署,适用于个人自动签场景。
|
|
11309
|
-
注:
|
|
11393
|
+
注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
|
|
11310
11394
|
:type ApproverType: int
|
|
11311
|
-
:param _OrganizationName:
|
|
11312
|
-
|
|
11395
|
+
:param _OrganizationName: 组织机构名称。
|
|
11396
|
+
请确认该名称与企业营业执照中注册的名称一致。
|
|
11397
|
+
如果名称中包含英文括号(),请使用中文括号()代替。
|
|
11398
|
+
|
|
11399
|
+
注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定`
|
|
11313
11400
|
|
|
11314
11401
|
|
|
11315
11402
|
:type OrganizationName: str
|
|
11316
|
-
:param _ApproverName:
|
|
11317
|
-
|
|
11403
|
+
:param _ApproverName: 签署方经办人的姓名。
|
|
11404
|
+
经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
|
11405
|
+
|
|
11406
|
+
在未指定签署人电子签UserId情况下,为必填参数
|
|
11318
11407
|
:type ApproverName: str
|
|
11319
|
-
:param _ApproverMobile:
|
|
11320
|
-
|
|
11408
|
+
:param _ApproverMobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
|
11409
|
+
请确认手机号所有方为此合同签署方。
|
|
11410
|
+
|
|
11411
|
+
在未指定签署人电子签UserId情况下,为必填参数
|
|
11321
11412
|
|
|
11322
11413
|
:type ApproverMobile: str
|
|
11323
|
-
:param _ApproverIdCardType:
|
|
11324
|
-
ID_CARD
|
|
11325
|
-
HONGKONG_AND_MACAO
|
|
11326
|
-
HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
|
11327
|
-
OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
11414
|
+
:param _ApproverIdCardType: 证件类型,支持以下类型
|
|
11415
|
+
<ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
|
11416
|
+
<li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
|
11417
|
+
<li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
|
11328
11418
|
:type ApproverIdCardType: str
|
|
11329
|
-
:param _ApproverIdCardNumber:
|
|
11419
|
+
:param _ApproverIdCardNumber: 证件号码,应符合以下规则
|
|
11420
|
+
<ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
|
11421
|
+
<li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
|
11422
|
+
<li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
|
11330
11423
|
:type ApproverIdCardNumber: str
|
|
11331
11424
|
:param _RecipientId: 签署方经办人在模板中的参与方ID
|
|
11332
11425
|
<br/>模板发起合同时,该参数为必填项
|
|
11333
11426
|
<br/>文件发起合同是,该参数无序传值
|
|
11334
11427
|
|
|
11335
11428
|
:type RecipientId: str
|
|
11336
|
-
:param _VerifyChannel:
|
|
11429
|
+
:param _VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
|
|
11430
|
+
|
|
11431
|
+
注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
|
|
11337
11432
|
:type VerifyChannel: list of str
|
|
11338
|
-
:param _NotifyType:
|
|
11339
|
-
<
|
|
11340
|
-
<
|
|
11341
|
-
|
|
11342
|
-
|
|
11433
|
+
:param _NotifyType: 通知签署方经办人的方式, 有以下途径:
|
|
11434
|
+
<ul><li> **sms** : (默认)短信</li>
|
|
11435
|
+
<li> **none** : 不通知</li></ul>
|
|
11436
|
+
|
|
11437
|
+
注: `发起方也是签署方时不给此签署方发送短信`
|
|
11343
11438
|
:type NotifyType: str
|
|
11344
11439
|
:param _IsFullText: 合同强制需要阅读全文,无需传此参数
|
|
11345
11440
|
:type IsFullText: bool
|
|
@@ -11347,22 +11442,20 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
|
11347
11442
|
:type PreReadTime: int
|
|
11348
11443
|
:param _UserId: 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
|
|
11349
11444
|
|
|
11350
|
-
|
|
11445
|
+
注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
|
|
11351
11446
|
:type UserId: str
|
|
11352
|
-
:param _Required:
|
|
11447
|
+
:param _Required: 字段已经废弃,当前只支持true,默认为true
|
|
11353
11448
|
:type Required: bool
|
|
11354
|
-
:param _ApproverSource:
|
|
11355
|
-
|
|
11356
|
-
企微侧用户请传入:WEWORKAPP
|
|
11449
|
+
:param _ApproverSource: 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
|
|
11357
11450
|
:type ApproverSource: str
|
|
11358
|
-
:param _CustomApproverTag:
|
|
11359
|
-
|
|
11360
|
-
|
|
11361
|
-
|
|
11451
|
+
:param _CustomApproverTag: 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
|
|
11452
|
+
所有参与或签的人员均需具备该标识。
|
|
11453
|
+
注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
|
|
11454
|
+
如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
|
|
11362
11455
|
:type CustomApproverTag: str
|
|
11363
|
-
:param _RegisterInfo:
|
|
11456
|
+
:param _RegisterInfo: 已经废弃, 快速注册相关信息
|
|
11364
11457
|
:type RegisterInfo: :class:`tencentcloud.ess.v20201111.models.RegisterInfo`
|
|
11365
|
-
:param _ApproverOption:
|
|
11458
|
+
:param _ApproverOption: 签署人个性化能力值,如是否可以转发他人处理、是否可以拒签等功能开关。
|
|
11366
11459
|
:type ApproverOption: :class:`tencentcloud.ess.v20201111.models.ApproverOption`
|
|
11367
11460
|
:param _JumpUrl: 签署完前端跳转的url,暂未使用
|
|
11368
11461
|
:type JumpUrl: str
|
|
@@ -11370,16 +11463,35 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
|
11370
11463
|
- 发起流程时系统自动补充
|
|
11371
11464
|
- 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
|
11372
11465
|
:type SignId: str
|
|
11373
|
-
:param _ApproverNeedSignReview:
|
|
11374
|
-
<
|
|
11375
|
-
<
|
|
11376
|
-
|
|
11466
|
+
:param _ApproverNeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
|
11467
|
+
<ul><li>**false**:(默认)不需要审批,直接签署。</li>
|
|
11468
|
+
<li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
|
11469
|
+
企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
|
11470
|
+
<ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
|
11471
|
+
<li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
|
11472
|
+
|
|
11473
|
+
注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
|
11377
11474
|
:type ApproverNeedSignReview: bool
|
|
11378
11475
|
:param _SignComponents: 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
|
|
11379
|
-
|
|
11476
|
+
|
|
11477
|
+
合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
|
|
11478
|
+
<ul><li> 个人签名/印章</li>
|
|
11479
|
+
<li> 企业印章</li>
|
|
11480
|
+
<li> 骑缝章等签署控件</li></ul>
|
|
11481
|
+
|
|
11482
|
+
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
11380
11483
|
:type SignComponents: list of Component
|
|
11381
11484
|
:param _Components: 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
|
|
11382
|
-
|
|
11485
|
+
|
|
11486
|
+
合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
|
11487
|
+
<ul><li>单行文本控件</li>
|
|
11488
|
+
<li>多行文本控件</li>
|
|
11489
|
+
<li>勾选框控件</li>
|
|
11490
|
+
<li>数字控件</li>
|
|
11491
|
+
<li>图片控件</li>
|
|
11492
|
+
<li>动态表格等填写控件</li></ul>
|
|
11493
|
+
|
|
11494
|
+
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
11383
11495
|
:type Components: list of Component
|
|
11384
11496
|
:param _ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
|
|
11385
11497
|
HANDWRITE – 手写签名
|
|
@@ -11387,13 +11499,28 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
|
|
11387
11499
|
ESIGN -- 个人印章类型
|
|
11388
11500
|
SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
|
|
11389
11501
|
:type ComponentLimitType: list of str
|
|
11390
|
-
:param _ApproverVerifyTypes:
|
|
11502
|
+
:param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
|
|
11503
|
+
<ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
|
|
11504
|
+
<li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
|
|
11505
|
+
</li></ul>
|
|
11506
|
+
注:
|
|
11507
|
+
<ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
|
|
11508
|
+
<li>此字段不可传多个校验方式</li></ul>
|
|
11509
|
+
|
|
11510
|
+
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
11391
11511
|
|
|
11392
|
-
|
|
11512
|
+
.
|
|
11393
11513
|
:type ApproverVerifyTypes: list of int
|
|
11394
|
-
:param _ApproverSignTypes:
|
|
11514
|
+
:param _ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式,可传递以下值:
|
|
11515
|
+
<ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
|
|
11516
|
+
<li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
|
|
11517
|
+
<li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
|
|
11518
|
+
注:
|
|
11519
|
+
<ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
|
|
11520
|
+
<li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
|
|
11395
11521
|
|
|
11396
|
-
|
|
11522
|
+
注:
|
|
11523
|
+
`此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
|
11397
11524
|
:type ApproverSignTypes: list of int non-negative
|
|
11398
11525
|
"""
|
|
11399
11526
|
self._ApproverType = None
|
|
@@ -14381,31 +14508,31 @@ class RegisterInfo(AbstractModel):
|
|
|
14381
14508
|
|
|
14382
14509
|
|
|
14383
14510
|
class ReleasedApprover(AbstractModel):
|
|
14384
|
-
"""
|
|
14385
|
-
|
|
14386
|
-
|
|
14387
|
-
|
|
14511
|
+
"""解除协议的签署人,如不指定,默认使用原流程中的签署人。<br/>
|
|
14512
|
+
`注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。`<br/>
|
|
14513
|
+
`注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。`<br/>
|
|
14514
|
+
`注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole。`<br/>
|
|
14388
14515
|
|
|
14389
14516
|
"""
|
|
14390
14517
|
|
|
14391
14518
|
def __init__(self):
|
|
14392
14519
|
r"""
|
|
14393
|
-
:param _Name: 签署人姓名,最大长度50
|
|
14520
|
+
:param _Name: 签署人姓名,最大长度50个字。
|
|
14394
14521
|
|
|
14395
14522
|
:type Name: str
|
|
14396
|
-
:param _Mobile:
|
|
14523
|
+
:param _Mobile: 签署人手机号。
|
|
14397
14524
|
:type Mobile: str
|
|
14398
|
-
:param _RelievedApproverReceiptId:
|
|
14525
|
+
:param _RelievedApproverReceiptId: 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
|
14399
14526
|
:type RelievedApproverReceiptId: str
|
|
14400
14527
|
:param _ApproverType: 指定签署人类型,目前仅支持
|
|
14401
|
-
ORGANIZATION
|
|
14402
|
-
ENTERPRISESERVER
|
|
14528
|
+
<ul><li> **ORGANIZATION**:企业(默认值)</li>
|
|
14529
|
+
<li> **ENTERPRISESERVER**:企业静默签</li></ul>
|
|
14403
14530
|
:type ApproverType: str
|
|
14404
|
-
:param _ApproverSignComponentType:
|
|
14405
|
-
|
|
14406
|
-
|
|
14531
|
+
:param _ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件类型
|
|
14532
|
+
<ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
|
|
14533
|
+
<li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
|
|
14407
14534
|
:type ApproverSignComponentType: str
|
|
14408
|
-
:param _ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的;
|
|
14535
|
+
:param _ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字。
|
|
14409
14536
|
:type ApproverSignRole: str
|
|
14410
14537
|
"""
|
|
14411
14538
|
self._Name = None
|
|
@@ -15129,8 +15256,8 @@ class StartFlowRequest(AbstractModel):
|
|
|
15129
15256
|
在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
|
15130
15257
|
:type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
|
|
15131
15258
|
:param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
|
|
15132
|
-
0
|
|
15133
|
-
1
|
|
15259
|
+
<ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
|
|
15260
|
+
<li> **1** : 签署完成后通知对方来查看合同</li></ul>
|
|
15134
15261
|
:type CcNotifyType: int
|
|
15135
15262
|
"""
|
|
15136
15263
|
self._Operator = None
|
|
@@ -15212,9 +15339,9 @@ class StartFlowResponse(AbstractModel):
|
|
|
15212
15339
|
def __init__(self):
|
|
15213
15340
|
r"""
|
|
15214
15341
|
:param _Status: 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
|
|
15215
|
-
START
|
|
15216
|
-
REVIEW
|
|
15217
|
-
EXECUTING
|
|
15342
|
+
<ul><li> **START** : 发起成功, 合同进入签署环节</li>
|
|
15343
|
+
<li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能,使用前请联系对接的客户经理沟通。`</li>
|
|
15344
|
+
<li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
|
|
15218
15345
|
:type Status: str
|
|
15219
15346
|
:param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
|
15220
15347
|
:type RequestId: str
|