tencentcloud-sdk-python 3.0.976__py2.py3-none-any.whl → 3.0.978__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.

Files changed (54) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/antiddos/v20200309/antiddos_client.py +1 -1
  3. tencentcloud/antiddos/v20200309/models.py +1 -1
  4. tencentcloud/autoscaling/v20180419/models.py +14 -0
  5. tencentcloud/cam/v20190116/errorcodes.py +3 -0
  6. tencentcloud/cdc/v20201214/models.py +194 -0
  7. tencentcloud/cdn/v20180606/errorcodes.py +6 -0
  8. tencentcloud/cdwch/v20200915/cdwch_client.py +23 -0
  9. tencentcloud/cdwch/v20200915/models.py +75 -0
  10. tencentcloud/cfw/v20190904/cfw_client.py +644 -0
  11. tencentcloud/cfw/v20190904/models.py +11557 -5960
  12. tencentcloud/clb/v20180317/models.py +1 -1
  13. tencentcloud/csip/v20221121/models.py +13 -0
  14. tencentcloud/dnspod/v20210323/models.py +1 -1
  15. tencentcloud/domain/v20180808/errorcodes.py +1 -1
  16. tencentcloud/eb/v20210416/eb_client.py +92 -0
  17. tencentcloud/eb/v20210416/models.py +407 -0
  18. tencentcloud/ess/v20201111/ess_client.py +68 -26
  19. tencentcloud/ess/v20201111/models.py +453 -222
  20. tencentcloud/essbasic/v20210526/models.py +129 -4
  21. tencentcloud/facefusion/v20181201/facefusion_client.py +3 -1
  22. tencentcloud/iai/v20180301/iai_client.py +0 -1
  23. tencentcloud/iai/v20180301/models.py +1 -5
  24. tencentcloud/iai/v20200303/models.py +2 -6
  25. tencentcloud/lcic/v20220817/models.py +12 -0
  26. tencentcloud/mrs/v20200910/models.py +8965 -4033
  27. tencentcloud/mrs/v20200910/mrs_client.py +23 -0
  28. tencentcloud/ocr/v20181119/models.py +24 -0
  29. tencentcloud/ses/v20201002/models.py +180 -0
  30. tencentcloud/ses/v20201002/ses_client.py +23 -0
  31. tencentcloud/sqlserver/v20180328/models.py +315 -0
  32. tencentcloud/sqlserver/v20180328/sqlserver_client.py +46 -0
  33. tencentcloud/ssa/v20180608/models.py +249 -0
  34. tencentcloud/ssa/v20180608/ssa_client.py +23 -0
  35. tencentcloud/ssl/v20191205/models.py +75 -0
  36. tencentcloud/tcr/v20190924/models.py +17 -3
  37. tencentcloud/tcr/v20190924/tcr_client.py +1 -1
  38. tencentcloud/teo/v20220901/errorcodes.py +9 -0
  39. tencentcloud/trocket/v20230308/errorcodes.py +24 -0
  40. tencentcloud/trocket/v20230308/models.py +2627 -360
  41. tencentcloud/trocket/v20230308/trocket_client.py +301 -0
  42. tencentcloud/trtc/v20190722/models.py +1 -1
  43. tencentcloud/tsf/v20180326/models.py +88 -28
  44. tencentcloud/vod/v20180717/errorcodes.py +15 -0
  45. tencentcloud/vod/v20180717/models.py +330 -0
  46. tencentcloud/vod/v20180717/vod_client.py +69 -0
  47. tencentcloud/vpc/v20170312/models.py +48 -0
  48. tencentcloud/waf/v20180125/models.py +122 -181
  49. tencentcloud/waf/v20180125/waf_client.py +23 -46
  50. {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.978.dist-info}/METADATA +1 -1
  51. {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.978.dist-info}/RECORD +54 -54
  52. {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.978.dist-info}/LICENSE +0 -0
  53. {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.978.dist-info}/WHEEL +0 -0
  54. {tencentcloud_sdk_python-3.0.976.dist-info → tencentcloud_sdk_python-3.0.978.dist-info}/top_level.txt +0 -0
@@ -251,6 +251,10 @@ class ApproverInfo(AbstractModel):
251
251
 
252
252
  注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
253
253
  :type ApproverNeedSignReview: bool
