tencentcloud-sdk-essbasic 3.0.775 → 3.0.777

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 CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA1:
3
- metadata.gz: 8e0840ef39828521bd3e08a93b909a31d8ad9f37
4
- data.tar.gz: 56b99adc51bbf88e1cc98f38a1ea67c2e47fab0d
3
+ metadata.gz: 5eeada1c75347362efb0f4aff71484eaa9ad0ca0
4
+ data.tar.gz: f0cf1db78819d05465165b856c215801038b8ee9
5
5
  SHA512:
6
- metadata.gz: dc45e4d73d4835278bbfa84977e60cad45e1d747c4aef16cd98ea7936151eaeb29061e309302fb8340cbfcac3e17dc23c766fa2a1486870d1958529386dff233
7
- data.tar.gz: 46582854698281dab56652e1c5f075f188e6c38ec4b467b8874808acebc9437910a8bc307707e72e55cced399cfa560b2c75c460401e8f411f3784936127d221
6
+ metadata.gz: 3496b3cacbc777c64d8e17872c78c25c77a1ce519e8a2adcc0bd33964ceafdfd34feda5eee5b3023b6ae28bf10c521f294263c316ed997d5ba024e3dd4d40cb1
7
+ data.tar.gz: a2db101f6e7e9583cbc5ffa3c274d06ebf5534f4a5ea9bf89337cc684f1736780f68a4a5a53f153b6a7d46396549101297a3d47f2a85958726e5e5877625eb9c
data/lib/VERSION CHANGED
@@ -1 +1 @@
1
- 3.0.775
1
+ 3.0.777
@@ -1340,6 +1340,36 @@ module TencentCloud
1340
1340
  raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1341
1341
  end
1342
1342
 
1343
+ # 该接口用于在使用视频认证方式签署合同后,获取用户的签署人脸认证视频。
1344
+
1345
+ # 1. 该接口**仅适用于在H5端签署**的合同,**在通过视频认证后**获取人脸图片。
1346
+ # 2. 该接口**不支持小程序端**的签署人脸图片获取。
1347
+ # 3. 请在**签署完成后的三天内**获取人脸图片,**过期后将无法获取**。
1348
+
1349
+ # **注意:该接口需要开通白名单,请联系客户经理开通后使用。**
1350
+
1351
+ # @param request: Request instance for ChannelDescribeSignFaceVideo.
1352
+ # @type request: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeSignFaceVideoRequest`
1353
+ # @rtype: :class:`Tencentcloud::essbasic::V20210526::ChannelDescribeSignFaceVideoResponse`
1354
+ def ChannelDescribeSignFaceVideo(request)
1355
+ body = send_request('ChannelDescribeSignFaceVideo', request.serialize)
1356
+ response = JSON.parse(body)
1357
+ if response['Response'].key?('Error') == false
1358
+ model = ChannelDescribeSignFaceVideoResponse.new
1359
+ model.deserialize(response['Response'])
1360
+ model
1361
+ else
1362
+ code = response['Response']['Error']['Code']
1363
+ message = response['Response']['Error']['Message']
1364
+ reqid = response['Response']['RequestId']
1365
+ raise TencentCloud::Common::TencentCloudSDKException.new(code, message, reqid)
1366
+ end
1367
+ rescue TencentCloud::Common::TencentCloudSDKException => e
1368
+ raise e
1369
+ rescue StandardError => e
1370
+ raise TencentCloud::Common::TencentCloudSDKException.new(nil, e.inspect)
1371
+ end
1372
+
1343
1373
  # 通过此接口获取个人用户自动签的开通状态。
1344
1374
 
1345
1375
  # 注意: `处方单等特殊场景专用,此接口为白名单功能,使用前请联系对接的客户经理沟通。`
@@ -3767,6 +3767,83 @@ module TencentCloud
3767
3767
  end
3768
3768
  end
3769
3769
 
