tencentcloud-sdk-python 3.0.975__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.

Files changed (34) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/cbs/v20170312/cbs_client.py +2 -2
  3. tencentcloud/ccc/v20200210/ccc_client.py +1 -1
  4. tencentcloud/ccc/v20200210/models.py +67 -1
  5. tencentcloud/cdwch/v20200915/cdwch_client.py +23 -0
  6. tencentcloud/cdwch/v20200915/models.py +75 -0
  7. tencentcloud/cfw/v20190904/cfw_client.py +644 -0
  8. tencentcloud/cfw/v20190904/models.py +11557 -5960
  9. tencentcloud/domain/v20180808/errorcodes.py +1 -1
  10. tencentcloud/eb/v20210416/eb_client.py +92 -0
  11. tencentcloud/eb/v20210416/models.py +407 -0
  12. tencentcloud/ess/v20201111/ess_client.py +57 -22
  13. tencentcloud/ess/v20201111/models.py +419 -231
  14. tencentcloud/facefusion/v20181201/facefusion_client.py +3 -1
  15. tencentcloud/iai/v20180301/iai_client.py +0 -1
  16. tencentcloud/iai/v20180301/models.py +4 -12
  17. tencentcloud/iai/v20200303/models.py +5 -13
  18. tencentcloud/mrs/v20200910/models.py +68 -0
  19. tencentcloud/sqlserver/v20180328/models.py +315 -0
  20. tencentcloud/sqlserver/v20180328/sqlserver_client.py +46 -0
  21. tencentcloud/tcr/v20190924/models.py +17 -3
  22. tencentcloud/tcr/v20190924/tcr_client.py +1 -1
  23. tencentcloud/thpc/v20230321/models.py +33 -0
  24. tencentcloud/trocket/v20230308/errorcodes.py +9 -0
  25. tencentcloud/trocket/v20230308/models.py +985 -6
  26. tencentcloud/trocket/v20230308/trocket_client.py +92 -0
  27. tencentcloud/trtc/v20190722/models.py +1 -1
  28. tencentcloud/waf/v20180125/models.py +176 -180
  29. tencentcloud/waf/v20180125/waf_client.py +46 -46
  30. {tencentcloud_sdk_python-3.0.975.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/METADATA +1 -1
  31. {tencentcloud_sdk_python-3.0.975.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/RECORD +34 -34
  32. {tencentcloud_sdk_python-3.0.975.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/LICENSE +0 -0
  33. {tencentcloud_sdk_python-3.0.975.dist-info → tencentcloud_sdk_python-3.0.977.dist-info}/WHEEL +0 -0
  34. {tencentcloud_sdk_python-3.0.975.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 _CallbackUrl: 接受回调URL地址。支持http://或者https://协议
618
-
619
- Post数据到此地址后返回httpcode200表示接受回调成功, 返回其他httpcode表示接受回调失败
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: 是否需要回调的时候返回印章(签名) 图片的 base64
630
-
631
- false-不需要(默认)
632
- true-需要
625
+ :param _SealImgCallback: 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
626
+ <ul><li>**false**: 不需要(默认)</li>
627
+ <li>**true**: 需要</li></ul>
633
628
  :type SealImgCallback: bool
634
- :param _VerifyChannels: 开通时候的验证方式, 分布为
635
-
636
- WEIXINAPP : 微信人脸识别
637
- INSIGHT : 慧眼人脸认别
638
- TELECOM : 运营商三要素验证
639
-
640
- 如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。
641
-
642
- 如果是 H5 开通链接,支持传 INSIGHT / TELECOM。默认值 WEIXINAPP / INSIGHT。
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: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。
645
- 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
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())
@@ -1003,13 +1005,16 @@ class CancelFlowRequest(AbstractModel):
1003
1005
 
1004
1006
  def __init__(self):
1005
1007
  r"""
1006
- :param _Operator: 调用方用户信息,userId 必填
1008
+ :param _Operator: 执行本接口操作的员工信息。
1009
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1007
1010
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
1008
- :param _FlowId: 签署流程id
1011
+ :param _FlowId: 合同流程ID, 为32位字符串。
1012
+ 建议开发者保存此流程ID方便后续其他操作。
1009
1013
  :type FlowId: str
1010
- :param _CancelMessage: 撤销原因,最长200个字符;
1014
+ :param _CancelMessage: 撤销此合同(流程)的原因,最长200个字。
1011
1015
  :type CancelMessage: str
1012
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1016
+ :param _Agent: 代理企业和员工的信息。
1017
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1013
1018
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
1014
1019
  """
1015
1020
  self._Operator = None
@@ -1101,11 +1106,13 @@ class CancelMultiFlowSignQRCodeRequest(AbstractModel):
1101
1106
 
1102
1107
  def __init__(self):
1103
1108
  r"""
1104
- :param _Operator: 调用方用户信息,userId 必填
1109
+ :param _Operator: 执行本接口操作的员工信息。
1110
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
1105
1111
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
1106
- :param _QrCodeId: 二维码id
1112
+ :param _QrCodeId: 二维码ID,为32位字符串。
1107
1113
  :type QrCodeId: str
1108
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
1114
+ :param _Agent: 代理企业和员工的信息。
1115
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1109
1116
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
1110
1117
  """
1111
1118
  self._Operator = None
@@ -1187,17 +1194,25 @@ class CancelUserAutoSignEnableUrlRequest(AbstractModel):
1187
1194
 
1188
1195
  def __init__(self):
1189
1196
  r"""
1190
- :param _Operator: 操作人信息,UseId必填
1197
+ :param _Operator: 执行本接口操作的员工信息。
1198
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
1191
1199
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
1192
- :param _SceneKey: 自动签场景: E_PRESCRIPTION_AUTO_SIGN 电子处方
1200
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
1201
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
1202
+
1203
+ 注: `现在仅支持电子处方场景`
1193
1204
  :type SceneKey: str
1194
- :param _UserInfo: 指定撤销链接的用户指定撤销链接的用户信息,包含姓名、证件类型、证件号码。
1205
+ :param _UserInfo: 预撤销链接的用户信息,包含姓名、证件类型、证件号码等信息。
1195
1206
 
1196
1207
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
1208
+ :param _Agent: 代理企业和员工的信息。
1209
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
1210
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
1197
1211
  """
1198
1212
  self._Operator = None
1199
1213
  self._SceneKey = None
1200
1214
  self._UserInfo = None
1215
+ self._Agent = None
1201
1216
 
1202
1217
  @property
1203
1218
  def Operator(self):
@@ -1223,6 +1238,14 @@ class CancelUserAutoSignEnableUrlRequest(AbstractModel):
1223
1238
  def UserInfo(self, UserInfo):
1224
1239
  self._UserInfo = UserInfo
1225
1240
 
1241
+ @property
1242
+ def Agent(self):
1243
+ return self._Agent
1244
+
1245
+ @Agent.setter
1246
+ def Agent(self, Agent):
1247
+ self._Agent = Agent
1248
+
1226
1249
 
1227
1250
  def _deserialize(self, params):
1228
1251
  if params.get("Operator") is not None:
@@ -1232,6 +1255,9 @@ class CancelUserAutoSignEnableUrlRequest(AbstractModel):
1232
1255
  if params.get("UserInfo") is not None:
1233
1256
  self._UserInfo = UserThreeFactor()
1234
1257
  self._UserInfo._deserialize(params.get("UserInfo"))
1258
+ if params.get("Agent") is not None:
1259
+ self._Agent = Agent()
1260
+ self._Agent._deserialize(params.get("Agent"))
1235
1261
  memeber_set = set(params.keys())
1236
1262
  for name, value in vars(self).items():
1237
1263
  property_name = name[1:]
@@ -2067,15 +2093,31 @@ class CreateConvertTaskApiRequest(AbstractModel):
2067
2093
 
2068
2094
  def __init__(self):
2069
2095
  r"""
2070
- :param _ResourceType: 资源类型 支持doc,docx,html,xls,xlsx,jpg,jpeg,png,bmp文件类型
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>
2071
2107
  :type ResourceType: str
2072
- :param _ResourceName: 资源名称,长度限制为256字符
2108
+ :param _ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
2109
+
2110
+ 注: `资源名称长度限制为256个字符`
2073
2111
  :type ResourceName: str
2074
- :param _ResourceId: 文件Id,通过UploadFiles获取
2112
+ :param _ResourceId: 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
2113
+
2114
+ 注: `目前,此接口仅支持单个文件进行转换。`
2075
2115
  :type ResourceId: str
2076
- :param _Operator: 调用方用户信息,userId 必填
2116
+ :param _Operator: 执行本接口操作的员工信息。
2117
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
2077
2118
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
2078
- :param _Agent: 代理企业和员工的信息。 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2119
+ :param _Agent: 代理企业和员工的信息。
2120
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2079
2121
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
2080
2122
  :param _Organization: 暂未开放
2081
2123
  :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
@@ -2170,7 +2212,7 @@ class CreateConvertTaskApiResponse(AbstractModel):
2170
2212
 
2171
2213
  def __init__(self):
2172
2214
  r"""
2173
- :param _TaskId: 转换任务Id
2215
+ :param _TaskId: 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
2174
2216
  :type TaskId: str
2175
2217
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
2176
2218
  :type RequestId: str
@@ -2209,22 +2251,30 @@ class CreateDocumentRequest(AbstractModel):
2209
2251
  r"""
2210
2252
  :param _Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
2211
2253
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
2212
- :param _FlowId: 签署流程编号,由CreateFlow接口返回
2254
+ :param _FlowId: 合同流程ID,为32位字符串。
2255
+ 此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
2213
2256
  :type FlowId: str
2214
- :param _TemplateId: 用户上传的模板ID
2257
+ :param _TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
2258
+ 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
2215
2259
  :type TemplateId: str
2216
2260
  :param _FileNames: 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
2217
2261
  :type FileNames: list of str
2218
- :param _FormFields: 内容控件信息数组
2262
+ :param _FormFields: 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
2219
2263
  :type FormFields: list of FormField
2220
- :param _NeedPreview: 是否需要生成预览文件 默认不生成;
2221
- 预览链接有效期300秒;
2264
+ :param _NeedPreview: 是否为预览模式,取值如下:
2265
+ <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
2266
+ <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
2222
2267
  :type NeedPreview: bool
2223
- :param _PreviewType: 预览链接类型 默认:0-文件流, 1- H5链接 注意:此参数在NeedPreview 为true 时有效,
2268
+ :param _PreviewType: 预览模式下产生的预览链接类型
2269
+ <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
2270
+ <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
2271
+ 注: `此参数在NeedPreview 为true时有效`
2272
+
2224
2273
  :type PreviewType: int
2225
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
2274
+ :param _Agent: 代理企业和员工的信息。
2275
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
2226
2276
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
2227
- :param _ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
2277
+ :param _ClientToken: 已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
2228
2278
  :type ClientToken: str
2229
2279
  """
2230
2280
  self._Operator = None
@@ -2346,9 +2396,14 @@ class CreateDocumentResponse(AbstractModel):
2346
2396
 
2347
2397
  def __init__(self):
2348
2398
  r"""
2349
- :param _DocumentId: 签署流程电子文档ID
2399
+ :param _DocumentId: 合同流程的底层电子文档ID,为32位字符串。
2400
+
2401
+ 注:
2402
+ 后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>,合同才能进入签署环节
2350
2403
  :type DocumentId: str
2351
- :param _PreviewFileUrl: 签署流程文件的预览地址, 5分钟内有效。仅当NeedPreview为true 时返回
2404
+ :param _PreviewFileUrl: 合同预览链接URL。
2405
+
2406
+ 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
2352
2407
  注意:此字段可能返回 null,表示取不到有效值。
2353
2408
  :type PreviewFileUrl: str
2354
2409
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -3753,45 +3808,75 @@ class CreateFlowRequest(AbstractModel):
3753
3808
 
3754
3809
  def __init__(self):
3755
3810
  r"""
3756
- :param _Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
3811
+ :param _Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId
3812
+ 支持填入集团子公司经办人 userId 代发合同。
3813
+
3814
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
3757
3815
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
3758
- :param _FlowName: 签署流程名称,最大长度200个字符
3816
+ :param _FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
3817
+
3818
+ 该名称还将用于合同签署完成后的下载文件名。
3759
3819
  :type FlowName: str
3760
- :param _Approvers: 签署流程参与者信息,最大限制50
3761
- 注意 approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效。
3820
+ :param _Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
3821
+
3822
+ 注: `approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效`
3762
3823
  :type Approvers: list of FlowCreateApprover
3763
- :param _FlowDescription: 签署流程描述,最大长度1000个字符
3824
+ :param _FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
3764
3825
  :type FlowDescription: str
3765
- :param _FlowType: 签署流程的类型(如销售合同/入职合同等),最大长度200个字符
3826
+ :param _FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
3766
3827
  :type FlowType: str
3767
- :param _ClientToken: 客户端Token,保持接口幂等性,最大长度64个字符
3828
+ :param _ClientToken: 已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
3768
3829
  :type ClientToken: str
3769
- :param _DeadLine: 签署流程的签署截止时间。
3770
-
3771
- 值为unix时间戳,精确到秒,不传默认为当前时间一年后
3830
+ :param _DeadLine: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
3831
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
3772
3832
  :type DeadLine: int
3773
- :param _RemindedOn: 合同到期提醒时间戳,单位秒。设定该值后,可以提前进行到期通知,方便客户处理合同到期事务,如合同续签等。该值支持的范围是从发起时间起到往后的10年内。仅合同发起方企业的发起人可以编辑修改。
3833
+ :param _RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
3834
+
3835
+ 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
3774
3836
  :type RemindedOn: int
3775
- :param _UserData: 用户自定义字段,回调的时候会进行透传,长度需要小于20480
3837
+ :param _UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
3838
+
3839
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
3776
3840
  :type UserData: str
3777
- :param _Unordered: 发送类型:
3778
- true:无序签
3779
- false:有序签
3780
- 注:默认为false(有序签),请和模板中的配置保持一致
3841
+ :param _Unordered: 合同流程的签署顺序类型:
3842
+ <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
3843
+ <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
3844
+ 注:`请和模板中的配置保持一致`
3781
3845
  :type Unordered: bool
3782
- :param _CustomShowMap: 合同显示的页卡模板,说明:只支持{合同名称}, {发起方企业}, {发起方姓名}, {签署方N企业}, {签署方N姓名},且N不能超过签署人的数量,N从1开始
3783
- :type CustomShowMap: str
3784
- :param _NeedSignReview: 发起方企业的签署人进行签署操作是否需要企业内部审批。使用此功能需要发起方企业有参与签署。
3785
- 若设置为true,审核结果需通过接口 CreateFlowSignReview 通知电子签,审核通过后,发起方企业签署人方可进行签署操作,否则会阻塞其签署操作。
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开始,不能超过签署人的数量。
3786
3853
 
3787
- 注:企业可以通过此功能与企业内部的审批流程进行关联,支持手动、静默签署合同。
3854
+ 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
3855
+
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
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
3788
3869
  :type NeedSignReview: bool
3789
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
3870
+ :param _Agent: 代理企业和员工的信息。
3871
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
3790
3872
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
3791
- :param _CcInfos: 被抄送人的信息列表。
3792
- 注: 此功能为白名单功能,若有需要,请联系电子签客服开白使用。
3873
+ :param _CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
3874
+
3875
+ 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
3793
3876
  :type CcInfos: list of CcInfo
3794
- :param _AutoSignScene: 个人自动签场景。发起自动签署时,需设置对应自动签署场景,目前仅支持场景:处方单-E_PRESCRIPTION_AUTO_SIGN
3877
+ :param _AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
3878
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
3879
+ 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
3795
3880
  :type AutoSignScene: str
3796
3881
  :param _RelatedFlowId: 暂未开放
3797
3882
  :type RelatedFlowId: str
@@ -4010,11 +4095,13 @@ class CreateFlowResponse(AbstractModel):
4010
4095
 
4011
4096
  def __init__(self):
4012
4097
  r"""
4013
- :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>接口将合同开始后,合同才能进入签署环节
4014
4103
 
4015
- 返回的流程编号,需要在CreateDocument,StartFlow中使用,
4016
4104
 
4017
- 注意:这三个接口(CreateFlow,CreateDocument,StartFlow)要一并调用,才算发起成功
4018
4105
  :type FlowId: str
4019
4106
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
4020
4107
  :type RequestId: str
@@ -4196,19 +4283,25 @@ class CreateFlowSignUrlRequest(AbstractModel):
4196
4283
 
4197
4284
  def __init__(self):
4198
4285
  r"""
4199
- :param _FlowId: 流程编号
4286
+ :param _FlowId: 合同流程ID,为32位字符串。
4287
+ 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
4288
+ 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
4200
4289
  :type FlowId: str
4201
- :param _FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,ApproverType目前只支持个人类型的签署人。
4290
+ :param _FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
4202
4291
 
4203
- 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。
4292
+ 注:
4293
+ `1. ApproverType目前只支持个人类型的签署人。`
4294
+ `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
4204
4295
  :type FlowApproverInfos: list of FlowCreateApprover
4205
- :param _Operator: 用户信息,此结构体UserId必填
4296
+ :param _Operator: 执行本接口操作的员工信息。
4297
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
4206
4298
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
4207
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
4299
+ :param _Agent: 代理企业和员工的信息。
4300
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
4208
4301
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
4209
4302
  :param _Organization: 机构信息,暂未开放
4210
4303
  :type Organization: :class:`tencentcloud.ess.v20201111.models.OrganizationInfo`
4211
- :param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接支持http://和https://,最大长度1000个字符。
4304
+ :param _JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
4212
4305
  :type JumpUrl: str
4213
4306
  """
4214
4307
  self._FlowId = None
@@ -5987,27 +6080,39 @@ class CreateReleaseFlowRequest(AbstractModel):
5987
6080
 
5988
6081
  def __init__(self):
5989
6082
  r"""
5990
- :param _Operator: 调用方用户信息,userId 必填
6083
+ :param _Operator: 执行本接口操作的员工信息。
6084
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
5991
6085
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
5992
- :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)
6086
+ :param _NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
5993
6087
  :type NeedRelievedFlowId: str
5994
- :param _ReliveInfo: 解除协议内容
6088
+ :param _ReliveInfo: 解除协议内容。
5995
6089
  :type ReliveInfo: :class:`tencentcloud.ess.v20201111.models.RelieveInfo`
5996
- :param _ReleasedApprovers: 非必须,解除协议的本企业签署人列表,
5997
- 默认使用原流程的签署人列表,当解除协议的签署人与原流程的签署人不能相同时(例如原流程签署人离职了),需要指定本企业其他已实名员工来替换原流程中的原签署人,注意需要指明原签署人的编号(ReceiptId,通过DescribeFlowInfo接口获取)来代表需要替换哪一个签署人
5998
- 解除协议的签署人数量不能多于原流程的签署人数量
6090
+ :param _Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
6091
+ :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6092
+ :param _ReleasedApprovers: 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
6093
+ 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
6094
+ 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
6095
+
6096
+ `注意:只能更换同企业的签署人。`<br/>
6097
+ `注意:不支持更换个人类型的签署人。`<br/>
5999
6098
  :type ReleasedApprovers: list of ReleasedApprover
6000
- :param _Deadline: 签署流程的签署截止时间。 值为unix时间戳,精确到秒,不传默认为当前时间七天后
6099
+ :param _Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
6100
+ 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
6001
6101
  :type Deadline: int
6002
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
6003
- :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6102
+ :param _UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
6103
+
6104
+ 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
6105
+
6106
+ 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
6107
+ :type UserData: str
6004
6108
  """
6005
6109
  self._Operator = None
6006
6110
  self._NeedRelievedFlowId = None
6007
6111
  self._ReliveInfo = None
6112
+ self._Agent = None
6008
6113
  self._ReleasedApprovers = None
6009
6114
  self._Deadline = None
6010
- self._Agent = None
6115
+ self._UserData = None
6011
6116
 
6012
6117
  @property
6013
6118
  def Operator(self):
@@ -6033,6 +6138,14 @@ class CreateReleaseFlowRequest(AbstractModel):
6033
6138
  def ReliveInfo(self, ReliveInfo):
6034
6139
  self._ReliveInfo = ReliveInfo
6035
6140
 
6141
+ @property
6142
+ def Agent(self):
6143
+ return self._Agent
6144
+
6145
+ @Agent.setter
6146
+ def Agent(self, Agent):
6147
+ self._Agent = Agent
6148
+
6036
6149
  @property
6037
6150
  def ReleasedApprovers(self):
6038
6151
  return self._ReleasedApprovers
@@ -6050,12 +6163,12 @@ class CreateReleaseFlowRequest(AbstractModel):
6050
6163
  self._Deadline = Deadline
6051
6164
 
6052
6165
  @property
6053
- def Agent(self):
6054
- return self._Agent
6166
+ def UserData(self):
6167
+ return self._UserData
6055
6168
 
6056
- @Agent.setter
6057
- def Agent(self, Agent):
6058
- self._Agent = Agent
6169
+ @UserData.setter
6170
+ def UserData(self, UserData):
6171
+ self._UserData = UserData
6059
6172
 
6060
6173
 
6061
6174
  def _deserialize(self, params):
@@ -6066,6 +6179,9 @@ class CreateReleaseFlowRequest(AbstractModel):
6066
6179
  if params.get("ReliveInfo") is not None:
6067
6180
  self._ReliveInfo = RelieveInfo()
6068
6181
  self._ReliveInfo._deserialize(params.get("ReliveInfo"))
6182
+ if params.get("Agent") is not None:
6183
+ self._Agent = Agent()
6184
+ self._Agent._deserialize(params.get("Agent"))
6069
6185
  if params.get("ReleasedApprovers") is not None:
6070
6186
  self._ReleasedApprovers = []
6071
6187
  for item in params.get("ReleasedApprovers"):
@@ -6073,9 +6189,7 @@ class CreateReleaseFlowRequest(AbstractModel):
6073
6189
  obj._deserialize(item)
6074
6190
  self._ReleasedApprovers.append(obj)
6075
6191
  self._Deadline = params.get("Deadline")
6076
- if params.get("Agent") is not None:
6077
- self._Agent = Agent()
6078
- self._Agent._deserialize(params.get("Agent"))
6192
+ self._UserData = params.get("UserData")
6079
6193
  memeber_set = set(params.keys())
6080
6194
  for name, value in vars(self).items():
6081
6195
  property_name = name[1:]
@@ -6094,6 +6208,7 @@ class CreateReleaseFlowResponse(AbstractModel):
6094
6208
  def __init__(self):
6095
6209
  r"""
6096
6210
  :param _FlowId: 解除协议流程编号
6211
+ `注意:这里的流程编号对应的合同是本次发起的解除协议。`
6097
6212
 
6098
6213
  :type FlowId: str
6099
6214
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
@@ -6834,27 +6949,30 @@ class CreateUserAutoSignEnableUrlRequest(AbstractModel):
6834
6949
 
6835
6950
  def __init__(self):
6836
6951
  r"""
6837
- :param _Operator: 操作人信息,UserId必填
6952
+ :param _Operator: 执行本接口操作的员工信息。
6953
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
6838
6954
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
6839
- :param _SceneKey: 自动签场景:
6840
- E_PRESCRIPTION_AUTO_SIGN 电子处方
6955
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
6956
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
6957
+
6958
+ 注: `现在仅支持电子处方场景`
6841
6959
  :type SceneKey: str
6842
- :param _AutoSignConfig: 自动签开通,签署相关配置
6960
+ :param _AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
6843
6961
  :type AutoSignConfig: :class:`tencentcloud.ess.v20201111.models.AutoSignConfig`
6844
- :param _UrlType: 链接类型,
6845
- 空-默认小程序端链接
6846
- H5SIGN-h5端链接
6962
+ :param _UrlType: 生成的链接类型:
6963
+ <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
6964
+ <li> **H5SIGN** : 生成H5端开通链接</li></ul>
6847
6965
  :type UrlType: str
6848
- :param _NotifyType: 通知类型
6849
-
6850
- 默认不设置为不通知开通方,
6851
- SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
6966
+ :param _NotifyType: 是否通知开通方,通知类型:
6967
+ <ul><li>默认不设置为不通知开通方</li>
6968
+ <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
6852
6969
  :type NotifyType: str
6853
6970
  :param _NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
6854
6971
  :type NotifyAddress: str
6855
- :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为30天。如果不传,默认有效期为7天。
6972
+ :param _ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
6856
6973
  :type ExpiredTime: int
6857
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
6974
+ :param _Agent: 代理企业和员工的信息。
6975
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
6858
6976
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
6859
6977
  """
6860
6978
  self._Operator = None
@@ -6963,17 +7081,27 @@ class CreateUserAutoSignEnableUrlResponse(AbstractModel):
6963
7081
 
6964
7082
  def __init__(self):
6965
7083
  r"""
6966
- :param _Url: 跳转短链
7084
+ :param _Url: 个人用户自动签的开通链接, 短链形式
6967
7085
  :type Url: str
6968
- :param _AppId: 小程序AppId
7086
+ :param _AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
7087
+
7088
+ 注: `如果获取的是H5链接, 则不会返回此值`
6969
7089
  :type AppId: str
6970
- :param _AppOriginalId: 小程序 原始 Id
7090
+ :param _AppOriginalId: 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
7091
+
7092
+ 注: `如果获取的是H5链接, 则不会返回此值`
6971
7093
  :type AppOriginalId: str
6972
- :param _Path: 跳转路径
7094
+ :param _Path: 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
7095
+
7096
+ 注: `如果获取的是H5链接, 则不会返回此值`
6973
7097
  :type Path: str
6974
- :param _QrCode: base64格式跳转二维码,可以通过微信扫描后跳转到业务界面
7098
+ :param _QrCode: base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
7099
+
7100
+ 注: `如果获取的是H5链接, 则不会返回此二维码图片`
6975
7101
  :type QrCode: str
6976
- :param _UrlType: 链接类型,空-默认小程序端链接,H5SIGN-h5端链接
7102
+ :param _UrlType: 返回的链接类型
7103
+ <ul><li> 空: 默认小程序端链接</li>
7104
+ <li> **H5SIGN** : h5端链接</li></ul>
6977
7105
  :type UrlType: str
6978
7106
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
6979
7107
  :type RequestId: str
@@ -8239,12 +8367,13 @@ class DescribeFlowEvidenceReportRequest(AbstractModel):
8239
8367
 
8240
8368
  def __init__(self):
8241
8369
  r"""
8242
- :param _Operator: 调用方用户信息,userId 必填
8370
+ :param _Operator: 执行本接口操作的员工信息。
8371
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
8243
8372
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
8244
- :param _ReportId: 出证报告编号
8373
+ :param _ReportId: 签署报告编号
8245
8374
  :type ReportId: str
8246
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
8247
-
8375
+ :param _Agent: 代理企业和员工的信息。
8376
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
8248
8377
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
8249
8378
  """
8250
8379
  self._Operator = None
@@ -8304,11 +8433,12 @@ class DescribeFlowEvidenceReportResponse(AbstractModel):
8304
8433
  :param _ReportUrl: 出证报告PDF的下载 URL
8305
8434
  注意:此字段可能返回 null,表示取不到有效值。
8306
8435
  :type ReportUrl: str
8307
- :param _Status: 出证任务执行的状态, 分布表示下面的含义
8308
-
8309
- EvidenceStatusExecuting 出证任务在执行中
8310
- EvidenceStatusSuccess 出证任务执行成功
8311
- EvidenceStatusFailed 出证任务执行失败
8436
+ :param _Status: 签署报告出证任务的状态
8437
+ <ul>
8438
+ <li>EvidenceStatusExecuting : 出证任务在执行中</li>
8439
+ <li>EvidenceStatusSuccess : 出证任务执行成功</li>
8440
+ <li>EvidenceStatusFailed : 出证任务执行失败</li>
8441
+ </ul>
8312
8442
  :type Status: str
8313
8443
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
8314
8444
  :type RequestId: str
@@ -9781,14 +9911,18 @@ class DescribeUserAutoSignStatusRequest(AbstractModel):
9781
9911
 
9782
9912
  def __init__(self):
9783
9913
  r"""
9784
- :param _Operator: 操作人信息,UserId必填
9914
+ :param _Operator: 执行本接口操作的员工信息。
9915
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9785
9916
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
9786
- :param _SceneKey: 自动签场景:
9787
- E_PRESCRIPTION_AUTO_SIGN 电子处方
9917
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
9918
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
9919
+
9920
+ 注: `现在仅支持电子处方场景`
9788
9921
  :type SceneKey: str
9789
- :param _UserInfo: 要查询开启状态的用户信息
9922
+ :param _UserInfo: 要查询状态的用户信息, 包括名字,身份证等
9790
9923
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
9791
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
9924
+ :param _Agent: 代理企业和员工的信息。
9925
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9792
9926
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
9793
9927
  """
9794
9928
  self._Operator = None
@@ -9859,16 +9993,19 @@ class DescribeUserAutoSignStatusResponse(AbstractModel):
9859
9993
  r"""
9860
9994
  :param _IsOpen: 查询用户是否已开通自动签
9861
9995
  :type IsOpen: bool
9862
- :param _LicenseFrom: 自动签许可生效时间。当且仅当已开通自动签时有值。
9996
+ :param _LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
9863
9997
 
9864
9998
  值为unix时间戳,单位为秒。
9865
9999
  :type LicenseFrom: int
9866
- :param _LicenseTo: 自动签许可到期时间。当且仅当已开通自动签时有值。
10000
+ :param _LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
10001
+
9867
10002
  值为unix时间戳,单位为秒。
9868
10003
  :type LicenseTo: int
9869
- :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。一旦绑定后,将扣减购买的个人自动签账号许可一次(1年有效期),不可解绑释放。不传默认为绑定自动签账号许可。
9870
- 0-绑定个人自动签账号许可,开通后将扣减购买的个人自动签账号许可一次
9871
- 1-不绑定,发起合同时将按标准合同套餐进行扣减
10004
+ :param _LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
10005
+
10006
+ <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
10007
+ <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
10008
+
9872
10009
  :type LicenseType: int
9873
10010
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
9874
10011
  :type RequestId: str
@@ -9935,14 +10072,16 @@ class DisableUserAutoSignRequest(AbstractModel):
9935
10072
 
9936
10073
  def __init__(self):
9937
10074
  r"""
9938
- :param _Operator: 操作人信息,UserId必填
10075
+ :param _Operator: 执行本接口操作的员工信息。
10076
+ 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
9939
10077
  :type Operator: :class:`tencentcloud.ess.v20201111.models.UserInfo`
9940
- :param _SceneKey: 自动签场景:
9941
- E_PRESCRIPTION_AUTO_SIGN 电子处方
10078
+ :param _SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
10079
+ <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
9942
10080
  :type SceneKey: str
9943
- :param _UserInfo: 关闭自动签的个人的三要素
10081
+ :param _UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
9944
10082
  :type UserInfo: :class:`tencentcloud.ess.v20201111.models.UserThreeFactor`
9945
- :param _Agent: 代理相关应用信息,如集团主企业代子企业操作的场景中ProxyOrganizationId必填
10083
+ :param _Agent: 代理企业和员工的信息。
10084
+ 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
9946
10085
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
9947
10086
  """
9948
10087
  self._Operator = None
@@ -11007,10 +11146,14 @@ class FlowApproverUrlInfo(AbstractModel):
11007
11146
 
11008
11147
  def __init__(self):
11009
11148
  r"""
11010
- :param _SignUrl: 签署链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
11149
+ :param _SignUrl: 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
11150
+ 注: `注意该链接有效期为30分钟`
11011
11151
  注意:此字段可能返回 null,表示取不到有效值。
11012
11152
  :type SignUrl: str
11013
- :param _ApproverType: 签署人类型 1-个人
11153
+ :param _ApproverType: 签署参与人类型
11154
+ <ul><li> **1** :个人参与方</li></ul>
11155
+
11156
+ 注: `现在仅支持个人参与方`
11014
11157
  注意:此字段可能返回 null,表示取不到有效值。
11015
11158
  :type ApproverType: int
11016
11159
  :param _ApproverName: 签署人姓名
@@ -11019,7 +11162,8 @@ class FlowApproverUrlInfo(AbstractModel):
11019
11162
  :param _ApproverMobile: 签署人手机号
11020
11163
  注意:此字段可能返回 null,表示取不到有效值。
11021
11164
  :type ApproverMobile: str
11022
- :param _LongUrl: 签署长链接。注意该链接有效期为30分钟,同时需要注意保密,不要外泄给无关用户。
11165
+ :param _LongUrl: 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
11166
+ 注: `注意该链接有效期为30分钟`
11023
11167
  注意:此字段可能返回 null,表示取不到有效值。
11024
11168
  :type LongUrl: str
11025
11169
  """
@@ -11240,49 +11384,57 @@ class FlowCreateApprover(AbstractModel):
11240
11384
 
11241
11385
  def __init__(self):
11242
11386
  r"""
11243
- :param _ApproverType: 参与者类型:
11387
+ :param _ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
11244
11388
  0:企业
11245
11389
  1:个人
11246
- 3:企业自动签署
11247
- 注:类型为3(企业自动签署)时,会自动完成该签署方的签署。
11248
- 自动签署仅进行盖章操作,不能是手写签名。
11249
- 本方企业自动签署的签署人会默认是当前的发起人
11250
- 他方企业自动签署的签署人是自动签模板的他方企业授权人
11390
+ 3:企业静默签署
11391
+ 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
11251
11392
  7: 个人自动签署,适用于个人自动签场景。
11252
- 注: 个人自动签场景为白名单功能, 使用前请联系对接的客户经理沟通。
11393
+ 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
11253
11394
  :type ApproverType: int
11254
- :param _OrganizationName: 签署人企业名称
11255
- 当approverType=0 或 approverType=3时,必须指定
11395
+ :param _OrganizationName: 组织机构名称。
11396
+ 请确认该名称与企业营业执照中注册的名称一致。
11397
+ 如果名称中包含英文括号(),请使用中文括号()代替。
11398
+
11399
+ 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定`
11256
11400
 
11257
11401
 
11258
11402
  :type OrganizationName: str
11259
- :param _ApproverName: 签署方经办人姓名
11260
- <br/>在未指定签署人电子签UserId情况下,为必填参数
11403
+ :param _ApproverName: 签署方经办人的姓名。
11404
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
11405
+
11406
+ 在未指定签署人电子签UserId情况下,为必填参数
11261
11407
  :type ApproverName: str
11262
- :param _ApproverMobile: 签署方经办人手机号码
11263
- <br/>在未指定签署人电子签UserId情况下,为必填参数
11408
+ :param _ApproverMobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
11409
+ 请确认手机号所有方为此合同签署方。
11410
+
11411
+ 在未指定签署人电子签UserId情况下,为必填参数
11264
11412
 
11265
11413
  :type ApproverMobile: str
11266
- :param _ApproverIdCardType: 签署人的证件类型
11267
- ID_CARD 身份证
11268
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
11269
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
11270
- 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>
11271
11418
  :type ApproverIdCardType: str
11272
- :param _ApproverIdCardNumber: 签署人证件号(长度不超过18位)
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>
11273
11423
  :type ApproverIdCardNumber: str
11274
11424
  :param _RecipientId: 签署方经办人在模板中的参与方ID
11275
11425
  <br/>模板发起合同时,该参数为必填项
11276
11426
  <br/>文件发起合同是,该参数无序传值
11277
11427
 
11278
11428
  :type RecipientId: str
11279
- :param _VerifyChannel: 签署意愿确认渠道,WEIXINAPP:人脸识别
11429
+ :param _VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
11430
+
11431
+ 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
11280
11432
  :type VerifyChannel: list of str
11281
- :param _NotifyType: 是否发送短信
11282
- <br/>sms--短信通知
11283
- <br/>none--不通知
11284
- <br/>默认为sms
11285
- <br/>发起方=签署方时不发送短信
11433
+ :param _NotifyType: 通知签署方经办人的方式, 有以下途径:
11434
+ <ul><li> **sms** : (默认)短信</li>
11435
+ <li> **none** : 不通知</li></ul>
11436
+
11437
+ 注: `发起方也是签署方时不给此签署方发送短信`
11286
11438
  :type NotifyType: str
11287
11439
  :param _IsFullText: 合同强制需要阅读全文,无需传此参数
11288
11440
  :type IsFullText: bool
@@ -11290,22 +11442,20 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
11290
11442
  :type PreReadTime: int
11291
11443
  :param _UserId: 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
11292
11444
 
11293
- 若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息
11445
+ 注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
11294
11446
  :type UserId: str
11295
- :param _Required: 当前只支持true,默认为true
11447
+ :param _Required: 字段已经废弃,当前只支持true,默认为true
11296
11448
  :type Required: bool
11297
- :param _ApproverSource: 签署人用户来源,此参数仅针对企微用户开放
11298
-
11299
- 企微侧用户请传入:WEWORKAPP
11449
+ :param _ApproverSource: 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
11300
11450
  :type ApproverSource: str
11301
- :param _CustomApproverTag: 企业签署方或签标识,客户自定义,64位长度
11302
- <br>用于发起含有或签签署人的合同。或签参与人必须有此字段。
11303
- <br/>合同内不同或签参与人CustomApproverTag需要保证唯一。
11304
- <br/>如果或签签署人为本方企微参与人,ApproverSource参数需要指定WEWORKAPP
11451
+ :param _CustomApproverTag: 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
11452
+ 所有参与或签的人员均需具备该标识。
11453
+ 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
11454
+ 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP
11305
11455
  :type CustomApproverTag: str
11306
- :param _RegisterInfo: 快速注册相关信息,目前暂未开放!
11456
+ :param _RegisterInfo: 已经废弃, 快速注册相关信息
11307
11457
  :type RegisterInfo: :class:`tencentcloud.ess.v20201111.models.RegisterInfo`
11308
- :param _ApproverOption: 签署人个性化能力值
11458
+ :param _ApproverOption: 签署人个性化能力值,如是否可以转发他人处理、是否可以拒签等功能开关。
11309
11459
  :type ApproverOption: :class:`tencentcloud.ess.v20201111.models.ApproverOption`
11310
11460
  :param _JumpUrl: 签署完前端跳转的url,暂未使用
11311
11461
  :type JumpUrl: str
@@ -11313,16 +11463,35 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
11313
11463
  - 发起流程时系统自动补充
11314
11464
  - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
11315
11465
  :type SignId: str
11316
- :param _ApproverNeedSignReview: 当前签署方进行签署操作是否需要企业内部审批
11317
- <br>true 则为需要
11318
- <br/>false,无序企业内部审批(默认)
11319
- <br/>为个人签署方时则由发起方企业审核。
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
+ 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
11320
11474
  :type ApproverNeedSignReview: bool
11321
11475
  :param _SignComponents: 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
11322
- <br/>文件发起时,可通过该参数为签署人指定签署控件类型以及位置
11476
+
11477
+ 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
11478
+ <ul><li> 个人签名/印章</li>
11479
+ <li> 企业印章</li>
11480
+ <li> 骑缝章等签署控件</li></ul>
11481
+
11482
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
11323
11483
  :type SignComponents: list of Component
11324
11484
  :param _Components: 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
11325
- <br/>文件发起时,可通过该参数为签署人指定填写控件类型以及位置
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
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
11326
11495
  :type Components: list of Component
11327
11496
  :param _ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
11328
11497
  HANDWRITE – 手写签名
@@ -11330,13 +11499,28 @@ OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
11330
11499
  ESIGN -- 个人印章类型
11331
11500
  SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
11332
11501
  :type ComponentLimitType: list of str
11333
- :param _ApproverVerifyTypes: 合同查看方式<br/>默认1 -实名查看 <br/>2-短信验证码查看(企业签署方暂不支持该方式)
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
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
11334
11511
 
11335
- > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
11512
+ .
11336
11513
  :type ApproverVerifyTypes: list of int
11337
- :param _ApproverSignTypes: 合同签署方式(默认1,2) <br/>1-人脸认证 <br/>2-签署密码 <br/>3-运营商三要素
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>
11338
11521
 
11339
- > 注意:此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主.
11522
+ 注:
11523
+ `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
11340
11524
  :type ApproverSignTypes: list of int non-negative
11341
11525
  """
11342
11526
  self._ApproverType = None
@@ -14324,31 +14508,31 @@ class RegisterInfo(AbstractModel):
14324
14508
 
14325
14509
 
14326
14510
  class ReleasedApprover(AbstractModel):
14327
- """解除协议的签署人,如不指定,默认使用待解除流程(即原流程)中的签署人。
14328
- 注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。
14329
- 注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。
14330
- 注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole
14511
+ """解除协议的签署人,如不指定,默认使用原流程中的签署人。<br/>
14512
+ `注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。`<br/>
14513
+ `注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。`<br/>
14514
+ `注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole。`<br/>
14331
14515
 
14332
14516
  """
14333
14517
 
14334
14518
  def __init__(self):
14335
14519
  r"""
14336
- :param _Name: 签署人姓名,最大长度50个字符
14520
+ :param _Name: 签署人姓名,最大长度50个字。
14337
14521
 
14338
14522
  :type Name: str
14339
- :param _Mobile: 签署人手机号
14523
+ :param _Mobile: 签署人手机号。
14340
14524
  :type Mobile: str
14341
- :param _RelievedApproverReceiptId: 要替换的参与人在原合同参与人列表中的签署人编号,通过DescribeFlowInfo 接口获取(即FlowDetailInfos. FlowApproverInfos 结构中的ReceiptId )
14525
+ :param _RelievedApproverReceiptId: 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
14342
14526
  :type RelievedApproverReceiptId: str
14343
14527
  :param _ApproverType: 指定签署人类型,目前仅支持
14344
- ORGANIZATION-企业
14345
- ENTERPRISESERVER-企业静默签
14528
+ <ul><li> **ORGANIZATION**:企业(默认值)</li>
14529
+ <li> **ENTERPRISESERVER**:企业静默签</li></ul>
14346
14530
  :type ApproverType: str
14347
- :param _ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件为“印章”或“签名”
14348
- - SIGN_SEAL-默认为印章控件类型
14349
- - SIGN_SIGNATURE-手写签名控件类型
14531
+ :param _ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件类型
14532
+ <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
14533
+ <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
14350
14534
  :type ApproverSignComponentType: str
14351
- :param _ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。 如果想改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字符
14535
+ :param _ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字。
14352
14536
  :type ApproverSignRole: str
14353
14537
  """
14354
14538
  self._Name = None
@@ -15072,8 +15256,8 @@ class StartFlowRequest(AbstractModel):
15072
15256
  在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
15073
15257
  :type Agent: :class:`tencentcloud.ess.v20201111.models.Agent`
15074
15258
  :param _CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
15075
- 0 - 合同发起时通知(默认)
15076
- 1 - 签署完成后通知
15259
+ <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
15260
+ <li> **1** : 签署完成后通知对方来查看合同</li></ul>
15077
15261
  :type CcNotifyType: int
15078
15262
  """
15079
15263
  self._Operator = None
@@ -15155,9 +15339,9 @@ class StartFlowResponse(AbstractModel):
15155
15339
  def __init__(self):
15156
15340
  r"""
15157
15341
  :param _Status: 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
15158
- START - 发起成功
15159
- REVIEW - 提交审核成功
15160
- EXECUTING - 已提交发起任务
15342
+ <ul><li> **START** : 发起成功, 合同进入签署环节</li>
15343
+ <li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能,使用前请联系对接的客户经理沟通。`</li>
15344
+ <li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
15161
15345
  :type Status: str
15162
15346
  :param _RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
15163
15347
  :type RequestId: str
@@ -16286,14 +16470,18 @@ class UserThreeFactor(AbstractModel):
16286
16470
 
16287
16471
  def __init__(self):
16288
16472
  r"""
16289
- :param _Name: 姓名
16473
+ :param _Name: 签署方经办人的姓名。
16474
+ 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
16290
16475
  :type Name: str
16291
- :param _IdCardType: 证件类型:
16292
- ID_CARD 身份证
16293
- HONGKONG_AND_MACAO 港澳居民来往内地通行证
16294
- HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
16476
+ :param _IdCardType: 证件类型,支持以下类型
16477
+ <ul><li>ID_CARD : 居民身份证 (默认值)</li>
16478
+ <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
16479
+ <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
16295
16480
  :type IdCardType: str
16296
- :param _IdCardNumber: 证件号,如果有 X 请大写
16481
+ :param _IdCardNumber: 证件号码,应符合以下规则
16482
+ <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
16483
+ <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
16484
+ <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
16297
16485
  :type IdCardNumber: str
16298
16486
  """
16299
16487
  self._Name = None