254
+ :param _AddSignComponentsLimits: [用PDF文件创建签署流程](https://qian.tencent.com/developers/companyApis/startFlows/CreateFlowByFiles)时,如果设置了外层参数SignBeanTag=1(允许签署过程中添加签署控件),则可通过此参数明确规定合同所使用的签署控件类型(骑缝章、普通章法人章等)和具体的印章(印章ID)或签名方式。
255
+
256
+ 注:`限制印章控件或骑缝章控件情况下,仅本企业签署方可以指定具体印章(通过传递ComponentValue,支持多个),他方企业或个人只支持限制控件类型。`
257
+ :type AddSignComponentsLimits: list of ComponentLimit
254
258
  """
255
259
  self._ApproverType = None
256
260
  self._ApproverName = None
@@ -270,6 +274,7 @@ class ApproverInfo(AbstractModel):
270
274
  self._ApproverVerifyTypes = None
271
275
  self._ApproverSignTypes = None
272
276
  self._ApproverNeedSignReview = None
277
+ self._AddSignComponentsLimits = None
273
278
 
274
279
  @property
275
280
  def ApproverType(self):
@@ -415,6 +420,14 @@ class ApproverInfo(AbstractModel):
415
420
  def ApproverNeedSignReview(self, ApproverNeedSignReview):
416
421
  self._ApproverNeedSignReview = ApproverNeedSignReview
417
422
 
423
+ @property
424
+ def AddSignComponentsLimits(self):
425
+ return self._AddSignComponentsLimits
426
+
427
+ @AddSignComponentsLimits.setter
428
+ def AddSignComponentsLimits(self, AddSignComponentsLimits):
429
+ self._AddSignComponentsLimits = AddSignComponentsLimits
430
+
418
431
 
419
432
  def _deserialize(self, params):
420
433
  self._ApproverType = params.get("ApproverType")
@@ -442,6 +455,12 @@ class ApproverInfo(AbstractModel):
442
455
  self._ApproverVerifyTypes = params.get("ApproverVerifyTypes")
443
456
  self._ApproverSignTypes = params.get("ApproverSignTypes")
444
457
  self._ApproverNeedSignReview = params.get("ApproverNeedSignReview")
458
+ if params.get("AddSignComponentsLimits") is not None:
459
+ self._AddSignComponentsLimits = []
460
+ for item in params.get("AddSignComponentsLimits"):
461
+ obj = ComponentLimit()
462
+ obj._deserialize(item)
463
+ self._AddSignComponentsLimits.append(obj)
445
464
  memeber_set = set(params.keys())
446
465
  for name, value in vars(self).items():
447
466
  property_name = name[1:]
@@ -612,46 +631,44 @@ class AutoSignConfig(AbstractModel):
612
631
 
613
632
  def __init__(self):
614
633
  r"""
615
- :param _UserInfo: 自动签开通个人用户的三要素
634
+ :param _UserInfo: 自动签开通个人用户信息, 包括名字,身份证等
616
635
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
617
- :param _CallbackUrl: 接受回调URL地址。支持http://或者https://协议
618
-
619
- Post数据到此地址后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
620
- :type CallbackUrl: str
621
- :param _CertInfoCallback: 是否回调证书信息
622
- false-不需要 (默认值)
623
- true-需要
636
+ :param _CertInfoCallback: 是否回调证书信息:
637
+ <ul><li>**false**: 不需要(默认)</li>
638
+ <li>**true**:需要</li></ul>
624
639
  :type CertInfoCallback: bool
625
- :param _UserDefineSeal: 是否支持用户自定义签名印章
626
- false-不需要(默认)
627
- true-需要
640
+ :param _UserDefineSeal: 是否支持用户自定义签名印章:
641
+ <ul><li>**false**: 不能自己定义(默认)</li>
642
+ <li>**true**: 可以自己定义</li></ul>
628
643
  :type UserDefineSeal: bool
629
- :param _SealImgCallback: 是否需要回调的时候返回印章(签名) 图片的 base64
630
-
631
- false-不需要(默认)
632
- true-需要
644
+ :param _SealImgCallback: 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
645
+ <ul><li>**false**: 不需要(默认)</li>
646
+ <li>**true**: 需要</li></ul>
633
647
  :type SealImgCallback: bool
634
- :param _VerifyChannels: 开通时候的验证方式, 分布为
635
-
636
- WEIXINAPP : 微信人脸识别
637
- INSIGHT : 慧眼人脸认别
638
- TELECOM : 运营商三要素验证
639
-
640
- 如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。
641
-
642
- 如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
648
+ :param _CallbackUrl: 执行结果的回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
649
+ 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
650
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
651
+ :type CallbackUrl: str
652
+ :param _VerifyChannels: 开通时候的身份验证方式, 取值为:
653
+ <ul><li>**WEIXINAPP** : 微信人脸识别</li>
654
+ <li>**INSIGHT** : 慧眼人脸认别</li>
655
+ <li>**TELECOM** : 运营商三要素验证</li></ul>
656
+ 注:
657
+ <ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
658
+ <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li></ul>
643
659
  :type VerifyChannels: list of str
644
- :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。
645
- 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
646
- 1-不绑定,发起合同时将按标准合同套餐进行扣减
660
+ :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
661
+
662
+ <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
663
+ <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
647
664
 
648
665
  :type LicenseType: int
649
666
  """
650
667
  self._UserInfo = None
651
- self._CallbackUrl = None
652
668
  self._CertInfoCallback = None
653
669
  self._UserDefineSeal = None
654
670
  self._SealImgCallback = None
671
+ self._CallbackUrl = None
655
672
  self._VerifyChannels = None
656
673
  self._LicenseType = None
657
674
 
@@ -663,14 +680,6 @@ TELECOM : 运营商三要素验证
663
680
  def UserInfo(self, UserInfo):
664
681
  self._UserInfo = UserInfo
665
682
 
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
683
  @property
675
684
  def CertInfoCallback(self):
676
685
  return self._CertInfoCallback
@@ -695,6 +704,18 @@ TELECOM : 运营商三要素验证
695
704
  def SealImgCallback(self, SealImgCallback):
696
705
  self._SealImgCallback = SealImgCallback
697
706
 
707
+ @property
708
+ def CallbackUrl(self):
709
+ warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
710
+
711
+ return self._CallbackUrl
712
+
713
+ @CallbackUrl.setter
714
+ def CallbackUrl(self, CallbackUrl):
715
+ warnings.warn("parameter `CallbackUrl` is deprecated", DeprecationWarning)
716
+
717
+ self._CallbackUrl = CallbackUrl
718
+
698
719
  @property
699
720
  def VerifyChannels(self):
700
721
  return self._VerifyChannels
@@ -716,10 +737,10 @@ TELECOM : 运营商三要素验证
716
737
  if params.get("UserInfo") is not None:
717
738
  self._UserInfo = UserThreeFactor()
718
739
  self._UserInfo._deserialize(params.get("UserInfo"))
719
- self._CallbackUrl = params.get("CallbackUrl")
720
740
  self._CertInfoCallback = params.get("CertInfoCallback")
721
741
  self._UserDefineSeal = params.get("UserDefineSeal")
722
742
  self._SealImgCallback = params.get("SealImgCallback")
743
+ self._CallbackUrl = params.get("CallbackUrl")
723
744
  self._VerifyChannels = params.get("VerifyChannels")
724
745
  self._LicenseType = params.get("LicenseType")
725
746
  memeber_set = set(params.keys())
@@ -1195,12 +1216,12 @@ class CancelUserAutoSignEnableUrlRequest(AbstractModel):
1195
1216
  :param _Operator: 执行本接口操作的员工信息。
1196
1217
  注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1197
1218
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
1198
- :param _SceneKey: 企业开通用户自动签场景,例如电子处方。
1199
- <ul>
1200
- <li>E_PRESCRIPTION_AUTO_SIGN : 电子处方</li>
1201
- </ul>
1219
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
1220
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
1221
+
1222
+ 注: `现在仅支持电子处方场景`
1202
1223
  :type SceneKey: str
1203
- :param _UserInfo: 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
1224
+ :param _UserInfo: 预撤销链接的用户信息,包含姓名、证件类型、证件号码等信息。
1204
1225
 
1205
1226
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
1206
1227
  :param _Agent: 代理企业和员工的信息。
@@ -1861,6 +1882,66 @@ UpperRight-右下角。
1861
1882
 
1862
1883
 
1863
1884
 
1885
+ class ComponentLimit(AbstractModel):
1886
+ """签署控件的类型和范围限制条件,用于控制文件发起后签署人拖拽签署区时可使用的控件类型和具体的印章或签名方式。
1887
+
1888
+ """
1889
+
1890
+ def __init__(self):
1891
+ r"""
1892
+ :param _ComponentType: 控件类型,支持以下类型
1893
+ <ul><li>SIGN_SEAL : 印章控件</li>
1894
+ <li>SIGN_PAGING_SEAL : 骑缝章控件</li>
1895
+ <li>SIGN_LEGAL_PERSON_SEAL : 企业法定代表人控件</li>
1896
+ <li>SIGN_SIGNATURE : 用户签名控件</li></ul>
1897
+ :type ComponentType: str
1898
+ :param _ComponentValue: 签署控件类型的值(可选),用与限制签署时印章或者签名的选择范围
1899
+
1900
+ 1.当ComponentType 是 SIGN_SEAL 或者 SIGN_PAGING_SEAL 时可传入企业印章Id(支持多个)
1901
+
1902
+ 2.当ComponentType 是 SIGN_SIGNATURE 时可传入以下类型(支持多个)
1903
+
1904
+ <ul><li>HANDWRITE : 手写签名</li>
1905
+ <li>OCR_ESIGN : OCR印章(智慧手写签名)</li>
1906
+ <li>ESIGN : 个人印章</li>
1907
+ <li>SYSTEM_ESIGN : 系统印章</li></ul>
1908
+
1909
+ 3.当ComponentType 是 SIGN_LEGAL_PERSON_SEAL 时无需传递此参数。
1910
+ :type ComponentValue: list of str
1911
+ """
1912
+ self._ComponentType = None
1913
+ self._ComponentValue = None
1914
+
1915
+ @property
1916
+ def ComponentType(self):
1917
+ return self._ComponentType
1918
+
1919
+ @ComponentType.setter
1920
+ def ComponentType(self, ComponentType):
1921
+ self._ComponentType = ComponentType
1922
+
1923
+ @property
1924
+ def ComponentValue(self):
1925
+ return self._ComponentValue
1926
+
1927
+ @ComponentValue.setter
1928
+ def ComponentValue(self, ComponentValue):
1929
+ self._ComponentValue = ComponentValue
1930
+
1931
+
1932
+ def _deserialize(self, params):
1933
+ self._ComponentType = params.get("ComponentType")
1934
+ self._ComponentValue = params.get("ComponentValue")
1935
+ memeber_set = set(params.keys())
1936
+ for name, value in vars(self).items():
1937
+ property_name = name[1:]
1938
+ if property_name in memeber_set:
1939
+ memeber_set.remove(property_name)
1940
+ if len(memeber_set) > 0:
1941
+ warnings.warn("%s fileds are useless." % ",".join(memeber_set))
1942
+
1943
+
1944
+
1864
1945
  class CreateBatchCancelFlowUrlRequest(AbstractModel):
1865
1946
  """CreateBatchCancelFlowUrl请求参数结构体
1866
1947
 
@@ -2091,15 +2172,31 @@ class CreateConvertTaskApiRequest(AbstractModel):
2091
2172
 
2092
2173
  def __init__(self):
2093
2174
  r"""
2094
- :param _ResourceType: 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
2175
+ :param _ResourceType: 需要进行转换的资源文件类型
2176
+ 支持的文件类型如下:
2177
+ <ul><li>doc</li>
2178
+ <li>docx</li>
2179
+ <li>xls</li>
2180
+ <li>xlsx</li>
2181
+ <li>jpg</li>
2182
+ <li>jpeg</li>
2183
+ <li>png</li>
2184
+ <li>bmp</li>
2185
+ <li>txt</li></ul>
2095
2186
  :type ResourceType: str
2096
- :param _ResourceName: 资源名称,长度限制为256字符
2187
+ :param _ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
2188
+
2189
+ 注: `资源名称长度限制为256个字符`
2097
2190
  :type ResourceName: str
2098
- :param _ResourceId: 文件Id,通过UploadFiles获取
2191
+ :param _ResourceId: 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
2192
+
2193
+ 注: `目前,此接口仅支持单个文件进行转换。`
2099
2194
  :type ResourceId: str
2100
- :param _Operator: 调用方用户信息,userId 必填
2195
+ :param _Operator: 执行本接口操作的员工信息。
2196
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
2101
2197
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
2102
- :param _Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2198
+ :param _Agent: 代理企业和员工的信息。
2199
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2103
2200
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
2104
2201
  :param _Organization: 暂未开放
2105
2202
  :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
@@ -2194,7 +2291,7 @@ class CreateConvertTaskApiResponse(AbstractModel):
2194
2291
 
2195
2292
  def __init__(self):
2196
2293
  r"""
2197
- :param _TaskId: 转换任务Id
2294
+ :param _TaskId: 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
2198
2295
  :type TaskId: str
2199
2296
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2200
2297
  :type RequestId: str
@@ -2233,22 +2330,30 @@ class CreateDocumentRequest(AbstractModel):
2233
2330
  r"""
2234
2331
  :param _Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
2235
2332
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
2236
- :param _FlowId: 签署流程编号,由CreateFlow接口返回
2333
+ :param _FlowId: 合同流程ID,为32位字符串。
2334
+ 此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
2237
2335
  :type FlowId: str
2238
- :param _TemplateId: 用户上传的模板ID
2336
+ :param _TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
2337
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
2239
2338
  :type TemplateId: str
2240
2339
  :param _FileNames: 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
2241
2340
  :type FileNames: list of str
2242
- :param _FormFields: 内容控件信息数组
2341
+ :param _FormFields: 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
2243
2342
  :type FormFields: list of FormField
2244
- :param _NeedPreview: 是否需要生成预览文件 默认不生成;
2245
- 预览链接有效期300秒;
2343
+ :param _NeedPreview: 是否为预览模式,取值如下:
2344
+ <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
2345
+ <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
2246
2346
  :type NeedPreview: bool
2247
- :param _PreviewType: 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
2347
+ :param _PreviewType: 预览模式下产生的预览链接类型
2348
+ <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
2349
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
2350
+ 注: `此参数在NeedPreview 为true时有效`
2351
+
2248
2352
  :type PreviewType: int
2249
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2353
+ :param _Agent: 代理企业和员工的信息。
2354
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2250
2355
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
2251
- :param _ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
2356
+ :param _ClientToken: 已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
2252
2357
  :type ClientToken: str
2253
2358
  """
2254
2359
  self._Operator = None
@@ -2370,9 +2475,14 @@ class CreateDocumentResponse(AbstractModel):
2370
2475
 
2371
2476
  def __init__(self):
2372
2477
  r"""
2373
- :param _DocumentId: 签署流程电子文档ID
2478
+ :param _DocumentId: 合同流程的底层电子文档ID,为32位字符串。
2479
+
2480
+ 注:
2481
+ 后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>,合同才能进入签署环节
2374
2482
  :type DocumentId: str
2375
- :param _PreviewFileUrl: 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
2483
+ :param _PreviewFileUrl: 合同预览链接URL。
2484
+
2485
+ 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
2376
2486
  注意:此字段可能返回 null,表示取不到有效值。
2377
2487
  :type PreviewFileUrl: str
2378
2488
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -3777,45 +3887,75 @@ class CreateFlowRequest(AbstractModel):
3777
3887
 
3778
3888
  def __init__(self):
3779
3889
  r"""
3780
- :param _Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
3890
+ :param _Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId
3891
+ 支持填入集团子公司经办人 userId 代发合同。
3892
+
3893
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3781
3894
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
3782
- :param _FlowName: 签署流程名称,最大长度200个字符
3895
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
3896
+
3897
+ 该名称还将用于合同签署完成后的下载文件名。
3783
3898
  :type FlowName: str
3784
- :param _Approvers: 签署流程参与者信息,最大限制50
3785
- 注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
3899
+ :param _Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
3900
+
3901
+ 注: `approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效`
3786
3902
  :type Approvers: list of FlowCreateApprover
3787
- :param _FlowDescription: 签署流程描述,最大长度1000个字符
3903
+ :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
3788
3904
  :type FlowDescription: str
3789
- :param _FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
3905
+ :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
3790
3906
  :type FlowType: str
3791
- :param _ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
3907
+ :param _ClientToken: 已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
3792
3908
  :type ClientToken: str
3793
- :param _DeadLine: 签署流程的签署截止时间。
3794
-
3795
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
3909
+ :param _DeadLine: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
3910
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3796
3911
  :type DeadLine: int
3797
- :param _RemindedOn: 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
3912
+ :param _RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
3913
+
3914
+ 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
3798
3915
  :type RemindedOn: int
3799
- :param _UserData: 用户自定义字段,回调的时候会进行透传,长度需要小于20480
3916
+ :param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
3917
+
3918
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3800
3919
  :type UserData: str
3801
- :param _Unordered: 发送类型:
3802
- true:无序签
3803
- false:有序签
3804
- 注:默认为false(有序签),请和模板中的配置保持一致
3920
+ :param _Unordered: 合同流程的签署顺序类型:
3921
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
3922
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
3923
+ 注:`请和模板中的配置保持一致`
3805
3924
  :type Unordered: bool
3806
- :param _CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
3807
- :type CustomShowMap: str
3808
- :param _NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3809
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
3925
+ :param _CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
3926
+ <ul><li>{合同名称} </li>
3927
+ <li>{发起方企业} </li>
3928
+ <li>{发起方姓名} </li>
3929
+ <li>{签署方N企业}</li>
3930
+ <li>{签署方N姓名}</li></ul>
3931
+ 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
3932
+
3933
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
3934
+
3935
+ 合同名称:租房合同
3936
+ 发起方:腾讯公司(张三)
3937
+ 签署方:李四
3938
+
3810
3939
 
3811
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
3940
+ :type CustomShowMap: str
3941
+ :param _NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
3942
+ <ul><li> **false**:(默认)不需要审批,直接签署。</li>
3943
+ <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
3944
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
3945
+ <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
3946
+ <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
3947
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
3812
3948
  :type NeedSignReview: bool
3813
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3949
+ :param _Agent: 代理企业和员工的信息。
3950
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3814
3951
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
3815
- :param _CcInfos: 被抄送人的信息列表。
3816
- 注: 此功能为白名单功能,若有需要,请联系电子签客服开白使用。
3952
+ :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
3953
+
3954
+ 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
3817
3955
  :type CcInfos: list of CcInfo
3818
- :param _AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
3956
+ :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
3957
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
3958
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
3819
3959
  :type AutoSignScene: str
3820
3960
  :param _RelatedFlowId: 暂未开放
3821
3961
  :type RelatedFlowId: str
@@ -4034,11 +4174,13 @@ class CreateFlowResponse(AbstractModel):
4034
4174
 
4035
4175
  def __init__(self):
4036
4176
  r"""
4037
- :param _FlowId: 签署流程编号,
4177
+ :param _FlowId: 合同流程ID,为32位字符串。
4178
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
4179
+
4180
+ 注:
4181
+ 此返回的合同流程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
4182
 
4039
- 返回的流程编号,需要在CreateDocument,StartFlow中使用,
4040
4183
 
4041
- 注意:这三个接口(CreateFlow,CreateDocument,StartFlow)要一并调用,才算发起成功
4042
4184
  :type FlowId: str
4043
4185
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4044
4186
  :type RequestId: str
@@ -5289,20 +5431,25 @@ class CreatePersonAuthCertificateImageRequest(AbstractModel):
5289
5431
 
5290
5432
  def __init__(self):
5291
5433
  r"""
5292
- :param _Operator: 操作人信息
5434
+ :param _Operator: 执行本接口操作的员工信息。
5435
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5293
5436
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
5294
5437
  :param _UserName: 个人用户名称
5295
5438
  :type UserName: str
5296
- :param _IdCardType: 身份证件类型取值:
5297
- ID_CARD 身居民身份证
5298
- PASSPORT 护照
5299
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
5300
- FOREIGN_ID_CARD 外国人永久居留身份证
5301
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
5439
+ :param _IdCardType: 证件类型,支持以下类型
5440
+ <ul><li> ID_CARD : 居民身份证 (默认值)</li>
5441
+ <li> PASSPORT : 护照</li>
5442
+ <li> FOREIGN_ID_CARD : 外国人永久居留身份证</li>
5443
+ <li> HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
5444
+ <li> HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
5302
5445
  :type IdCardType: str
5303
- :param _IdCardNumber: 身份证件号码
5446
+ :param _IdCardNumber: 证件号码,应符合以下规则
5447
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
5448
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
5449
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
5304
5450
  :type IdCardNumber: str
5305
- :param _Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5451
+ :param _Agent: 代理企业和员工的信息。
5452
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
5306
5453
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
5307
5454
  """
5308
5455
  self._Operator = None
@@ -5379,18 +5526,25 @@ class CreatePersonAuthCertificateImageResponse(AbstractModel):
5379
5526
 
5380
5527
  def __init__(self):
5381
5528
  r"""
5382
- :param _AuthCertUrl: 个人用户证明证书的下载链接
5529
+ :param _AuthCertUrl: 个人用户认证证书图片下载URL,`有效期为5分钟`,超过有效期后将无法再下载。
5383
5530
  :type AuthCertUrl: str
5384
- :param _ImageCertId: 证书图片上的证书编号,20位数字
5531
+ :param _ImageCertId: 个人用户认证证书的编号, 为20位数字组成的字符串, 由腾讯电子签下发此编号 。
5532
+ 该编号会合成到个人用户证书证明图片。
5533
+
5534
+ 注: `个人用户认证证书的编号和证明图片绑定, 获取新的证明图片编号会变动`
5385
5535
  注意:此字段可能返回 null,表示取不到有效值。
5386
5536
  :type ImageCertId: str
5387
- :param _SerialNumber: 图片证明对应的CA证书序列号
5537
+ :param _SerialNumber: CA供应商下发给用户的证书编号,在证书到期后自动续期后此证书编号会发生变动,且不会合成到个人用户证书证明图片中。
5538
+
5539
+ 注意:`腾讯电子签接入多家CA供应商以提供容灾能力,不同CA下发的证书编号区别较大,但基本都是由数字和字母组成,长度在200以下。`
5388
5540
  注意:此字段可能返回 null,表示取不到有效值。
5389
5541
  :type SerialNumber: str
5390
- :param _ValidFrom: CA证书颁发时间戳
5542
+ :param _ValidFrom: CA证书颁发时间,格式为Unix标准时间戳(秒)
5543
+ 该时间格式化后会合成到个人用户证书证明图片
5391
5544
  注意:此字段可能返回 null,表示取不到有效值。
5392
5545
  :type ValidFrom: int
5393
- :param _ValidTo: CA证书有效截止时间戳
5546
+ :param _ValidTo: CA证书有效截止时间,格式为Unix标准时间戳(秒)
5547
+ 该时间格式化后会合成到个人用户证书证明图片
5394
5548
  注意:此字段可能返回 null,表示取不到有效值。
5395
5549
  :type ValidTo: int
5396
5550
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -6022,22 +6176,24 @@ class CreateReleaseFlowRequest(AbstractModel):
6022
6176
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
6023
6177
  :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
6024
6178
  :type NeedRelievedFlowId: str
6025
- :param _ReliveInfo: 解除协议内容。
6179
+ :param _ReliveInfo: 解除协议内容, 包括解除理由等信息。
6026
6180
  :type ReliveInfo: :class:`tencentcloud.ess.v20201111.models.RelieveInfo`
6027
6181
  :param _Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6028
6182
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6029
- :param _ReleasedApprovers: 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
6030
- 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
6031
- 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
6183
+ :param _ReleasedApprovers: 替换解除协议的签署人, 如不指定替换签署人, 则使用原流程的签署人。 <br/>
6184
+ 如需更换原合同中的企业端签署人,可通过指定该签署人的RecipientId编号更换此企业端签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
6032
6185
 
6033
- `注意:只能更换同企业的签署人。`<br/>
6034
- `注意:不支持更换个人类型的签署人。`<br/>
6186
+ 注意:
6187
+ `只能更换自己企业的签署人, 不支持更换个人类型或者其他企业的签署人。`
6188
+ `可以不指定替换签署人, 使用原流程的签署人 `
6035
6189
  :type ReleasedApprovers: list of ReleasedApprover
6036
6190
  :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
6037
6191
  如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
6038
6192
  :type Deadline: int
6039
- :param _UserData: 调用方自定义的个性化字段(可自定义此字段的值),并以base64方式编码,支持的最大数据大小为 20480长度。
6193
+ :param _UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
6194
+
6040
6195
  在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
6196
+
6041
6197
  回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
6042
6198
  :type UserData: str
6043
6199
  """
@@ -6884,27 +7040,30 @@ class CreateUserAutoSignEnableUrlRequest(AbstractModel):
6884
7040
 
6885
7041
  def __init__(self):
6886
7042
  r"""
6887
- :param _Operator: 操作人信息,UserId必填
7043
+ :param _Operator: 执行本接口操作的员工信息。
7044
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6888
7045
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
6889
- :param _SceneKey: 自动签场景:
6890
- E_PRESCRIPTION_AUTO_SIGN 电子处方
7046
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
7047
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
7048
+
7049
+ 注: `现在仅支持电子处方场景`
6891
7050
  :type SceneKey: str
6892
- :param _AutoSignConfig: 自动签开通,签署相关配置
7051
+ :param _AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
6893
7052
  :type AutoSignConfig: :class:`tencentcloud.ess.v20201111.models.AutoSignConfig`
6894
- :param _UrlType: 链接类型,
6895
- 空-默认小程序端链接
6896
- H5SIGN-h5端链接
7053
+ :param _UrlType: 生成的链接类型:
7054
+ <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
7055
+ <li> **H5SIGN** : 生成H5端开通链接</li></ul>
6897
7056
  :type UrlType: str
6898
- :param _NotifyType: 通知类型
6899
-
6900
- 默认不设置为不通知开通方,
6901
- SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
7057
+ :param _NotifyType: 是否通知开通方,通知类型:
7058
+ <ul><li>默认不设置为不通知开通方</li>
7059
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
6902
7060
  :type NotifyType: str
6903
7061
  :param _NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
6904
7062
  :type NotifyAddress: str
6905
- :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为30天。如果不传,默认有效期为7天。
7063
+ :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
6906
7064
  :type ExpiredTime: int
6907
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
7065
+ :param _Agent: 代理企业和员工的信息。
7066
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6908
7067
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6909
7068
  """
6910
7069
  self._Operator = None
@@ -7013,17 +7172,27 @@ class CreateUserAutoSignEnableUrlResponse(AbstractModel):
7013
7172
 
7014
7173
  def __init__(self):
7015
7174
  r"""
7016
- :param _Url: 跳转短链
7175
+ :param _Url: 个人用户自动签的开通链接, 短链形式
7017
7176
  :type Url: str
7018
- :param _AppId: 小程序AppId
7177
+ :param _AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
7178
+
7179
+ 注: `如果获取的是H5链接, 则不会返回此值`
7019
7180
  :type AppId: str
7020
- :param _AppOriginalId: 小程序 原始 Id
7181
+ :param _AppOriginalId: 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
7182
+
7183
+ 注: `如果获取的是H5链接, 则不会返回此值`
7021
7184
  :type AppOriginalId: str
7022
- :param _Path: 跳转路径
7185
+ :param _Path: 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
7186
+
7187
+ 注: `如果获取的是H5链接, 则不会返回此值`
7023
7188
  :type Path: str
7024
- :param _QrCode: base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
7189
+ :param _QrCode: base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
7190
+
7191
+ 注: `如果获取的是H5链接, 则不会返回此二维码图片`
7025
7192
  :type QrCode: str
7026
- :param _UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
7193
+ :param _UrlType: 返回的链接类型
7194
+ <ul><li> 空: 默认小程序端链接</li>
7195
+ <li> **H5SIGN** : h5端链接</li></ul>
7027
7196
  :type UrlType: str
7028
7197
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
7029
7198
  :type RequestId: str
@@ -8082,11 +8251,16 @@ class DescribeFlowBriefsRequest(AbstractModel):
8082
8251
 
8083
8252
  def __init__(self):
8084
8253
  r"""
8085
- :param _Operator: 调用方用户信息,userId 必填
8254
+ :param _Operator: 执行本接口操作的员工信息。
8255
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
8086
8256
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
8087
- :param _FlowIds: 需要查询的流程ID列表,限制最大100
8257
+ :param _FlowIds: 查询的合同流程ID列表最多支持100个流程ID。
8258
+ 如果某个合同流程ID不存在,系统会跳过此ID的查询,继续查询剩余存在的合同流程。
8259
+
8260
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
8088
8261
  :type FlowIds: list of str
8089
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
8262
+ :param _Agent: 代理企业和员工的信息。
8263
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8090
8264
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
8091
8265
  """
8092
8266
  self._Operator = None
@@ -8143,7 +8317,8 @@ class DescribeFlowBriefsResponse(AbstractModel):
8143
8317
 
8144
8318
  def __init__(self):
8145
8319
  r"""
8146
- :param _FlowBriefs: 流程列表
8320
+ :param _FlowBriefs: 合同流程基础信息列表,包含流程的名称、状态、创建日期等基本信息。
8321
+ 注:`与入参 FlowIds 的顺序可能存在不一致的情况。`
8147
8322
  :type FlowBriefs: list of FlowBrief
8148
8323
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
8149
8324
  :type RequestId: str
@@ -8913,7 +9088,9 @@ class DescribeIntegrationEmployeesRequest(AbstractModel):
8913
9088
  :type Limit: int
8914
9089
  :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
8915
9090
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
8916
- :param _Filters: 查询过滤实名用户,Key为Status,Values为["IsVerified"]
9091
+ :param _Filters: 查询过滤实名用户,Key为Status,Values为["IsVerified"],查询过滤未实名用户,Key为Status,Values为["NotVerified"]
9092
+ 查询某个部门的用户,Key为DepartmentId,Values为["DepartmentId"]
9093
+ 根据用户Id查询员工时,Key为UserId,Values为["UserId"]
8917
9094
  根据第三方系统openId过滤查询员工时,Key为StaffOpenId,Values为["OpenId","OpenId",...]
8918
9095
  :type Filters: list of Filter
8919
9096
  :param _Offset: 查询结果分页返回,此处指定第几页,如果不传默认从第一页返回。页码从 0 开始,即首页为 0,最大20000
@@ -9735,11 +9912,13 @@ class DescribeThirdPartyAuthCodeRequest(AbstractModel):
9735
9912
 
9736
9913
  def __init__(self):
9737
9914
  r"""
9738
- :param _AuthCode: 电子签小程序跳转客户小程序时携带的授权查看码
9915
+ :param _AuthCode: 腾讯电子签小程序跳转客户企业小程序时携带的授权查看码,AuthCode由腾讯电子签小程序生成。
9739
9916
  :type AuthCode: str
9740
- :param _Operator: 操作人信息
9917
+ :param _Operator: 执行本接口操作的员工信息。
9918
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9741
9919
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
9742
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
9920
+ :param _Agent: 代理企业和员工的信息。
9921
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9743
9922
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
9744
9923
  """
9745
9924
  self._AuthCode = None
@@ -9796,7 +9975,10 @@ class DescribeThirdPartyAuthCodeResponse(AbstractModel):
9796
9975
 
9797
9976
  def __init__(self):
9798
9977
  r"""
9799
- :param _VerifyStatus: 用户是否实名,VERIFIED 为实名,UNVERIFIED 未实名
9978
+ :param _VerifyStatus: AuthCode 中对应个人用户是否实名
9979
+ <ul>
9980
+ <li> **VERIFIED** : 此个人已实名</li>
9981
+ <li> **UNVERIFIED**: 此个人未实名</li></ul>
9800
9982
  :type VerifyStatus: str
9801
9983
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
9802
9984
  :type RequestId: str
@@ -9833,14 +10015,18 @@ class DescribeUserAutoSignStatusRequest(AbstractModel):
9833
10015
 
9834
10016
  def __init__(self):
9835
10017
  r"""
9836
- :param _Operator: 操作人信息,UserId必填
10018
+ :param _Operator: 执行本接口操作的员工信息。
10019
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9837
10020
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
9838
- :param _SceneKey: 自动签场景:
9839
- E_PRESCRIPTION_AUTO_SIGN 电子处方
10021
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
10022
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
10023
+
10024
+ 注: `现在仅支持电子处方场景`
9840
10025
  :type SceneKey: str
9841
- :param _UserInfo: 要查询开启状态的用户信息
10026
+ :param _UserInfo: 要查询状态的用户信息, 包括名字,身份证等
9842
10027
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
9843
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
10028
+ :param _Agent: 代理企业和员工的信息。
10029
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9844
10030
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
9845
10031
  """
9846
10032
  self._Operator = None
@@ -9911,16 +10097,19 @@ class DescribeUserAutoSignStatusResponse(AbstractModel):
9911
10097
  r"""
9912
10098
  :param _IsOpen: 查询用户是否已开通自动签
9913
10099
  :type IsOpen: bool
9914
- :param _LicenseFrom: 自动签许可生效时间。当且仅当已开通自动签时有值。
10100
+ :param _LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
9915
10101
 
9916
10102
  值为unix时间戳,单位为秒。
9917
10103
  :type LicenseFrom: int
9918
- :param _LicenseTo: 自动签许可到期时间。当且仅当已开通自动签时有值。
10104
+ :param _LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
10105
+
9919
10106
  值为unix时间戳,单位为秒。
9920
10107
  :type LicenseTo: int
9921
- :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。
9922
- 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
9923
- 1-不绑定,发起合同时将按标准合同套餐进行扣减
10108
+ :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
10109
+
10110
+ <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
10111
+ <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
10112
+
9924
10113
  :type LicenseType: int
9925
10114
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
9926
10115
  :type RequestId: str
@@ -9987,14 +10176,16 @@ class DisableUserAutoSignRequest(AbstractModel):
9987
10176
 
9988
10177
  def __init__(self):
9989
10178
  r"""
9990
- :param _Operator: 操作人信息,UserId必填
10179
+ :param _Operator: 执行本接口操作的员工信息。
10180
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9991
10181
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
9992
- :param _SceneKey: 自动签场景:
9993
- E_PRESCRIPTION_AUTO_SIGN 电子处方
10182
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
10183
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
9994
10184
  :type SceneKey: str
9995
- :param _UserInfo: 关闭自动签的个人的三要素
10185
+ :param _UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
9996
10186
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
9997
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
10187
+ :param _Agent: 代理企业和员工的信息。
10188
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9998
10189
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
9999
10190
  """
10000
10191
  self._Operator = None
@@ -11297,49 +11488,57 @@ class FlowCreateApprover(AbstractModel):
11297
11488
 
11298
11489
  def __init__(self):
11299
11490
  r"""
11300
- :param _ApproverType: 参与者类型:
11491
+ :param _ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
11301
11492
  0:企业
11302
11493
  1:个人
11303
- 3:企业自动签署
11304
- 注:类型为3(企业自动签署)时,会自动完成该签署方的签署。
11305
- 自动签署仅进行盖章操作,不能是手写签名。
11306
- 本方企业自动签署的签署人会默认是当前的发起人
11307
- 他方企业自动签署的签署人是自动签模板的他方企业授权人
11494
+ 3:企业静默签署
11495
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
11308
11496
  7: 个人自动签署,适用于个人自动签场景。
11309
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
11497
+ 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
11310
11498
  :type ApproverType: int
11311
- :param _OrganizationName: 签署人企业名称
11312
- 当approverType=0 或 approverType=3时,必须指定
11499
+ :param _OrganizationName: 组织机构名称。
11500
+ 请确认该名称与企业营业执照中注册的名称一致。
11501
+ 如果名称中包含英文括号(),请使用中文括号()代替。
11502
+
11503
+ 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定`
11313
11504
 
11314
11505
 
11315
11506
  :type OrganizationName: str
11316
- :param _ApproverName: 签署方经办人姓名
11317
- <br/>在未指定签署人电子签UserId情况下,为必填参数
11507
+ :param _ApproverName: 签署方经办人的姓名。
11508
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
11509
+
11510
+ 在未指定签署人电子签UserId情况下,为必填参数
11318
11511
  :type ApproverName: str
11319
- :param _ApproverMobile: 签署方经办人手机号码
11320
- <br/>在未指定签署人电子签UserId情况下,为必填参数
11512
+ :param _ApproverMobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
11513
+ 请确认手机号所有方为此合同签署方。
11514
+
11515
+ 在未指定签署人电子签UserId情况下,为必填参数
11321
11516
 
11322
11517
  :type ApproverMobile: str
11323
- :param _ApproverIdCardType: 签署人的证件类型
11324
- ID_CARD 身份证
11325
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
11326
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
11327
- OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
11518
+ :param _ApproverIdCardType: 证件类型,支持以下类型
11519
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
11520
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
11521
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
11328
11522
  :type ApproverIdCardType: str
11329
- :param _ApproverIdCardNumber: 签署人证件号(长度不超过18位)
11523
+ :param _ApproverIdCardNumber: 证件号码,应符合以下规则
11524
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
11525
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
11526
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
11330
11527
  :type ApproverIdCardNumber: str
11331
11528
  :param _RecipientId: 签署方经办人在模板中的参与方ID
11332
11529
  <br/>模板发起合同时,该参数为必填项
11333
11530
  <br/>文件发起合同是,该参数无序传值
11334
11531
 
11335
11532
  :type RecipientId: str
11336
- :param _VerifyChannel: 签署意愿确认渠道,WEIXINAPP:人脸识别
11533
+ :param _VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
11534
+
11535
+ 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
11337
11536
  :type VerifyChannel: list of str
11338
- :param _NotifyType: 是否发送短信
11339
- <br/>sms--短信通知
11340
- <br/>none--不通知
11341
- <br/>默认为sms
11342
- <br/>发起方=签署方时不发送短信
11537
+ :param _NotifyType: 通知签署方经办人的方式, 有以下途径:
11538
+ <ul><li> **sms** : (默认)短信</li>
11539
+ <li> **none** : 不通知</li></ul>
11540
+
11541
+ 注: `发起方也是签署方时不给此签署方发送短信`
11343
11542
  :type NotifyType: str
11344
11543
  :param _IsFullText: 合同强制需要阅读全文,无需传此参数
11345
11544
  :type IsFullText: bool
@@ -11347,22 +11546,20 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
11347
11546
  :type PreReadTime: int
11348
11547
  :param _UserId: 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
11349
11548
 
11350
- 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
11549
+ 注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
11351
11550
  :type UserId: str
11352
- :param _Required: 当前只支持true,默认为true
11551
+ :param _Required: 字段已经废弃,当前只支持true,默认为true
11353
11552
  :type Required: bool
11354
- :param _ApproverSource: 签署人用户来源,此参数仅针对企微用户开放
11355
-
11356
- 企微侧用户请传入:WEWORKAPP
11553
+ :param _ApproverSource: 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
11357
11554
  :type ApproverSource: str
11358
- :param _CustomApproverTag: 企业签署方或签标识,客户自定义,64位长度
11359
- <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
11360
- <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
11361
- <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
11555
+ :param _CustomApproverTag: 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
11556
+ 所有参与或签的人员均需具备该标识。
11557
+ 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
11558
+ 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP
11362
11559
  :type CustomApproverTag: str
11363
- :param _RegisterInfo: 快速注册相关信息,目前暂未开放!
11560
+ :param _RegisterInfo: 已经废弃, 快速注册相关信息
11364
11561
  :type RegisterInfo: :class:`tencentcloud.ess.v20201111.models.RegisterInfo`
11365
- :param _ApproverOption: 签署人个性化能力值
11562
+ :param _ApproverOption: 签署人个性化能力值,如是否可以转发他人处理、是否可以拒签等功能开关。
11366
11563
  :type ApproverOption: :class:`tencentcloud.ess.v20201111.models.ApproverOption`
11367
11564
  :param _JumpUrl: 签署完前端跳转的url,暂未使用
11368
11565
  :type JumpUrl: str
@@ -11370,16 +11567,35 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
11370
11567
  - 发起流程时系统自动补充
11371
11568
  - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
11372
11569
  :type SignId: str
11373
- :param _ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批
11374
- <br>true 则为需要
11375
- <br/>false,无序企业内部审批(默认)
11376
- <br/>为个人签署方时则由发起方企业审核。
11570
+ :param _ApproverNeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
11571
+ <ul><li>**false**:(默认)不需要审批,直接签署。</li>
11572
+ <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
11573
+ 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
11574
+ <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
11575
+ <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
11576
+
11577
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
11377
11578
  :type ApproverNeedSignReview: bool
11378
11579
  :param _SignComponents: 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
11379
- <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
11580
+
11581
+ 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
11582
+ <ul><li> 个人签名/印章</li>
11583
+ <li> 企业印章</li>
11584
+ <li> 骑缝章等签署控件</li></ul>
11585
+
11586
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
11380
11587
  :type SignComponents: list of Component
11381
11588
  :param _Components: 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
11382
- <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
11589
+
11590
+ 合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
11591
+ <ul><li>单行文本控件</li>
11592
+ <li>多行文本控件</li>
11593
+ <li>勾选框控件</li>
11594
+ <li>数字控件</li>
11595
+ <li>图片控件</li>
11596
+ <li>动态表格等填写控件</li></ul>
11597
+
11598
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
11383
11599
  :type Components: list of Component
11384
11600
  :param _ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
11385
11601
  HANDWRITE – 手写签名
@@ -11387,13 +11603,28 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
11387
11603
  ESIGN -- 个人印章类型
11388
11604
  SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
11389
11605
  :type ComponentLimitType: list of str
11390
- :param _ApproverVerifyTypes: 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
11606
+ :param _ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
11607
+ <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
11608
+ <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
11609
+ </li></ul>
11610
+ 注:
11611
+ <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
11612
+ <li>此字段不可传多个校验方式</li></ul>
11613
+
11614
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
11391
11615
 
11392
- > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
11616
+ .
11393
11617
  :type ApproverVerifyTypes: list of int
11394
- :param _ApproverSignTypes: 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
11618
+ :param _ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式,可传递以下值:
11619
+ <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
11620
+ <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
11621
+ <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
11622
+ 注:
11623
+ <ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
11624
+ <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
11395
11625
 
11396
- > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
11626
+ 注:
11627
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
11397
11628
  :type ApproverSignTypes: list of int non-negative
11398
11629
  """
11399
11630
  self._ApproverType = None
@@ -14381,31 +14612,34 @@ class RegisterInfo(AbstractModel):
14381
14612
 
14382
14613
 
14383
14614
  class ReleasedApprover(AbstractModel):
14384
- """解除协议的签署人,如不指定,默认使用待解除流程(即原流程)中的签署人。
14385
- 注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。
14386
- 注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
14387
- 注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole
14615
+ """解除协议的签署人,如不指定,默认使用原流程中的签署人。<br/>
14616
+ `注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。`<br/>
14617
+ `注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。`<br/>
14618
+ `注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole。`<br/>
14388
14619
 
14389
14620
  """
14390
14621
 
14391
14622
  def __init__(self):
14392
14623
  r"""
14393
- :param _Name: 签署人姓名,最大长度50个字符
14624
+ :param _Name: 签署人姓名,最大长度50个字。
14394
14625
 
14395
14626
  :type Name: str
14396
- :param _Mobile: 签署人手机号
14627
+ :param _Mobile: 签署人手机号。
14397
14628
  :type Mobile: str
14398
- :param _RelievedApproverReceiptId: 要替换的参与人在原合同参与人列表中的签署人编号,通过DescribeFlowInfo 接口获取(即FlowDetailInfos. FlowApproverInfos 结构中的ReceiptId )
14629
+ :param _RelievedApproverReceiptId: 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
14399
14630
  :type RelievedApproverReceiptId: str
14400
14631
  :param _ApproverType: 指定签署人类型,目前仅支持
14401
- ORGANIZATION-企业
14402
- ENTERPRISESERVER-企业静默签
14632
+ <ul><li> **ORGANIZATION**:企业(默认值)</li>
14633
+ <li> **ENTERPRISESERVER**:企业静默签</li></ul>
14403
14634
  :type ApproverType: str
14404
- :param _ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件为“印章”或“签名”
14405
- - SIGN_SEAL-默认为印章控件类型
14406
- - SIGN_SIGNATURE-手写签名控件类型
14635
+ :param _ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件类型
14636
+ <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
14637
+ <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
14407
14638
  :type ApproverSignComponentType: str
14408
- :param _ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字符
14639
+ :param _ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的,解除协议默认会将第一个参与人叫`甲方`,第二个叫`乙方`, 第三个叫`丙方`,以此类推。
14640
+
14641
+ 如果需改动此参与人的角色名字,可用此字段指定,由汉字,英文字符,数字组成,最大20个字。
14642
+
14409
14643
  :type ApproverSignRole: str
14410
14644
  """
14411
14645
  self._Name = None
@@ -14488,19 +14722,16 @@ class RelieveInfo(AbstractModel):
14488
14722
 
14489
14723
  def __init__(self):
14490
14724
  r"""
14491
- :param _Reason: 解除理由,最大支持200个字
14725
+ :param _Reason: 解除理由,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
14492
14726
  :type Reason: str
14493
- :param _RemainInForceItem: 解除后仍然有效的条款,保留条款,最大支持200个字
14727
+ :param _RemainInForceItem: 解除后仍然有效的条款,保留条款,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
14494
14728
 
14495
14729
  :type RemainInForceItem: str
14496
- :param _OriginalExpenseSettlement: 原合同事项处理-费用结算,最大支持200个字
14497
-
14730
+ :param _OriginalExpenseSettlement: 原合同事项处理-费用结算,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
14498
14731
  :type OriginalExpenseSettlement: str
14499
- :param _OriginalOtherSettlement: 原合同事项处理-其他事项,最大支持200个字
14500
-
14732
+ :param _OriginalOtherSettlement: 原合同事项处理-其他事项,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
14501
14733
  :type OriginalOtherSettlement: str
14502
- :param _OtherDeals: 其他约定,最大支持200个字
14503
-
14734
+ :param _OtherDeals: 其他约定,长度不能超过200,只能由中文、字母、数字、中文标点和英文标点组成(不支持表情)。
14504
14735
  :type OtherDeals: str
14505
14736
  """
14506
14737
  self._Reason = None
@@ -15129,8 +15360,8 @@ class StartFlowRequest(AbstractModel):
15129
15360
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
15130
15361
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
15131
15362
  :param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
15132
- 0 - 合同发起时通知(默认)
15133
- 1 - 签署完成后通知
15363
+ <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
15364
+ <li> **1** : 签署完成后通知对方来查看合同</li></ul>
15134
15365
  :type CcNotifyType: int
15135
15366
  """
15136
15367
  self._Operator = None
@@ -15212,9 +15443,9 @@ class StartFlowResponse(AbstractModel):
15212
15443
  def __init__(self):
15213
15444
  r"""
15214
15445
  :param _Status: 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
15215
- START - 发起成功
15216
- REVIEW - 提交审核成功
15217
- EXECUTING - 已提交发起任务
15446
+ <ul><li> **START** : 发起成功, 合同进入签署环节</li>
15447
+ <li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能,使用前请联系对接的客户经理沟通。`</li>
15448
+ <li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
15218
15449
  :type Status: str
15219
15450
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
15220
15451
  :type RequestId: str