3770
+ # ChannelDescribeSignFaceVideo请求参数结构体
3771
+ class ChannelDescribeSignFaceVideoRequest < TencentCloud::Common::AbstractModel
3772
+ # @param FlowId: 合同流程ID,为32位字符串。
3773
+ # 建议开发者妥善保存此流程ID,以便于顺利进行后续操作。
3774
+ # 可登录腾讯电子签控制台,在 "合同"->"合同中心" 中查看某个合同的FlowId(在页面中展示为合同ID)。
3775
+ # @type FlowId: String
3776
+ # @param SignId: 签署参与人在本流程中的编号ID(每个流程不同),可用此ID来定位签署参与人在本流程的签署节点,也可用于后续创建签署链接等操作。
3777
+ # @type SignId: String
3778
+ # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
3779
+
3780
+ # 此接口下面信息必填。
3781
+ # <ul>
3782
+ # <li>渠道应用标识: Agent.AppId</li>
3783
+ # <li>第三方平台子客企业标识: Agent.ProxyOrganizationOpenId</li>
3784
+ # <li>第三方平台子客企业中的员工标识: Agent. ProxyOperator.OpenId</li>
3785
+ # </ul>
3786
+ # 第三方平台子客企业和员工必须已经经过实名认证
3787
+ # @type Agent: :class:`Tencentcloud::Essbasic.v20210526.models.Agent`
3788
+
3789
+ attr_accessor :FlowId, :SignId, :Agent
3790
+
3791
+ def initialize(flowid=nil, signid=nil, agent=nil)
3792
+ @FlowId = flowid
3793
+ @SignId = signid
3794
+ @Agent = agent
3795
+ end
3796
+
3797
+ def deserialize(params)
3798
+ @FlowId = params['FlowId']
3799
+ @SignId = params['SignId']
3800
+ unless params['Agent'].nil?
3801
+ @Agent = Agent.new
3802
+ @Agent.deserialize(params['Agent'])
3803
+ end
3804
+ end
3805
+ end
3806
+
3807
+ # ChannelDescribeSignFaceVideo返回参数结构体
3808
+ class ChannelDescribeSignFaceVideoResponse < TencentCloud::Common::AbstractModel
3809
+ # @param VideoData: 核身视频结果。
3810
+ # 注意:此字段可能返回 null,表示取不到有效值。
3811
+ # @type VideoData: :class:`Tencentcloud::Essbasic.v20210526.models.DetectInfoVideoData`
3812
+ # @param IntentionQuestionResult: 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
3813
+ # 注意:此字段可能返回 null,表示取不到有效值。
3814
+ # @type IntentionQuestionResult: :class:`Tencentcloud::Essbasic.v20210526.models.IntentionQuestionResult`
3815
+ # @param IntentionActionResult: 意愿核身点头确认模式的结果信息,若未使用该意愿核身功能,该字段返回值可以不处理。
3816
+ # 注意:此字段可能返回 null,表示取不到有效值。
3817
+ # @type IntentionActionResult: :class:`Tencentcloud::Essbasic.v20210526.models.IntentionActionResult`
3818
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
3819
+ # @type RequestId: String
3820
+
3821
+ attr_accessor :VideoData, :IntentionQuestionResult, :IntentionActionResult, :RequestId
3822
+
3823
+ def initialize(videodata=nil, intentionquestionresult=nil, intentionactionresult=nil, requestid=nil)
3824
+ @VideoData = videodata
3825
+ @IntentionQuestionResult = intentionquestionresult
3826
+ @IntentionActionResult = intentionactionresult
3827
+ @RequestId = requestid
3828
+ end
3829
+
3830
+ def deserialize(params)
3831
+ unless params['VideoData'].nil?
3832
+ @VideoData = DetectInfoVideoData.new
3833
+ @VideoData.deserialize(params['VideoData'])
3834
+ end
3835
+ unless params['IntentionQuestionResult'].nil?
3836
+ @IntentionQuestionResult = IntentionQuestionResult.new
3837
+ @IntentionQuestionResult.deserialize(params['IntentionQuestionResult'])
3838
+ end
3839
+ unless params['IntentionActionResult'].nil?
3840
+ @IntentionActionResult = IntentionActionResult.new
3841
+ @IntentionActionResult.deserialize(params['IntentionActionResult'])
3842
+ end
3843
+ @RequestId = params['RequestId']
3844
+ end
3845
+ end
3846
+
3770
3847
  # ChannelDescribeUserAutoSignStatus请求参数结构体
