tencentcloud-sdk-ess 3.0.653 → 3.0.655
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.
- checksums.yaml +4 -4
- data/lib/VERSION +1 -1
- data/lib/v20201111/client.rb +56 -22
- data/lib/v20201111/models.rb +393 -224
- metadata +3 -3
data/lib/v20201111/models.rb
CHANGED
@@ -301,48 +301,49 @@ module TencentCloud
|
|
301
301
|
|
302
302
|
# 自动签开启、签署相关配置
|
303
303
|
class AutoSignConfig < TencentCloud::Common::AbstractModel
|
304
|
-
# @param UserInfo:
|
304
|
+
# @param UserInfo: 自动签开通个人用户信息, 包括名字,身份证等
|
305
305
|
# @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
|
306
|
-
# @param
|
307
|
-
|
308
|
-
#
|
309
|
-
# @type CallbackUrl: String
|
310
|
-
# @param CertInfoCallback: 是否回调证书信息
|
311
|
-
# false-不需要 (默认值)
|
312
|
-
# true-需要
|
306
|
+
# @param CertInfoCallback: 是否回调证书信息:
|
307
|
+
# <ul><li>**false**: 不需要(默认)</li>
|
308
|
+
# <li>**true**:需要</li></ul>
|
313
309
|
# @type CertInfoCallback: Boolean
|
314
|
-
# @param UserDefineSeal:
|
315
|
-
# false
|
316
|
-
# true
|
310
|
+
# @param UserDefineSeal: 是否支持用户自定义签名印章:
|
311
|
+
# <ul><li>**false**: 不能自己定义(默认)</li>
|
312
|
+
# <li>**true**: 可以自己定义</li></ul>
|
317
313
|
# @type UserDefineSeal: Boolean
|
318
|
-
# @param SealImgCallback:
|
319
|
-
|
320
|
-
#
|
321
|
-
# true-需要
|
314
|
+
# @param SealImgCallback: 回调中是否需要自动签将要使用的印章(签名) 图片的 base64:
|
315
|
+
# <ul><li>**false**: 不需要(默认)</li>
|
316
|
+
# <li>**true**: 需要</li></ul>
|
322
317
|
# @type SealImgCallback: Boolean
|
323
|
-
# @param
|
324
|
-
|
325
|
-
#
|
326
|
-
#
|
327
|
-
#
|
328
|
-
|
329
|
-
#
|
330
|
-
|
331
|
-
#
|
318
|
+
# @param CallbackUrl: 执行结果的回调URL,该URL仅支持HTTP或HTTPS协议,建议采用HTTPS协议以保证数据传输的安全性。
|
319
|
+
# 腾讯电子签服务器将通过POST方式,application/json格式通知执行结果,请确保外网可以正常访问该URL。
|
320
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
321
|
+
# @type CallbackUrl: String
|
322
|
+
# @param VerifyChannels: 开通时候的身份验证方式, 取值为:
|
323
|
+
# <ul><li>**WEIXINAPP** : 微信人脸识别</li>
|
324
|
+
# <li>**INSIGHT** : 慧眼人脸认别</li>
|
325
|
+
# <li>**TELECOM** : 运营商三要素验证</li></ul>
|
326
|
+
# 注:
|
327
|
+
# <ul><li>如果是小程序开通链接,支持传 WEIXINAPP / TELECOM。为空默认 WEIXINAPP</li>
|
328
|
+
# <li>如果是 H5 开通链接,支持传 INSIGHT / TELECOM。为空默认 INSIGHT </li>
|
332
329
|
# @type VerifyChannels: Array
|
333
|
-
# @param LicenseType:
|
334
|
-
|
335
|
-
# 1
|
330
|
+
# @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
|
331
|
+
|
332
|
+
# <ul><li>**0**: (默认) 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
333
|
+
# <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
|
336
334
|
# @type LicenseType: Integer
|
337
335
|
|
338
|
-
attr_accessor :UserInfo, :
|
336
|
+
attr_accessor :UserInfo, :CertInfoCallback, :UserDefineSeal, :SealImgCallback, :CallbackUrl, :VerifyChannels, :LicenseType
|
337
|
+
extend Gem::Deprecate
|
338
|
+
deprecate :CallbackUrl, :none, 2023, 9
|
339
|
+
deprecate :CallbackUrl=, :none, 2023, 9
|
339
340
|
|
340
|
-
def initialize(userinfo=nil,
|
341
|
+
def initialize(userinfo=nil, certinfocallback=nil, userdefineseal=nil, sealimgcallback=nil, callbackurl=nil, verifychannels=nil, licensetype=nil)
|
341
342
|
@UserInfo = userinfo
|
342
|
-
@CallbackUrl = callbackurl
|
343
343
|
@CertInfoCallback = certinfocallback
|
344
344
|
@UserDefineSeal = userdefineseal
|
345
345
|
@SealImgCallback = sealimgcallback
|
346
|
+
@CallbackUrl = callbackurl
|
346
347
|
@VerifyChannels = verifychannels
|
347
348
|
@LicenseType = licensetype
|
348
349
|
end
|
@@ -352,10 +353,10 @@ module TencentCloud
|
|
352
353
|
@UserInfo = UserThreeFactor.new
|
353
354
|
@UserInfo.deserialize(params['UserInfo'])
|
354
355
|
end
|
355
|
-
@CallbackUrl = params['CallbackUrl']
|
356
356
|
@CertInfoCallback = params['CertInfoCallback']
|
357
357
|
@UserDefineSeal = params['UserDefineSeal']
|
358
358
|
@SealImgCallback = params['SealImgCallback']
|
359
|
+
@CallbackUrl = params['CallbackUrl']
|
359
360
|
@VerifyChannels = params['VerifyChannels']
|
360
361
|
@LicenseType = params['LicenseType']
|
361
362
|
end
|
@@ -483,13 +484,16 @@ module TencentCloud
|
|
483
484
|
|
484
485
|
# CancelFlow请求参数结构体
|
485
486
|
class CancelFlowRequest < TencentCloud::Common::AbstractModel
|
486
|
-
# @param Operator:
|
487
|
+
# @param Operator: 执行本接口操作的员工信息。
|
488
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
487
489
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
488
|
-
# @param FlowId:
|
490
|
+
# @param FlowId: 合同流程ID, 为32位字符串。
|
491
|
+
# 建议开发者保存此流程ID方便后续其他操作。
|
489
492
|
# @type FlowId: String
|
490
|
-
# @param CancelMessage:
|
493
|
+
# @param CancelMessage: 撤销此合同(流程)的原因,最长200个字。
|
491
494
|
# @type CancelMessage: String
|
492
|
-
# @param Agent:
|
495
|
+
# @param Agent: 代理企业和员工的信息。
|
496
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
493
497
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
494
498
|
|
495
499
|
attr_accessor :Operator, :FlowId, :CancelMessage, :Agent
|
@@ -533,11 +537,13 @@ module TencentCloud
|
|
533
537
|
|
534
538
|
# CancelMultiFlowSignQRCode请求参数结构体
|
535
539
|
class CancelMultiFlowSignQRCodeRequest < TencentCloud::Common::AbstractModel
|
536
|
-
# @param Operator:
|
540
|
+
# @param Operator: 执行本接口操作的员工信息。
|
541
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
537
542
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
538
|
-
# @param QrCodeId: 二维码
|
543
|
+
# @param QrCodeId: 二维码ID,为32位字符串。
|
539
544
|
# @type QrCodeId: String
|
540
|
-
# @param Agent:
|
545
|
+
# @param Agent: 代理企业和员工的信息。
|
546
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
541
547
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
542
548
|
|
543
549
|
attr_accessor :Operator, :QrCodeId, :Agent
|
@@ -579,19 +585,27 @@ module TencentCloud
|
|
579
585
|
|
580
586
|
# CancelUserAutoSignEnableUrl请求参数结构体
|
581
587
|
class CancelUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel
|
582
|
-
# @param Operator:
|
588
|
+
# @param Operator: 执行本接口操作的员工信息。
|
589
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
583
590
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
584
|
-
# @param SceneKey:
|
591
|
+
# @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
592
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
593
|
+
|
594
|
+
# 注: `现在仅支持电子处方场景`
|
585
595
|
# @type SceneKey: String
|
586
|
-
# @param UserInfo:
|
596
|
+
# @param UserInfo: 预撤销链接的用户信息,包含姓名、证件类型、证件号码等信息。
|
587
597
|
# @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
|
598
|
+
# @param Agent: 代理企业和员工的信息。
|
599
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
600
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
588
601
|
|
589
|
-
attr_accessor :Operator, :SceneKey, :UserInfo
|
602
|
+
attr_accessor :Operator, :SceneKey, :UserInfo, :Agent
|
590
603
|
|
591
|
-
def initialize(operator=nil, scenekey=nil, userinfo=nil)
|
604
|
+
def initialize(operator=nil, scenekey=nil, userinfo=nil, agent=nil)
|
592
605
|
@Operator = operator
|
593
606
|
@SceneKey = scenekey
|
594
607
|
@UserInfo = userinfo
|
608
|
+
@Agent = agent
|
595
609
|
end
|
596
610
|
|
597
611
|
def deserialize(params)
|
@@ -604,6 +618,10 @@ module TencentCloud
|
|
604
618
|
@UserInfo = UserThreeFactor.new
|
605
619
|
@UserInfo.deserialize(params['UserInfo'])
|
606
620
|
end
|
621
|
+
unless params['Agent'].nil?
|
622
|
+
@Agent = Agent.new
|
623
|
+
@Agent.deserialize(params['Agent'])
|
624
|
+
end
|
607
625
|
end
|
608
626
|
end
|
609
627
|
|
@@ -1038,15 +1056,31 @@ module TencentCloud
|
|
1038
1056
|
|
1039
1057
|
# CreateConvertTaskApi请求参数结构体
|
1040
1058
|
class CreateConvertTaskApiRequest < TencentCloud::Common::AbstractModel
|
1041
|
-
# @param ResourceType:
|
1059
|
+
# @param ResourceType: 需要进行转换的资源文件类型
|
1060
|
+
# 支持的文件类型如下:
|
1061
|
+
# <ul><li>doc</li>
|
1062
|
+
# <li>docx</li>
|
1063
|
+
# <li>xls</li>
|
1064
|
+
# <li>xlsx</li>
|
1065
|
+
# <li>jpg</li>
|
1066
|
+
# <li>jpeg</li>
|
1067
|
+
# <li>png</li>
|
1068
|
+
# <li>bmp</li>
|
1069
|
+
# <li>txt</li></ul>
|
1042
1070
|
# @type ResourceType: String
|
1043
|
-
# @param ResourceName:
|
1071
|
+
# @param ResourceName: 需要进行转换操作的文件资源名称,带资源后缀名。
|
1072
|
+
|
1073
|
+
# 注: `资源名称长度限制为256个字符`
|
1044
1074
|
# @type ResourceName: String
|
1045
|
-
# @param ResourceId:
|
1075
|
+
# @param ResourceId: 需要进行转换操作的文件资源Id,通过<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/UploadFiles" target="_blank">UploadFiles</a>接口获取文件资源Id。
|
1076
|
+
|
1077
|
+
# 注: `目前,此接口仅支持单个文件进行转换。`
|
1046
1078
|
# @type ResourceId: String
|
1047
|
-
# @param Operator:
|
1079
|
+
# @param Operator: 执行本接口操作的员工信息。
|
1080
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。
|
1048
1081
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
1049
|
-
# @param Agent: 代理企业和员工的信息。
|
1082
|
+
# @param Agent: 代理企业和员工的信息。
|
1083
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
1050
1084
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
1051
1085
|
# @param Organization: 暂未开放
|
1052
1086
|
# @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
|
@@ -1086,7 +1120,7 @@ module TencentCloud
|
|
1086
1120
|
|
1087
1121
|
# CreateConvertTaskApi返回参数结构体
|
1088
1122
|
class CreateConvertTaskApiResponse < TencentCloud::Common::AbstractModel
|
1089
|
-
# @param TaskId:
|
1123
|
+
# @param TaskId: 接口返回的文件转换任务Id,可以调用接口<a href="https://qian.tencent.com/developers/companyApis/templatesAndFiles/GetTaskResultApi" target="_blank">查询转换任务状态</a>获取转换任务的状态和转换后的文件资源Id。
|
1090
1124
|
# @type TaskId: String
|
1091
1125
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
1092
1126
|
# @type RequestId: String
|
@@ -1108,22 +1142,29 @@ module TencentCloud
|
|
1108
1142
|
class CreateDocumentRequest < TencentCloud::Common::AbstractModel
|
1109
1143
|
# @param Operator: 调用方用户信息,userId 必填。支持填入集团子公司经办人 userId代发合同。
|
1110
1144
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
1111
|
-
# @param FlowId:
|
1145
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
1146
|
+
# 此接口的合同流程ID需要由<a href="https://qian.tencent.com/developers/companyApis/startFlows/CreateFlow" target="_blank">创建签署流程</a>接口创建得到。
|
1112
1147
|
# @type FlowId: String
|
1113
|
-
# @param TemplateId:
|
1148
|
+
# @param TemplateId: 用户配置的合同模板ID,会基于此模板创建合同文档,为32位字符串。
|
1149
|
+
# 可登录腾讯电子签控制台,在 "模板"->"模板中心"->"列表展示设置"选中模板 ID 中查看某个模板的TemplateId(在页面中展示为模板ID)。
|
1114
1150
|
# @type TemplateId: String
|
1115
1151
|
# @param FileNames: 文件名列表,单个文件名最大长度200个字符,暂时仅支持单文件发起。设置后流程对应的文件名称当前设置的值。
|
1116
1152
|
# @type FileNames: Array
|
1117
|
-
# @param FormFields:
|
1153
|
+
# @param FormFields: 电子文档的填写控件的填充内容。具体方式可以参考<a href="https://qian.tencent.com/developers/companyApis/dataTypes/#formfield" target="_blank">FormField</a>结构体的定义。
|
1118
1154
|
# @type FormFields: Array
|
1119
|
-
# @param NeedPreview:
|
1120
|
-
#
|
1155
|
+
# @param NeedPreview: 是否为预览模式,取值如下:
|
1156
|
+
# <ul><li> **false**:非预览模式(默认),会产生合同流程并返回合同流程编号FlowId。</li>
|
1157
|
+
# <li> **true**:预览模式,不产生合同流程,不返回合同流程编号FlowId,而是返回预览链接PreviewUrl,有效期为300秒,用于查看真实发起后合同的样子。</li></ul>
|
1121
1158
|
# @type NeedPreview: Boolean
|
1122
|
-
# @param PreviewType:
|
1159
|
+
# @param PreviewType: 预览模式下产生的预览链接类型
|
1160
|
+
# <ul><li> **0** :(默认) 文件流 ,点开后后下载预览的合同PDF文件 </li>
|
1161
|
+
# <li> **1** :H5链接 ,点开后在浏览器中展示合同的样子</li></ul>
|
1162
|
+
# 注: `此参数在NeedPreview 为true时有效`
|
1123
1163
|
# @type PreviewType: Integer
|
1124
|
-
# @param Agent:
|
1164
|
+
# @param Agent: 代理企业和员工的信息。
|
1165
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
1125
1166
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
1126
|
-
# @param ClientToken:
|
1167
|
+
# @param ClientToken: 已废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
|
1127
1168
|
# @type ClientToken: String
|
1128
1169
|
|
1129
1170
|
attr_accessor :Operator, :FlowId, :TemplateId, :FileNames, :FormFields, :NeedPreview, :PreviewType, :Agent, :ClientToken
|
@@ -1168,9 +1209,14 @@ module TencentCloud
|
|
1168
1209
|
|
1169
1210
|
# CreateDocument返回参数结构体
|
1170
1211
|
class CreateDocumentResponse < TencentCloud::Common::AbstractModel
|
1171
|
-
# @param DocumentId:
|
1212
|
+
# @param DocumentId: 合同流程的底层电子文档ID,为32位字符串。
|
1213
|
+
|
1214
|
+
# 注:
|
1215
|
+
# 后续需用同样的FlowId再次调用<a href="https://qian.tencent.com/developers/companyApis/startFlows/StartFlow" target="_blank">发起签署流程</a>,合同才能进入签署环节
|
1172
1216
|
# @type DocumentId: String
|
1173
|
-
# @param PreviewFileUrl:
|
1217
|
+
# @param PreviewFileUrl: 合同预览链接URL。
|
1218
|
+
|
1219
|
+
# 注:如果是预览模式(即NeedPreview设置为true)时, 才会有此预览链接URL
|
1174
1220
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
1175
1221
|
# @type PreviewFileUrl: String
|
1176
1222
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
@@ -1895,45 +1941,74 @@ module TencentCloud
|
|
1895
1941
|
|
1896
1942
|
# CreateFlow请求参数结构体
|
1897
1943
|
class CreateFlowRequest < TencentCloud::Common::AbstractModel
|
1898
|
-
# @param Operator:
|
1944
|
+
# @param Operator: 执行本接口操作的员工信息。使用此接口时,必须填写userId。
|
1945
|
+
# 支持填入集团子公司经办人 userId 代发合同。
|
1946
|
+
|
1947
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
1899
1948
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
1900
|
-
# @param FlowName:
|
1949
|
+
# @param FlowName: 合同流程的名称(可自定义此名称),长度不能超过200,只能由中文、字母、数字和下划线组成。
|
1950
|
+
|
1951
|
+
# 该名称还将用于合同签署完成后的下载文件名。
|
1901
1952
|
# @type FlowName: String
|
1902
|
-
# @param Approvers:
|
1903
|
-
|
1953
|
+
# @param Approvers: 合同流程的参与方列表,最多可支持50个参与方,可在列表中指定企业B端签署方和个人C端签署方的联系和认证方式等信息,具体定义可以参考开发者中心的ApproverInfo结构体。
|
1954
|
+
|
1955
|
+
# 注: `approver中的顺序需要和模板中的顺序保持一致, 否则会导致模板中配置的信息无效`
|
1904
1956
|
# @type Approvers: Array
|
1905
|
-
# @param FlowDescription:
|
1957
|
+
# @param FlowDescription: 合同流程描述信息(可自定义此描述),最大长度1000个字符。
|
1906
1958
|
# @type FlowDescription: String
|
1907
|
-
# @param FlowType:
|
1959
|
+
# @param FlowType: 合同流程的类别分类(可自定义名称,如销售合同/入职合同等),最大长度为200个字符,仅限中文、字母、数字和下划线组成。
|
1908
1960
|
# @type FlowType: String
|
1909
|
-
# @param ClientToken:
|
1961
|
+
# @param ClientToken: 已经废弃字段,客户端Token,保持接口幂等性,最大长度64个字符
|
1910
1962
|
# @type ClientToken: String
|
1911
|
-
# @param DeadLine:
|
1912
|
-
|
1913
|
-
# 值为unix时间戳,精确到秒,不传默认为当前时间一年后
|
1963
|
+
# @param DeadLine: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的365天时截止。
|
1964
|
+
# 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
1914
1965
|
# @type DeadLine: Integer
|
1915
|
-
# @param RemindedOn:
|
1966
|
+
# @param RemindedOn: 合同到期提醒时间,为Unix标准时间戳(秒)格式,支持的范围是从发起时间开始到后10年内。
|
1967
|
+
|
1968
|
+
# 到达提醒时间后,腾讯电子签会短信通知发起方企业合同提醒,可用于处理合同到期事务,如合同续签等事宜。
|
1916
1969
|
# @type RemindedOn: Integer
|
1917
|
-
# @param UserData:
|
1970
|
+
# @param UserData: 调用方自定义的个性化字段(可自定义此名称),并以base64方式编码,支持的最大数据大小为 20480长度。
|
1971
|
+
|
1972
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
1918
1973
|
# @type UserData: String
|
1919
|
-
# @param Unordered:
|
1920
|
-
#
|
1921
|
-
#
|
1922
|
-
#
|
1974
|
+
# @param Unordered: 合同流程的签署顺序类型:
|
1975
|
+
# <ul><li> **false**:(默认)有序签署, 本合同多个参与人需要依次签署 </li>
|
1976
|
+
# <li> **true**:无序签署, 本合同多个参与人没有先后签署限制</li></ul>
|
1977
|
+
# 注:`请和模板中的配置保持一致`
|
1923
1978
|
# @type Unordered: Boolean
|
1924
|
-
# @param CustomShowMap:
|
1925
|
-
#
|
1926
|
-
#
|
1927
|
-
#
|
1979
|
+
# @param CustomShowMap: 您可以自定义腾讯电子签小程序合同列表页展示的合同内容模板,模板中支持以下变量:
|
1980
|
+
# <ul><li>{合同名称} </li>
|
1981
|
+
# <li>{发起方企业} </li>
|
1982
|
+
# <li>{发起方姓名} </li>
|
1983
|
+
# <li>{签署方N企业}</li>
|
1984
|
+
# <li>{签署方N姓名}</li></ul>
|
1985
|
+
# 其中,N表示签署方的编号,从1开始,不能超过签署人的数量。
|
1986
|
+
|
1987
|
+
# 例如,如果是腾讯公司张三发给李四名称为“租房合同”的合同,您可以将此字段设置为:`合同名称:{合同名称};发起方: {发起方企业}({发起方姓名});签署方:{签署方1姓名}`,则小程序中列表页展示此合同为以下样子
|
1988
|
+
|
1989
|
+
# 合同名称:租房合同
|
1990
|
+
# 发起方:腾讯公司(张三)
|
1991
|
+
# 签署方:李四
|
1928
1992
|
|
1929
|
-
#
|
1993
|
+
# @type CustomShowMap: String
|
1994
|
+
# @param NeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
1995
|
+
# <ul><li> **false**:(默认)不需要审批,直接签署。</li>
|
1996
|
+
# <li> **true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
1997
|
+
# 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
1998
|
+
# <ul><li> 如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
1999
|
+
# <li> 如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
2000
|
+
# 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
1930
2001
|
# @type NeedSignReview: Boolean
|
1931
|
-
# @param Agent:
|
2002
|
+
# @param Agent: 代理企业和员工的信息。
|
2003
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
1932
2004
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
1933
|
-
# @param CcInfos:
|
1934
|
-
|
2005
|
+
# @param CcInfos: 合同流程的抄送人列表,最多可支持50个抄送人,抄送人可查看合同内容及签署进度,但无需参与合同签署。
|
2006
|
+
|
2007
|
+
# 注:`此功能为白名单功能,使用前请联系对接的客户经理沟通。`
|
1935
2008
|
# @type CcInfos: Array
|
1936
|
-
# @param AutoSignScene:
|
2009
|
+
# @param AutoSignScene: 个人自动签名的使用场景包括以下, 个人自动签署(即ApproverType设置成个人自动签署时)业务此值必传:
|
2010
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN**:处方单(医疗自动签) </li></ul>
|
2011
|
+
# 注: `个人自动签名场景是白名单功能,使用前请与对接的客户经理联系沟通。`
|
1937
2012
|
# @type AutoSignScene: String
|
1938
2013
|
# @param RelatedFlowId: 暂未开放
|
1939
2014
|
# @type RelatedFlowId: String
|
@@ -2010,11 +2085,12 @@ module TencentCloud
|
|
2010
2085
|
|
2011
2086
|
# CreateFlow返回参数结构体
|
2012
2087
|
class CreateFlowResponse < TencentCloud::Common::AbstractModel
|
2013
|
-
# @param FlowId:
|
2088
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
2089
|
+
# 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
2014
2090
|
|
2015
|
-
#
|
2091
|
+
# 注:
|
2092
|
+
# 此返回的合同流程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>接口将合同开始后,合同才能进入签署环节
|
2016
2093
|
|
2017
|
-
# 注意:这三个接口(CreateFlow,CreateDocument,StartFlow)要一并调用,才算发起成功
|
2018
2094
|
# @type FlowId: String
|
2019
2095
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
2020
2096
|
# @type RequestId: String
|
@@ -2107,19 +2183,25 @@ module TencentCloud
|
|
2107
2183
|
|
2108
2184
|
# CreateFlowSignUrl请求参数结构体
|
2109
2185
|
class CreateFlowSignUrlRequest < TencentCloud::Common::AbstractModel
|
2110
|
-
# @param FlowId:
|
2186
|
+
# @param FlowId: 合同流程ID,为32位字符串。
|
2187
|
+
# 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
|
2188
|
+
# 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
|
2111
2189
|
# @type FlowId: String
|
2112
|
-
# @param FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
|
2190
|
+
# @param FlowApproverInfos: 流程签署人列表,其中结构体的ApproverName,ApproverMobile和ApproverType必传,其他可不传,
|
2113
2191
|
|
2114
|
-
#
|
2192
|
+
# 注:
|
2193
|
+
# `1. ApproverType目前只支持个人类型的签署人。`
|
2194
|
+
# `2. 签署人只能有手写签名和时间类型的签署控件,其他类型的填写控件和签署控件暂时都未支持。`
|
2115
2195
|
# @type FlowApproverInfos: Array
|
2116
|
-
# @param Operator:
|
2196
|
+
# @param Operator: 执行本接口操作的员工信息。
|
2197
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
2117
2198
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
2118
|
-
# @param Agent:
|
2199
|
+
# @param Agent: 代理企业和员工的信息。
|
2200
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
2119
2201
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
2120
2202
|
# @param Organization: 机构信息,暂未开放
|
2121
2203
|
# @type Organization: :class:`Tencentcloud::Ess.v20201111.models.OrganizationInfo`
|
2122
|
-
# @param JumpUrl: 签署完之后的H5
|
2204
|
+
# @param JumpUrl: 签署完之后的H5页面的跳转链接,此链接及支持http://和https://,最大长度1000个字符。(建议https协议)
|
2123
2205
|
# @type JumpUrl: String
|
2124
2206
|
|
2125
2207
|
attr_accessor :FlowId, :FlowApproverInfos, :Operator, :Agent, :Organization, :JumpUrl
|
@@ -2985,30 +3067,42 @@ module TencentCloud
|
|
2985
3067
|
|
2986
3068
|
# CreateReleaseFlow请求参数结构体
|
2987
3069
|
class CreateReleaseFlowRequest < TencentCloud::Common::AbstractModel
|
2988
|
-
# @param Operator:
|
3070
|
+
# @param Operator: 执行本接口操作的员工信息。
|
3071
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
2989
3072
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
2990
|
-
# @param NeedRelievedFlowId:
|
3073
|
+
# @param NeedRelievedFlowId: 待解除的签署流程编号(即原签署流程的编号)。
|
2991
3074
|
# @type NeedRelievedFlowId: String
|
2992
|
-
# @param ReliveInfo:
|
3075
|
+
# @param ReliveInfo: 解除协议内容。
|
2993
3076
|
# @type ReliveInfo: :class:`Tencentcloud::Ess.v20201111.models.RelieveInfo`
|
2994
|
-
# @param
|
2995
|
-
#
|
2996
|
-
#
|
3077
|
+
# @param Agent: 关于渠道应用的相关信息,包括子客企业及应用编、号等详细内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
|
3078
|
+
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3079
|
+
# @param ReleasedApprovers: 解除协议的签署人列表(如不指定该参数,默认使用原流程的签署人列表)。 <br/>
|
3080
|
+
# 如需更换原合同中的签署人,可通过指定该签署人的RecipientId编号更换此签署人。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
3081
|
+
# 解除协议的签署人数量不能多于原流程的签署人数量。<br/>
|
3082
|
+
|
3083
|
+
# `注意:只能更换同企业的签署人。`<br/>
|
3084
|
+
# `注意:不支持更换个人类型的签署人。`<br/>
|
2997
3085
|
# @type ReleasedApprovers: Array
|
2998
|
-
# @param Deadline:
|
3086
|
+
# @param Deadline: 合同流程的签署截止时间,格式为Unix标准时间戳(秒),如果未设置签署截止时间,则默认为合同流程创建后的7天时截止。
|
3087
|
+
# 如果在签署截止时间前未完成签署,则合同状态会变为已过期,导致合同作废。
|
2999
3088
|
# @type Deadline: Integer
|
3000
|
-
# @param
|
3001
|
-
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3089
|
+
# @param UserData: 调用方自定义的个性化字段,该字段的值可以是字符串JSON或其他字符串形式,客户可以根据自身需求自定义数据格式并在需要时进行解析。该字段的信息将以Base64编码的形式传输,支持的最大数据大小为20480长度。
|
3002
3090
|
|
3003
|
-
|
3091
|
+
# 在合同状态变更的回调信息等场景中,该字段的信息将原封不动地透传给贵方。
|
3092
|
+
|
3093
|
+
# 回调的相关说明可参考开发者中心的<a href="https://qian.tencent.com/developers/company/callback_types_v2" target="_blank">回调通知</a>模块。
|
3094
|
+
# @type UserData: String
|
3004
3095
|
|
3005
|
-
|
3096
|
+
attr_accessor :Operator, :NeedRelievedFlowId, :ReliveInfo, :Agent, :ReleasedApprovers, :Deadline, :UserData
|
3097
|
+
|
3098
|
+
def initialize(operator=nil, needrelievedflowid=nil, reliveinfo=nil, agent=nil, releasedapprovers=nil, deadline=nil, userdata=nil)
|
3006
3099
|
@Operator = operator
|
3007
3100
|
@NeedRelievedFlowId = needrelievedflowid
|
3008
3101
|
@ReliveInfo = reliveinfo
|
3102
|
+
@Agent = agent
|
3009
3103
|
@ReleasedApprovers = releasedapprovers
|
3010
3104
|
@Deadline = deadline
|
3011
|
-
@
|
3105
|
+
@UserData = userdata
|
3012
3106
|
end
|
3013
3107
|
|
3014
3108
|
def deserialize(params)
|
@@ -3021,6 +3115,10 @@ module TencentCloud
|
|
3021
3115
|
@ReliveInfo = RelieveInfo.new
|
3022
3116
|
@ReliveInfo.deserialize(params['ReliveInfo'])
|
3023
3117
|
end
|
3118
|
+
unless params['Agent'].nil?
|
3119
|
+
@Agent = Agent.new
|
3120
|
+
@Agent.deserialize(params['Agent'])
|
3121
|
+
end
|
3024
3122
|
unless params['ReleasedApprovers'].nil?
|
3025
3123
|
@ReleasedApprovers = []
|
3026
3124
|
params['ReleasedApprovers'].each do |i|
|
@@ -3030,16 +3128,14 @@ module TencentCloud
|
|
3030
3128
|
end
|
3031
3129
|
end
|
3032
3130
|
@Deadline = params['Deadline']
|
3033
|
-
|
3034
|
-
@Agent = Agent.new
|
3035
|
-
@Agent.deserialize(params['Agent'])
|
3036
|
-
end
|
3131
|
+
@UserData = params['UserData']
|
3037
3132
|
end
|
3038
3133
|
end
|
3039
3134
|
|
3040
3135
|
# CreateReleaseFlow返回参数结构体
|
3041
3136
|
class CreateReleaseFlowResponse < TencentCloud::Common::AbstractModel
|
3042
3137
|
# @param FlowId: 解除协议流程编号
|
3138
|
+
# `注意:这里的流程编号对应的合同是本次发起的解除协议。`
|
3043
3139
|
# @type FlowId: String
|
3044
3140
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3045
3141
|
# @type RequestId: String
|
@@ -3397,27 +3493,30 @@ module TencentCloud
|
|
3397
3493
|
|
3398
3494
|
# CreateUserAutoSignEnableUrl请求参数结构体
|
3399
3495
|
class CreateUserAutoSignEnableUrlRequest < TencentCloud::Common::AbstractModel
|
3400
|
-
# @param Operator:
|
3496
|
+
# @param Operator: 执行本接口操作的员工信息。
|
3497
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
3401
3498
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
3402
|
-
# @param SceneKey:
|
3403
|
-
# E_PRESCRIPTION_AUTO_SIGN
|
3499
|
+
# @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
3500
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
3501
|
+
|
3502
|
+
# 注: `现在仅支持电子处方场景`
|
3404
3503
|
# @type SceneKey: String
|
3405
|
-
# @param AutoSignConfig:
|
3504
|
+
# @param AutoSignConfig: 自动签开通配置信息, 包括开通的人员的信息等
|
3406
3505
|
# @type AutoSignConfig: :class:`Tencentcloud::Ess.v20201111.models.AutoSignConfig`
|
3407
|
-
# @param UrlType:
|
3408
|
-
#
|
3409
|
-
# H5SIGN
|
3506
|
+
# @param UrlType: 生成的链接类型:
|
3507
|
+
# <ul><li> 不传(即为空值) 则会生成小程序端开通链接(默认)</li>
|
3508
|
+
# <li> **H5SIGN** : 生成H5端开通链接</li><ul>
|
3410
3509
|
# @type UrlType: String
|
3411
|
-
# @param NotifyType:
|
3412
|
-
|
3413
|
-
#
|
3414
|
-
# SMS 为短信通知 , 此种方式需要NotifyAddress填写手机号。
|
3510
|
+
# @param NotifyType: 是否通知开通方,通知类型:
|
3511
|
+
# <ul><li>默认不设置为不通知开通方</li>
|
3512
|
+
# <li>**SMS** : 短信通知 ,如果需要短信通知则NotifyAddress填写对方的手机号</li><ul>
|
3415
3513
|
# @type NotifyType: String
|
3416
3514
|
# @param NotifyAddress: 如果通知类型NotifyType选择为SMS,则此处为手机号, 其他通知类型不需要设置此项
|
3417
3515
|
# @type NotifyAddress: String
|
3418
|
-
# @param ExpiredTime: 链接的过期时间,格式为Unix
|
3516
|
+
# @param ExpiredTime: 链接的过期时间,格式为Unix时间戳,不能早于当前时间,且最大为当前时间往后30天。`如果不传,默认过期时间为当前时间往后7天。`
|
3419
3517
|
# @type ExpiredTime: Integer
|
3420
|
-
# @param Agent:
|
3518
|
+
# @param Agent: 代理企业和员工的信息。
|
3519
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
3421
3520
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
3422
3521
|
|
3423
3522
|
attr_accessor :Operator, :SceneKey, :AutoSignConfig, :UrlType, :NotifyType, :NotifyAddress, :ExpiredTime, :Agent
|
@@ -3456,17 +3555,27 @@ module TencentCloud
|
|
3456
3555
|
|
3457
3556
|
# CreateUserAutoSignEnableUrl返回参数结构体
|
3458
3557
|
class CreateUserAutoSignEnableUrlResponse < TencentCloud::Common::AbstractModel
|
3459
|
-
# @param Url:
|
3558
|
+
# @param Url: 个人用户自动签的开通链接, 短链形式
|
3460
3559
|
# @type Url: String
|
3461
|
-
# @param AppId:
|
3560
|
+
# @param AppId: 腾讯电子签小程序的 AppID,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
3561
|
+
|
3562
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
3462
3563
|
# @type AppId: String
|
3463
|
-
# @param AppOriginalId:
|
3564
|
+
# @param AppOriginalId: 腾讯电子签小程序的原始 Id, ,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
3565
|
+
|
3566
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
3464
3567
|
# @type AppOriginalId: String
|
3465
|
-
# @param Path:
|
3568
|
+
# @param Path: 腾讯电子签小程序的跳转路径,用于其他小程序/APP等应用跳转至腾讯电子签小程序使用
|
3569
|
+
|
3570
|
+
# 注: `如果获取的是H5链接, 则不会返回此值`
|
3466
3571
|
# @type Path: String
|
3467
|
-
# @param QrCode: base64
|
3572
|
+
# @param QrCode: base64 格式的跳转二维码图片,可通过微信扫描后跳转到腾讯电子签小程序的开通界面。
|
3573
|
+
|
3574
|
+
# 注: `如果获取的是H5链接, 则不会返回此二维码图片`
|
3468
3575
|
# @type QrCode: String
|
3469
|
-
# @param UrlType:
|
3576
|
+
# @param UrlType: 返回的链接类型
|
3577
|
+
# <ul><li> 空: 默认小程序端链接</li>
|
3578
|
+
# <li> **H5SIGN** : h5端链接</li></ul>
|
3470
3579
|
# @type UrlType: String
|
3471
3580
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
3472
3581
|
# @type RequestId: String
|
@@ -4120,11 +4229,13 @@ module TencentCloud
|
|
4120
4229
|
|
4121
4230
|
# DescribeFlowEvidenceReport请求参数结构体
|
4122
4231
|
class DescribeFlowEvidenceReportRequest < TencentCloud::Common::AbstractModel
|
4123
|
-
# @param Operator:
|
4232
|
+
# @param Operator: 执行本接口操作的员工信息。
|
4233
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4124
4234
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4125
|
-
# @param ReportId:
|
4235
|
+
# @param ReportId: 签署报告编号
|
4126
4236
|
# @type ReportId: String
|
4127
|
-
# @param Agent:
|
4237
|
+
# @param Agent: 代理企业和员工的信息。
|
4238
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
4128
4239
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
4129
4240
|
|
4130
4241
|
attr_accessor :Operator, :ReportId, :Agent
|
@@ -4153,11 +4264,12 @@ module TencentCloud
|
|
4153
4264
|
# @param ReportUrl: 出证报告PDF的下载 URL
|
4154
4265
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
4155
4266
|
# @type ReportUrl: String
|
4156
|
-
# @param Status:
|
4157
|
-
|
4158
|
-
# EvidenceStatusExecuting
|
4159
|
-
# EvidenceStatusSuccess
|
4160
|
-
# EvidenceStatusFailed
|
4267
|
+
# @param Status: 签署报告出证任务的状态
|
4268
|
+
# <ul>
|
4269
|
+
# <li>EvidenceStatusExecuting : 出证任务在执行中</li>
|
4270
|
+
# <li>EvidenceStatusSuccess : 出证任务执行成功</li>
|
4271
|
+
# <li>EvidenceStatusFailed : 出证任务执行失败</li>
|
4272
|
+
# </ul>
|
4161
4273
|
# @type Status: String
|
4162
4274
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
4163
4275
|
# @type RequestId: String
|
@@ -4897,14 +5009,18 @@ module TencentCloud
|
|
4897
5009
|
|
4898
5010
|
# DescribeUserAutoSignStatus请求参数结构体
|
4899
5011
|
class DescribeUserAutoSignStatusRequest < TencentCloud::Common::AbstractModel
|
4900
|
-
# @param Operator:
|
5012
|
+
# @param Operator: 执行本接口操作的员工信息。
|
5013
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4901
5014
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4902
|
-
# @param SceneKey:
|
4903
|
-
# E_PRESCRIPTION_AUTO_SIGN
|
5015
|
+
# @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
5016
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN** : 电子处方场景</li></ul>
|
5017
|
+
|
5018
|
+
# 注: `现在仅支持电子处方场景`
|
4904
5019
|
# @type SceneKey: String
|
4905
|
-
# @param UserInfo:
|
5020
|
+
# @param UserInfo: 要查询状态的用户信息, 包括名字,身份证等
|
4906
5021
|
# @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
|
4907
|
-
# @param Agent:
|
5022
|
+
# @param Agent: 代理企业和员工的信息。
|
5023
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
4908
5024
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
4909
5025
|
|
4910
5026
|
attr_accessor :Operator, :SceneKey, :UserInfo, :Agent
|
@@ -4937,16 +5053,18 @@ module TencentCloud
|
|
4937
5053
|
class DescribeUserAutoSignStatusResponse < TencentCloud::Common::AbstractModel
|
4938
5054
|
# @param IsOpen: 查询用户是否已开通自动签
|
4939
5055
|
# @type IsOpen: Boolean
|
4940
|
-
# @param LicenseFrom:
|
5056
|
+
# @param LicenseFrom: 自动签许可生效时间。当且仅当已通过许可开通自动签时有值。
|
4941
5057
|
|
4942
5058
|
# 值为unix时间戳,单位为秒。
|
4943
5059
|
# @type LicenseFrom: Integer
|
4944
|
-
# @param LicenseTo:
|
5060
|
+
# @param LicenseTo: 自动签许可到期时间。当且仅当已通过许可开通自动签时有值。
|
5061
|
+
|
4945
5062
|
# 值为unix时间戳,单位为秒。
|
4946
5063
|
# @type LicenseTo: Integer
|
4947
|
-
# @param LicenseType:
|
4948
|
-
|
4949
|
-
# 1
|
5064
|
+
# @param LicenseType: 设置用户开通自动签时是否绑定个人自动签账号许可。
|
5065
|
+
|
5066
|
+
# <ul><li>**0**: 使用个人自动签账号许可进行开通,个人自动签账号许可有效期1年,注: `不可解绑释放更换他人`</li>
|
5067
|
+
# <li>**1**: 不使用个人自动签账号许可进行开通</li></ul>
|
4950
5068
|
# @type LicenseType: Integer
|
4951
5069
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
4952
5070
|
# @type RequestId: String
|
@@ -4972,14 +5090,16 @@ module TencentCloud
|
|
4972
5090
|
|
4973
5091
|
# DisableUserAutoSign请求参数结构体
|
4974
5092
|
class DisableUserAutoSignRequest < TencentCloud::Common::AbstractModel
|
4975
|
-
# @param Operator:
|
5093
|
+
# @param Operator: 执行本接口操作的员工信息。
|
5094
|
+
# 注: `在调用此接口时,请确保指定的员工已获得所需的接口调用权限,并具备接口传入的相应资源的数据权限。`
|
4976
5095
|
# @type Operator: :class:`Tencentcloud::Ess.v20201111.models.UserInfo`
|
4977
|
-
# @param SceneKey:
|
4978
|
-
# E_PRESCRIPTION_AUTO_SIGN
|
5096
|
+
# @param SceneKey: 自动签使用的场景值, 可以选择的场景值如下:
|
5097
|
+
# <ul><li> **E_PRESCRIPTION_AUTO_SIGN** 电子处方</li></ul>
|
4979
5098
|
# @type SceneKey: String
|
4980
|
-
# @param UserInfo:
|
5099
|
+
# @param UserInfo: 需要关闭自动签的个人的信息,如姓名,证件信息等。
|
4981
5100
|
# @type UserInfo: :class:`Tencentcloud::Ess.v20201111.models.UserThreeFactor`
|
4982
|
-
# @param Agent:
|
5101
|
+
# @param Agent: 代理企业和员工的信息。
|
5102
|
+
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
4983
5103
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
4984
5104
|
|
4985
5105
|
attr_accessor :Operator, :SceneKey, :UserInfo, :Agent
|
@@ -5451,10 +5571,14 @@ module TencentCloud
|
|
5451
5571
|
|
5452
5572
|
# 签署链接信息
|
5453
5573
|
class FlowApproverUrlInfo < TencentCloud::Common::AbstractModel
|
5454
|
-
# @param SignUrl:
|
5574
|
+
# @param SignUrl: 签署链接(短链形式呈现)。请注意保密,不要将其外泄给无关用户。
|
5575
|
+
# 注: `注意该链接有效期为30分钟`
|
5455
5576
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5456
5577
|
# @type SignUrl: String
|
5457
|
-
# @param ApproverType:
|
5578
|
+
# @param ApproverType: 签署参与人类型
|
5579
|
+
# <ul><li> **1** :个人参与方</li></ul>
|
5580
|
+
|
5581
|
+
# 注: `现在仅支持个人参与方`
|
5458
5582
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5459
5583
|
# @type ApproverType: Integer
|
5460
5584
|
# @param ApproverName: 签署人姓名
|
@@ -5463,7 +5587,8 @@ module TencentCloud
|
|
5463
5587
|
# @param ApproverMobile: 签署人手机号
|
5464
5588
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5465
5589
|
# @type ApproverMobile: String
|
5466
|
-
# @param LongUrl:
|
5590
|
+
# @param LongUrl: 签署链接(长链形式呈现)。请注意保密,不要将其外泄给无关用户。
|
5591
|
+
# 注: `注意该链接有效期为30分钟`
|
5467
5592
|
# 注意:此字段可能返回 null,表示取不到有效值。
|
5468
5593
|
# @type LongUrl: String
|
5469
5594
|
|
@@ -5554,46 +5679,54 @@ module TencentCloud
|
|
5554
5679
|
|
5555
5680
|
# 创建流程的签署方信息
|
5556
5681
|
class FlowCreateApprover < TencentCloud::Common::AbstractModel
|
5557
|
-
# @param ApproverType:
|
5682
|
+
# @param ApproverType: 在指定签署方时,可选择企业B端或个人C端等不同的参与者类型,可选类型如下:
|
5558
5683
|
# 0:企业
|
5559
5684
|
# 1:个人
|
5560
|
-
# 3
|
5561
|
-
# 注:类型为3
|
5562
|
-
# 自动签署仅进行盖章操作,不能是手写签名。
|
5563
|
-
# 本方企业自动签署的签署人会默认是当前的发起人
|
5564
|
-
# 他方企业自动签署的签署人是自动签模板的他方企业授权人
|
5685
|
+
# 3:企业静默签署
|
5686
|
+
# 注:类型为3(企业静默签署)时,此接口会默认完成该签署方的签署。静默签署仅进行盖章操作,不能自动签名。
|
5565
5687
|
# 7: 个人自动签署,适用于个人自动签场景。
|
5566
|
-
# 注:
|
5688
|
+
# 注: 个人自动签场景为白名单功能,使用前请联系对接的客户经理沟通。
|
5567
5689
|
# @type ApproverType: Integer
|
5568
|
-
# @param OrganizationName:
|
5569
|
-
#
|
5690
|
+
# @param OrganizationName: 组织机构名称。
|
5691
|
+
# 请确认该名称与企业营业执照中注册的名称一致。
|
5692
|
+
# 如果名称中包含英文括号(),请使用中文括号()代替。
|
5693
|
+
|
5694
|
+
# 注: `当approverType=0(企业签署方) 或 approverType=3(企业静默签署)时,必须指定`
|
5570
5695
|
|
5571
5696
|
# @type OrganizationName: String
|
5572
|
-
# @param ApproverName:
|
5573
|
-
#
|
5697
|
+
# @param ApproverName: 签署方经办人的姓名。
|
5698
|
+
# 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
5699
|
+
|
5700
|
+
# 在未指定签署人电子签UserId情况下,为必填参数
|
5574
5701
|
# @type ApproverName: String
|
5575
|
-
# @param ApproverMobile:
|
5576
|
-
#
|
5702
|
+
# @param ApproverMobile: 签署方经办人手机号码, 支持国内手机号11位数字(无需加+86前缀或其他字符)。
|
5703
|
+
# 请确认手机号所有方为此合同签署方。
|
5704
|
+
|
5705
|
+
# 在未指定签署人电子签UserId情况下,为必填参数
|
5577
5706
|
# @type ApproverMobile: String
|
5578
|
-
# @param ApproverIdCardType:
|
5579
|
-
# ID_CARD
|
5580
|
-
# HONGKONG_AND_MACAO
|
5581
|
-
# HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
5582
|
-
# OTHER_CARD_TYPE 其他(需要使用该类型请先联系运营经理)
|
5707
|
+
# @param ApproverIdCardType: 证件类型,支持以下类型
|
5708
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
5709
|
+
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
5710
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
5583
5711
|
# @type ApproverIdCardType: String
|
5584
|
-
# @param ApproverIdCardNumber:
|
5712
|
+
# @param ApproverIdCardNumber: 证件号码,应符合以下规则
|
5713
|
+
# <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
5714
|
+
# <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
5715
|
+
# <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
5585
5716
|
# @type ApproverIdCardNumber: String
|
5586
5717
|
# @param RecipientId: 签署方经办人在模板中的参与方ID
|
5587
5718
|
# <br/>模板发起合同时,该参数为必填项
|
5588
5719
|
# <br/>文件发起合同是,该参数无序传值
|
5589
5720
|
# @type RecipientId: String
|
5590
|
-
# @param VerifyChannel:
|
5721
|
+
# @param VerifyChannel: 签署意愿确认渠道,默认为WEIXINAPP:人脸识别
|
5722
|
+
|
5723
|
+
# 注: 将要废弃, 用ApproverSignTypes签署人签署合同时的认证方式代替, 新客户可请用ApproverSignTypes来设置
|
5591
5724
|
# @type VerifyChannel: Array
|
5592
|
-
# @param NotifyType:
|
5593
|
-
# <
|
5594
|
-
# <
|
5595
|
-
|
5596
|
-
#
|
5725
|
+
# @param NotifyType: 通知签署方经办人的方式, 有以下途径:
|
5726
|
+
# <ul><li> **sms** : (默认)短信</li>
|
5727
|
+
# <li> **none** : 不通知</li></ul>
|
5728
|
+
|
5729
|
+
# 注: `发起方也是签署方时不给此签署方发送短信`
|
5597
5730
|
# @type NotifyType: String
|
5598
5731
|
# @param IsFullText: 合同强制需要阅读全文,无需传此参数
|
5599
5732
|
# @type IsFullText: Boolean
|
@@ -5601,22 +5734,20 @@ module TencentCloud
|
|
5601
5734
|
# @type PreReadTime: Integer
|
5602
5735
|
# @param UserId: 签署人userId,仅支持本企业的员工userid, 可在控制台组织管理处获得
|
5603
5736
|
|
5604
|
-
#
|
5737
|
+
# 注: `若传此字段 则以userid的信息为主,会覆盖传递过来的签署人基本信息, 包括姓名,手机号,证件类型等信息`
|
5605
5738
|
# @type UserId: String
|
5606
|
-
# @param Required:
|
5739
|
+
# @param Required: 字段已经废弃,当前只支持true,默认为true
|
5607
5740
|
# @type Required: Boolean
|
5608
|
-
# @param ApproverSource:
|
5609
|
-
|
5610
|
-
# 企微侧用户请传入:WEWORKAPP
|
5741
|
+
# @param ApproverSource: 在企微场景下使用,需设置参数为**WEWORKAPP**,以表明合同来源于企微。
|
5611
5742
|
# @type ApproverSource: String
|
5612
|
-
# @param CustomApproverTag:
|
5613
|
-
#
|
5614
|
-
#
|
5615
|
-
#
|
5743
|
+
# @param CustomApproverTag: 在企业微信场景下,表明该合同流程为或签,其最大长度为64位字符串。
|
5744
|
+
# 所有参与或签的人员均需具备该标识。
|
5745
|
+
# 注意,在合同中,不同的或签参与人必须保证其CustomApproverTag唯一。
|
5746
|
+
# 如果或签签署人为本方企业微信参与人,则需要指定ApproverSource参数为WEWORKAPP。
|
5616
5747
|
# @type CustomApproverTag: String
|
5617
|
-
# @param RegisterInfo:
|
5748
|
+
# @param RegisterInfo: 已经废弃, 快速注册相关信息
|
5618
5749
|
# @type RegisterInfo: :class:`Tencentcloud::Ess.v20201111.models.RegisterInfo`
|
5619
|
-
# @param ApproverOption:
|
5750
|
+
# @param ApproverOption: 签署人个性化能力值,如是否可以转发他人处理、是否可以拒签等功能开关。
|
5620
5751
|
# @type ApproverOption: :class:`Tencentcloud::Ess.v20201111.models.ApproverOption`
|
5621
5752
|
# @param JumpUrl: 签署完前端跳转的url,暂未使用
|
5622
5753
|
# @type JumpUrl: String
|
@@ -5624,16 +5755,35 @@ module TencentCloud
|
|
5624
5755
|
# - 发起流程时系统自动补充
|
5625
5756
|
# - 创建签署链接时,可以通过查询详情接口获得签署人的SignId,然后可传入此值为该签署人创建签署链接,无需再传姓名、手机号、证件号等其他信息
|
5626
5757
|
# @type SignId: String
|
5627
|
-
# @param ApproverNeedSignReview:
|
5628
|
-
# <
|
5629
|
-
# <
|
5630
|
-
#
|
5758
|
+
# @param ApproverNeedSignReview: 发起方企业的签署人进行签署操作前,是否需要企业内部走审批流程,取值如下:
|
5759
|
+
# <ul><li>**false**:(默认)不需要审批,直接签署。</li>
|
5760
|
+
# <li>**true**:需要走审批流程。当到对应参与人签署时,会阻塞其签署操作,等待企业内部审批完成。</li></ul>
|
5761
|
+
# 企业可以通过CreateFlowSignReview审批接口通知腾讯电子签平台企业内部审批结果
|
5762
|
+
# <ul><li>如果企业通知腾讯电子签平台审核通过,签署方可继续签署动作。</li>
|
5763
|
+
# <li>如果企业通知腾讯电子签平台审核未通过,平台将继续阻塞签署方的签署动作,直到企业通知平台审核通过。</li></ul>
|
5764
|
+
|
5765
|
+
# 注:`此功能可用于与企业内部的审批流程进行关联,支持手动、静默签署合同`
|
5631
5766
|
# @type ApproverNeedSignReview: Boolean
|
5632
5767
|
# @param SignComponents: 签署人签署控件, 此参数仅针对文件发起(CreateFlowByFiles)生效
|
5633
|
-
|
5768
|
+
|
5769
|
+
# 合同中的签署控件列表,列表中可支持下列多种签署控件,控件的详细定义参考开发者中心的Component结构体
|
5770
|
+
# <ul><li> 个人签名/印章</li>
|
5771
|
+
# <li> 企业印章</li>
|
5772
|
+
# <li> 骑缝章等签署控件</li></ul>
|
5773
|
+
|
5774
|
+
# `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
5634
5775
|
# @type SignComponents: Array
|
5635
5776
|
# @param Components: 签署人填写控件 此参数仅针对文件发起(CreateFlowByFiles)生效
|
5636
|
-
|
5777
|
+
|
5778
|
+
# 合同中的填写控件列表,列表中可支持下列多种填写控件,控件的详细定义参考开发者中心的Component结构体
|
5779
|
+
# <ul><li>单行文本控件</li>
|
5780
|
+
# <li>多行文本控件</li>
|
5781
|
+
# <li>勾选框控件</li>
|
5782
|
+
# <li>数字控件</li>
|
5783
|
+
# <li>图片控件</li>
|
5784
|
+
# <li>动态表格等填写控件</li></ul>
|
5785
|
+
|
5786
|
+
# `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
5637
5787
|
# @type Components: Array
|
5638
5788
|
# @param ComponentLimitType: 签署方控件类型为 SIGN_SIGNATURE时,可以指定签署方签名方式
|
5639
5789
|
# HANDWRITE – 手写签名
|
@@ -5641,13 +5791,28 @@ module TencentCloud
|
|
5641
5791
|
# ESIGN -- 个人印章类型
|
5642
5792
|
# SYSTEM_ESIGN -- 系统签名(该类型可以在用户签署时根据用户姓名一键生成一个签名来进行签署)
|
5643
5793
|
# @type ComponentLimitType: Array
|
5644
|
-
# @param ApproverVerifyTypes:
|
5794
|
+
# @param ApproverVerifyTypes: 指定个人签署方查看合同的校验方式,可以传值如下:
|
5795
|
+
# <ul><li> **1** : (默认)人脸识别,人脸识别后才能合同内容</li>
|
5796
|
+
# <li> **2** : 手机号验证, 用户手机号和参与方手机号(ApproverMobile)相同即可查看合同内容(当手写签名方式为OCR_ESIGN时,该校验方式无效,因为这种签名方式依赖实名认证)
|
5797
|
+
# </li></ul>
|
5798
|
+
# 注:
|
5799
|
+
# <ul><li>如果合同流程设置ApproverVerifyType查看合同的校验方式, 则忽略此签署人的查看合同的校验方式</li>
|
5800
|
+
# <li>此字段不可传多个校验方式</li></ul>
|
5645
5801
|
|
5646
|
-
#
|
5802
|
+
# `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
5803
|
+
|
5804
|
+
# .
|
5647
5805
|
# @type ApproverVerifyTypes: Array
|
5648
|
-
# @param ApproverSignTypes:
|
5806
|
+
# @param ApproverSignTypes: 您可以指定签署方签署合同的认证校验方式,可传递以下值:
|
5807
|
+
# <ul><li>**1**:人脸认证,需进行人脸识别成功后才能签署合同;</li>
|
5808
|
+
# <li>**2**:签署密码,需输入与用户在腾讯电子签设置的密码一致才能校验成功进行合同签署;</li>
|
5809
|
+
# <li>**3**:运营商三要素,需到运营商处比对手机号实名信息(名字、手机号、证件号)校验一致才能成功进行合同签署。</li></ul>
|
5810
|
+
# 注:
|
5811
|
+
# <ul><li>默认情况下,认证校验方式为人脸认证和签署密码两种形式;</li>
|
5812
|
+
# <li>您可以传递多种值,表示可用多种认证校验方式。</li></ul>
|
5649
5813
|
|
5650
|
-
#
|
5814
|
+
# 注:
|
5815
|
+
# `此参数仅针对文件发起设置生效,模板发起合同签署流程, 请以模板配置为主`
|
5651
5816
|
# @type ApproverSignTypes: Array
|
5652
5817
|
|
5653
5818
|
attr_accessor :ApproverType, :OrganizationName, :ApproverName, :ApproverMobile, :ApproverIdCardType, :ApproverIdCardNumber, :RecipientId, :VerifyChannel, :NotifyType, :IsFullText, :PreReadTime, :UserId, :Required, :ApproverSource, :CustomApproverTag, :RegisterInfo, :ApproverOption, :JumpUrl, :SignId, :ApproverNeedSignReview, :SignComponents, :Components, :ComponentLimitType, :ApproverVerifyTypes, :ApproverSignTypes
|
@@ -7046,26 +7211,26 @@ module TencentCloud
|
|
7046
7211
|
end
|
7047
7212
|
end
|
7048
7213
|
|
7049
|
-
#
|
7050
|
-
#
|
7051
|
-
#
|
7052
|
-
#
|
7214
|
+
# 解除协议的签署人,如不指定,默认使用原流程中的签署人。<br/>
|
7215
|
+
# `注意:不支持更换C端(个人身份类型)签署人,如果原流程中含有C端签署人,默认使用原流程中的该C端签署人。`<br/>
|
7216
|
+
# `注意:目前不支持替换C端(个人身份类型)签署人,但是可以指定C端签署人的签署方自定义控件别名,具体见参数ApproverSignRole描述。`<br/>
|
7217
|
+
# `注意:当指定C端签署人的签署方自定义控件别名不空时,除RelievedApproverReceiptId参数外,可以只参数ApproverSignRole。`<br/>
|
7053
7218
|
class ReleasedApprover < TencentCloud::Common::AbstractModel
|
7054
|
-
# @param Name: 签署人姓名,最大长度50
|
7219
|
+
# @param Name: 签署人姓名,最大长度50个字。
|
7055
7220
|
# @type Name: String
|
7056
|
-
# @param Mobile:
|
7221
|
+
# @param Mobile: 签署人手机号。
|
7057
7222
|
# @type Mobile: String
|
7058
|
-
# @param RelievedApproverReceiptId:
|
7223
|
+
# @param RelievedApproverReceiptId: 要更换的原合同参与人RecipientId编号。(可通过接口<a href="https://qian.tencent.com/developers/companyApis/queryFlows/DescribeFlowInfo/">DescribeFlowInfo</a>查询签署人的RecipientId编号)<br/>
|
7059
7224
|
# @type RelievedApproverReceiptId: String
|
7060
7225
|
# @param ApproverType: 指定签署人类型,目前仅支持
|
7061
|
-
# ORGANIZATION
|
7062
|
-
# ENTERPRISESERVER
|
7226
|
+
# <ul><li> **ORGANIZATION**:企业(默认值)</li>
|
7227
|
+
# <li> **ENTERPRISESERVER**:企业静默签</li></ul>
|
7063
7228
|
# @type ApproverType: String
|
7064
|
-
# @param ApproverSignComponentType:
|
7065
|
-
#
|
7066
|
-
#
|
7229
|
+
# @param ApproverSignComponentType: 签署控件类型,支持自定义企业签署方的签署控件类型
|
7230
|
+
# <ul><li> **SIGN_SEAL**:默认为印章控件类型(默认值)</li>
|
7231
|
+
# <li> **SIGN_SIGNATURE**:手写签名控件类型</li></ul>
|
7067
7232
|
# @type ApproverSignComponentType: String
|
7068
|
-
# @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的;
|
7233
|
+
# @param ApproverSignRole: 参与方在合同中的角色是按照创建合同的时候来排序的; 解除协议默认会将第一个参与人叫甲方, 第二个叫乙方,第三个叫丙方,以此类推。如果您需要改动参与人的角色名字, 可以设置此签署方自定义控件别名字段,最大20个字。
|
7069
7234
|
# @type ApproverSignRole: String
|
7070
7235
|
|
7071
7236
|
attr_accessor :Name, :Mobile, :RelievedApproverReceiptId, :ApproverType, :ApproverSignComponentType, :ApproverSignRole
|
@@ -7379,8 +7544,8 @@ module TencentCloud
|
|
7379
7544
|
# 在集团企业代理子企业操作的场景中,需设置此参数。在此情境下,ProxyOrganizationId(子企业的组织ID)为必填项。
|
7380
7545
|
# @type Agent: :class:`Tencentcloud::Ess.v20201111.models.Agent`
|
7381
7546
|
# @param CcNotifyType: 若在创建签署流程时指定了关注人CcInfos,此参数可设定向关注人发送短信通知的类型:
|
7382
|
-
# 0
|
7383
|
-
# 1
|
7547
|
+
# <ul><li> **0** :合同发起时通知通知对方来查看合同(默认)</li>
|
7548
|
+
# <li> **1** : 签署完成后通知对方来查看合同</li></ul>
|
7384
7549
|
# @type CcNotifyType: Integer
|
7385
7550
|
|
7386
7551
|
attr_accessor :Operator, :FlowId, :ClientToken, :Agent, :CcNotifyType
|
@@ -7414,9 +7579,9 @@ module TencentCloud
|
|
7414
7579
|
# StartFlow返回参数结构体
|
7415
7580
|
class StartFlowResponse < TencentCloud::Common::AbstractModel
|
7416
7581
|
# @param Status: 发起成功后返回的状态,根据合同流程的不同,返回不同状态:
|
7417
|
-
# START
|
7418
|
-
# REVIEW
|
7419
|
-
# EXECUTING
|
7582
|
+
# <ul><li> **START** : 发起成功, 合同进入签署环节</li>
|
7583
|
+
# <li> **REVIEW** : 提交审核成功, 合同需要发起审核, 发起方企业通过接口审核通过后合同才进入签署环境 `白名单功能,使用前请联系对接的客户经理沟通。`</li>
|
7584
|
+
# <li> **EXECUTING** : 已提交发起任务且PDF合同正在合成中, 等PDF合同合成成功后进入签署环节</li></ul>
|
7420
7585
|
# @type Status: String
|
7421
7586
|
# @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
|
7422
7587
|
# @type RequestId: String
|
@@ -7965,14 +8130,18 @@ module TencentCloud
|
|
7965
8130
|
|
7966
8131
|
# 用户的三要素:姓名,证件号,证件类型
|
7967
8132
|
class UserThreeFactor < TencentCloud::Common::AbstractModel
|
7968
|
-
# @param Name:
|
8133
|
+
# @param Name: 签署方经办人的姓名。
|
8134
|
+
# 经办人的姓名将用于身份认证和电子签名,请确保填写的姓名为签署方的真实姓名,而非昵称等代名。
|
7969
8135
|
# @type Name: String
|
7970
|
-
# @param IdCardType:
|
7971
|
-
# ID_CARD
|
7972
|
-
# HONGKONG_AND_MACAO
|
7973
|
-
# HONGKONG_MACAO_AND_TAIWAN 港澳台居民居住证(格式同居民身份证)
|
8136
|
+
# @param IdCardType: 证件类型,支持以下类型
|
8137
|
+
# <ul><li>ID_CARD : 居民身份证 (默认值)</li>
|
8138
|
+
# <li>HONGKONG_AND_MACAO : 港澳居民来往内地通行证</li>
|
8139
|
+
# <li>HONGKONG_MACAO_AND_TAIWAN : 港澳台居民居住证(格式同居民身份证)</li></ul>
|
7974
8140
|
# @type IdCardType: String
|
7975
|
-
# @param IdCardNumber:
|
8141
|
+
# @param IdCardNumber: 证件号码,应符合以下规则
|
8142
|
+
# <ul><li>居民身份证号码应为18位字符串,由数字和大写字母X组成(如存在X,请大写)。</li>
|
8143
|
+
# <li>港澳居民来往内地通行证号码应为9位字符串,第1位为“C”,第2位为英文字母(但“I”、“O”除外),后7位为阿拉伯数字。</li>
|
8144
|
+
# <li>港澳台居民居住证号码编码规则与中国大陆身份证相同,应为18位字符串。</li></ul>
|
7976
8145
|
# @type IdCardNumber: String
|
7977
8146
|
|
7978
8147
|
attr_accessor :Name, :IdCardType, :IdCardNumber
|