3771
3848
  class ChannelDescribeUserAutoSignStatusRequest < TencentCloud::Common::AbstractModel
3772
3849
  # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
@@ -6630,6 +6707,25 @@ module TencentCloud
6630
6707
  end
6631
6708
  end
6632
6709
 
6710
+ # 视频认证结果
6711
+ class DetectInfoVideoData < TencentCloud::Common::AbstractModel
6712
+ # @param LiveNessVideo: 活体视频的base64编码,mp4格式
6713
+
6714
+ # 注:`需进行base64解码获取活体视频文件`
6715
+ # 注意:此字段可能返回 null,表示取不到有效值。
6716
+ # @type LiveNessVideo: String
6717
+
6718
+ attr_accessor :LiveNessVideo
6719
+
6720
+ def initialize(livenessvideo=nil)
6721
+ @LiveNessVideo = livenessvideo
6722
+ end
6723
+
6724
+ def deserialize(params)
6725
+ @LiveNessVideo = params['LiveNessVideo']
6726
+ end
6727
+ end
6728
+
6633
6729
  # 签署流程下载信息
6634
6730
  class DownloadFlowInfo < TencentCloud::Common::AbstractModel
6635
6731
  # @param FileName: 文件夹名称
@@ -7122,13 +7218,19 @@ module TencentCloud
7122
7218
 
7123
7219
  # 注:`此参数仅在通过文件发起合同或者合同组时生效`
7124
7220
  # @type Components: Array
7221
+ # @param Intention: 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
7222
+
7223
+ # 注:
7224
+ # `1.视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
7225
+ # `2.使用视频认证必须指定签署认证方式为人脸(即ApproverSignTypes)。`
7226
+ # @type Intention: :class:`Tencentcloud::Essbasic.v20210526.models.Intention`
7125
7227
 
7126
- attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes, :SignId, :NotifyType, :AddSignComponentsLimits, :ApproverRoleName, :SignTypeSelector, :Components
7228
+ attr_accessor :Name, :IdCardType, :IdCardNumber, :Mobile, :OrganizationName, :NotChannelOrganization, :OpenId, :OrganizationOpenId, :ApproverType, :RecipientId, :Deadline, :CallbackUrl, :SignComponents, :ComponentLimitType, :PreReadTime, :JumpUrl, :ApproverOption, :ApproverNeedSignReview, :ApproverVerifyTypes, :ApproverSignTypes, :SignId, :NotifyType, :AddSignComponentsLimits, :ApproverRoleName, :SignTypeSelector, :Components, :Intention
7127
7229
  extend Gem::Deprecate
7128
7230
  deprecate :CallbackUrl, :none, 2024, 3
7129
7231
  deprecate :CallbackUrl=, :none, 2024, 3
7130
7232
 
7131
- def initialize(name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, notchannelorganization=nil, openid=nil, organizationopenid=nil, approvertype=nil, recipientid=nil, deadline=nil, callbackurl=nil, signcomponents=nil, componentlimittype=nil, prereadtime=nil, jumpurl=nil, approveroption=nil, approverneedsignreview=nil, approververifytypes=nil, approversigntypes=nil, signid=nil, notifytype=nil, addsigncomponentslimits=nil, approverrolename=nil, signtypeselector=nil, components=nil)
7233
+ def initialize(name=nil, idcardtype=nil, idcardnumber=nil, mobile=nil, organizationname=nil, notchannelorganization=nil, openid=nil, organizationopenid=nil, approvertype=nil, recipientid=nil, deadline=nil, callbackurl=nil, signcomponents=nil, componentlimittype=nil, prereadtime=nil, jumpurl=nil, approveroption=nil, approverneedsignreview=nil, approververifytypes=nil, approversigntypes=nil, signid=nil, notifytype=nil, addsigncomponentslimits=nil, approverrolename=nil, signtypeselector=nil, components=nil, intention=nil)
7132
7234
  @Name = name
7133
7235
  @IdCardType = idcardtype
7134
7236
  @IdCardNumber = idcardnumber
@@ -7155,6 +7257,7 @@ module TencentCloud
7155
7257
  @ApproverRoleName = approverrolename
7156
7258
  @SignTypeSelector = signtypeselector
7157
7259
  @Components = components
7260
+ @Intention = intention
7158
7261
  end
7159
7262
 
7160
7263
  def deserialize(params)
@@ -7208,6 +7311,10 @@ module TencentCloud
7208
7311
  @Components << component_tmp
7209
7312
  end
7210
7313
  end
7314
+ unless params['Intention'].nil?
7315
+ @Intention = Intention.new
7316
+ @Intention.deserialize(params['Intention'])
7317
+ end
7211
7318
  end
7212
7319
  end
7213
7320
 
@@ -8030,6 +8137,156 @@ module TencentCloud
8030
8137
  end
8031
8138
  end
8032
8139
 
8140
+ # 视频核身意图配置,可指定问答模式或者点头模式的语音文本。
8141
+
8142
+ # 注: `视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
8143
+ class Intention < TencentCloud::Common::AbstractModel
8144
+ # @param IntentionType: 视频认证类型,支持以下类型
8145
+ # <ul><li>1 : 问答模式</li>
8146
+ # <li>2 : 点头模式</li></ul>
8147
+
8148
+ # 注: `视频认证为白名单功能,使用前请联系对接的客户经理沟通。`
8149
+ # @type IntentionType: Integer
8150
+ # @param IntentionQuestions: 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
8151
+ # @type IntentionQuestions: Array
8152
+ # @param IntentionActions: 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
8153
+ # @type IntentionActions: Array
8154
+
8155
+ attr_accessor :IntentionType, :IntentionQuestions, :IntentionActions
8156
+
8157
+ def initialize(intentiontype=nil, intentionquestions=nil, intentionactions=nil)
8158
+ @IntentionType = intentiontype
8159
+ @IntentionQuestions = intentionquestions
8160
+ @IntentionActions = intentionactions
8161
+ end
8162
+
8163
+ def deserialize(params)
8164
+ @IntentionType = params['IntentionType']
8165
+ unless params['IntentionQuestions'].nil?
8166
+ @IntentionQuestions = []
8167
+ params['IntentionQuestions'].each do |i|
8168
+ intentionquestion_tmp = IntentionQuestion.new
8169
+ intentionquestion_tmp.deserialize(i)
8170
+ @IntentionQuestions << intentionquestion_tmp
8171
+ end
8172
+ end
8173
+ unless params['IntentionActions'].nil?
8174
+ @IntentionActions = []
8175
+ params['IntentionActions'].each do |i|
8176
+ intentionaction_tmp = IntentionAction.new
8177
+ intentionaction_tmp.deserialize(i)
8178
+ @IntentionActions << intentionaction_tmp
8179
+ end
8180
+ end
8181
+ end
8182
+ end
8183
+
8184
+ # 意愿核身(点头确认模式)使用的文案,若未使用意愿核身(点头确认模式),则该字段无需传入。当前仅支持一个提示文本。
8185
+ class IntentionAction < TencentCloud::Common::AbstractModel
8186
+ # @param Text: 点头确认模式下,系统语音播报使用的问题文本,问题最大长度为150个字符。
8187
+ # @type Text: String
8188
+
8189
+ attr_accessor :Text
8190
+
8191
+ def initialize(text=nil)
8192
+ @Text = text
8193
+ end
8194
+
8195
+ def deserialize(params)
8196
+ @Text = params['Text']
8197
+ end
8198
+ end
8199
+
8200
+ # 意愿核身点头确认模式结果
8201
+ class IntentionActionResult < TencentCloud::Common::AbstractModel
8202
+ # @param Details: 意愿核身结果详细数据,与每段点头确认过程一一对应
8203
+ # 注意:此字段可能返回 null,表示取不到有效值。
8204
+ # @type Details: Array
8205
+
8206
+ attr_accessor :Details
8207
+
8208
+ def initialize(details=nil)
8209
+ @Details = details
8210
+ end
8211
+
8212
+ def deserialize(params)
8213
+ unless params['Details'].nil?
8214
+ @Details = []
8215
+ params['Details'].each do |i|
8216
+ intentionactionresultdetail_tmp = IntentionActionResultDetail.new
8217
+ intentionactionresultdetail_tmp.deserialize(i)
8218
+ @Details << intentionactionresultdetail_tmp
8219
+ end
8220
+ end
8221
+ end
8222
+ end
8223
+
8224
+ # 意愿核身点头确认模式结果详细数据
8225
+ class IntentionActionResultDetail < TencentCloud::Common::AbstractModel
8226
+ # @param Video: 视频base64编码(其中包含全程提示文本和点头音频,mp4格式)
8227
+ # 注意:此字段可能返回 null,表示取不到有效值。
8228
+ # @type Video: String
8229
+
8230
+ attr_accessor :Video
8231
+
8232
+ def initialize(video=nil)
8233
+ @Video = video
8234
+ end
8235
+
8236
+ def deserialize(params)
8237
+ @Video = params['Video']
8238
+ end
8239
+ end
8240
+
8241
+ # 意愿核身语音问答模式(即语音播报+语音回答)使用的文案,包括:系统语音播报的文本、需要核验的标准文本。当前仅支持1轮问答。
8242
+ class IntentionQuestion < TencentCloud::Common::AbstractModel
8243
+ # @param Question: 当选择语音问答模式时,系统自动播报的问题文本,最大长度为150个字符。
8244
+ # @type Question: String
8245
+ # @param Answers: 当选择语音问答模式时,用于判断用户回答是否通过的标准答案列表,传入后可自动判断用户回答文本是否在标准文本列表中。
8246
+ # @type Answers: Array
8247
+
8248
+ attr_accessor :Question, :Answers
8249
+
8250
+ def initialize(question=nil, answers=nil)
8251
+ @Question = question
8252
+ @Answers = answers
8253
+ end
8254
+
8255
+ def deserialize(params)
8256
+ @Question = params['Question']
8257
+ @Answers = params['Answers']
8258
+ end
8259
+ end
8260
+
8261
+ # 意愿核身问答模式结果。若未使用该意愿核身功能,该字段返回值可以不处理。
8262
+ class IntentionQuestionResult < TencentCloud::Common::AbstractModel
8263
+ # @param Video: 视频base64(其中包含全程问题和回答音频,mp4格式)
8264
+
8265
+ # 注:`需进行base64解码获取视频文件`
8266
+ # 注意:此字段可能返回 null,表示取不到有效值。
8267
+ # @type Video: String
8268
+ # @param ResultCode: 和答案匹配结果列表
8269
+ # 注意:此字段可能返回 null,表示取不到有效值。
8270
+ # @type ResultCode: Array
8271
+ # @param AsrResult: 回答问题语音识别结果列表
8272
+ # 注意:此字段可能返回 null,表示取不到有效值。
8273
+ # @type AsrResult: Array
8274
+
8275
+ attr_accessor :Video, :ResultCode, :AsrResult
8276
+
8277
+ def initialize(video=nil, resultcode=nil, asrresult=nil)
8278
+ @Video = video
8279
+ @ResultCode = resultcode
8280
+ @AsrResult = asrresult
8281
+ end
8282
+
8283
+ def deserialize(params)
8284
+ @Video = params['Video']
8285
+ @ResultCode = params['ResultCode']
8286
+ @AsrResult = params['AsrResult']
8287
+ end
8288
+ end
8289
+
8033
8290
  # ModifyExtendedService请求参数结构体
8034
8291
  class ModifyExtendedServiceRequest < TencentCloud::Common::AbstractModel
8035
8292
  # @param Agent: 关于渠道应用的相关信息,包括渠道应用标识、第三方平台子客企业标识及第三方平台子客企业中的员工标识等内容,您可以参阅开发者中心所提供的 Agent 结构体以获取详细定义。
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: tencentcloud-sdk-essbasic
3
3
  version: !ruby/object:Gem::Version
4
- version: 3.0.775
4
+ version: 3.0.777
5
5
  platform: ruby
6
6
  authors:
7
7
  - Tencent Cloud
8
8
  autorequire:
9
9
  bindir: bin
10
10
  cert_chain: []
11
- date: 2024-03-05 00:00:00.000000000 Z
11
+ date: 2024-03-08 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: tencentcloud-sdk-common