tencentcloud-sdk-sms 1.0.199

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.
@@ -0,0 +1,1405 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Copyright (c) 2017-2018 THL A29 Limited, a Tencent company. All Rights Reserved.
4
+ #
5
+ # Licensed under the Apache License, Version 2.0 (the "License");
6
+ # you may not use this file except in compliance with the License.
7
+ # You may obtain a copy of the License at
8
+ #
9
+ # http://www.apache.org/licenses/LICENSE-2.0
10
+ #
11
+ # Unless required by applicable law or agreed to in writing, software
12
+ # distributed under the License is distributed on an "AS IS" BASIS,
13
+ # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14
+ # See the License for the specific language governing permissions and
15
+ # limitations under the License.
16
+
17
+ module TencentCloud
18
+ module Sms
19
+ module V20190711
20
+ # 添加签名响应
21
+ class AddSignStatus < TencentCloud::Common::AbstractModel
22
+ # @param SignId: 签名Id。
23
+ # @type SignId: Integer
24
+ # @param SignApplyId: 签名申请Id。
25
+ # @type SignApplyId: Integer
26
+
27
+ attr_accessor :SignId, :SignApplyId
28
+
29
+ def initialize(signid=nil, signapplyid=nil)
30
+ @SignId = signid
31
+ @SignApplyId = signapplyid
32
+ end
33
+
34
+ def deserialize(params)
35
+ @SignId = params['SignId']
36
+ @SignApplyId = params['SignApplyId']
37
+ end
38
+ end
39
+
40
+ # AddSmsSign请求参数结构体
41
+ class AddSmsSignRequest < TencentCloud::Common::AbstractModel
42
+ # @param SignName: 签名名称。
43
+ # 注:不能重复申请已通过或待审核的签名。
44
+ # @type SignName: String
45
+ # @param SignType: 签名类型。其中每种类型后面标注了其可选的 DocumentType(证明类型):
46
+ # 0:公司(0,1,2,3)。
47
+ # 1:APP(0,1,2,3,4) 。
48
+ # 2:网站(0,1,2,3,5)。
49
+ # 3:公众号或者小程序(0,1,2,3,6)。
50
+ # 4:商标(7)。
51
+ # 5:政府/机关事业单位/其他机构(2,3)。
52
+ # 注:必须按照对应关系选择证明类型,否则会审核失败。
53
+ # @type SignType: Integer
54
+ # @param DocumentType: 证明类型:
55
+ # 0:三证合一。
56
+ # 1:企业营业执照。
57
+ # 2:组织机构代码证书。
58
+ # 3:社会信用代码证书。
59
+ # 4:应用后台管理截图(个人开发APP)。
60
+ # 5:网站备案后台截图(个人开发网站)。
61
+ # 6:小程序设置页面截图(个人认证小程序)。
62
+ # 7:商标注册书。
63
+ # @type DocumentType: Integer
64
+ # @param International: 是否国际/港澳台短信:
65
+ # 0:表示国内短信。
66
+ # 1:表示国际/港澳台短信。
67
+ # @type International: Integer
68
+ # @param UsedMethod: 签名用途:
69
+ # 0:自用。
70
+ # 1:他用。
71
+ # @type UsedMethod: Integer
72
+ # @param ProofImage: 签名对应的资质证明图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
73
+ # @type ProofImage: String
74
+ # @param CommissionImage: 委托授权证明。选择 UsedMethod 为他用之后需要提交委托的授权证明。
75
+ # 图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
76
+ # 注:只有 UsedMethod 在选择为 1(他用)时,这个字段才会生效。
77
+ # @type CommissionImage: String
78
+ # @param Remark: 签名的申请备注。
79
+ # @type Remark: String
80
+
81
+ attr_accessor :SignName, :SignType, :DocumentType, :International, :UsedMethod, :ProofImage, :CommissionImage, :Remark
82
+
83
+ def initialize(signname=nil, signtype=nil, documenttype=nil, international=nil, usedmethod=nil, proofimage=nil, commissionimage=nil, remark=nil)
84
+ @SignName = signname
85
+ @SignType = signtype
86
+ @DocumentType = documenttype
87
+ @International = international
88
+ @UsedMethod = usedmethod
89
+ @ProofImage = proofimage
90
+ @CommissionImage = commissionimage
91
+ @Remark = remark
92
+ end
93
+
94
+ def deserialize(params)
95
+ @SignName = params['SignName']
96
+ @SignType = params['SignType']
97
+ @DocumentType = params['DocumentType']
98
+ @International = params['International']
99
+ @UsedMethod = params['UsedMethod']
100
+ @ProofImage = params['ProofImage']
101
+ @CommissionImage = params['CommissionImage']
102
+ @Remark = params['Remark']
103
+ end
104
+ end
105
+
106
+ # AddSmsSign返回参数结构体
107
+ class AddSmsSignResponse < TencentCloud::Common::AbstractModel
108
+ # @param AddSignStatus: 添加签名响应
109
+ # @type AddSignStatus: :class:`Tencentcloud::Sms.v20190711.models.AddSignStatus`
110
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
111
+ # @type RequestId: String
112
+
113
+ attr_accessor :AddSignStatus, :RequestId
114
+
115
+ def initialize(addsignstatus=nil, requestid=nil)
116
+ @AddSignStatus = addsignstatus
117
+ @RequestId = requestid
118
+ end
119
+
120
+ def deserialize(params)
121
+ unless params['AddSignStatus'].nil?
122
+ @AddSignStatus = AddSignStatus.new
123
+ @AddSignStatus.deserialize(params['AddSignStatus'])
124
+ end
125
+ @RequestId = params['RequestId']
126
+ end
127
+ end
128
+
129
+ # AddSmsTemplate请求参数结构体
130
+ class AddSmsTemplateRequest < TencentCloud::Common::AbstractModel
131
+ # @param TemplateName: 模板名称。
132
+ # @type TemplateName: String
133
+ # @param TemplateContent: 模板内容。
134
+ # @type TemplateContent: String
135
+ # @param SmsType: 短信类型,0表示普通短信, 1表示营销短信。
136
+ # @type SmsType: Integer
137
+ # @param International: 是否国际/港澳台短信:
138
+ # 0:表示国内短信。
139
+ # 1:表示国际/港澳台短信。
140
+ # @type International: Integer
141
+ # @param Remark: 模板备注,例如申请原因,使用场景等。
142
+ # @type Remark: String
143
+
144
+ attr_accessor :TemplateName, :TemplateContent, :SmsType, :International, :Remark
145
+
146
+ def initialize(templatename=nil, templatecontent=nil, smstype=nil, international=nil, remark=nil)
147
+ @TemplateName = templatename
148
+ @TemplateContent = templatecontent
149
+ @SmsType = smstype
150
+ @International = international
151
+ @Remark = remark
152
+ end
153
+
154
+ def deserialize(params)
155
+ @TemplateName = params['TemplateName']
156
+ @TemplateContent = params['TemplateContent']
157
+ @SmsType = params['SmsType']
158
+ @International = params['International']
159
+ @Remark = params['Remark']
160
+ end
161
+ end
162
+
163
+ # AddSmsTemplate返回参数结构体
164
+ class AddSmsTemplateResponse < TencentCloud::Common::AbstractModel
165
+ # @param AddTemplateStatus: 添加短信模板响应包体
166
+ # @type AddTemplateStatus: :class:`Tencentcloud::Sms.v20190711.models.AddTemplateStatus`
167
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
168
+ # @type RequestId: String
169
+
170
+ attr_accessor :AddTemplateStatus, :RequestId
171
+
172
+ def initialize(addtemplatestatus=nil, requestid=nil)
173
+ @AddTemplateStatus = addtemplatestatus
174
+ @RequestId = requestid
175
+ end
176
+
177
+ def deserialize(params)
178
+ unless params['AddTemplateStatus'].nil?
179
+ @AddTemplateStatus = AddTemplateStatus.new
180
+ @AddTemplateStatus.deserialize(params['AddTemplateStatus'])
181
+ end
182
+ @RequestId = params['RequestId']
183
+ end
184
+ end
185
+
186
+ # 添加模板参数响应
187
+ class AddTemplateStatus < TencentCloud::Common::AbstractModel
188
+ # @param TemplateId: 模板参数
189
+ # @type TemplateId: String
190
+
191
+ attr_accessor :TemplateId
192
+
193
+ def initialize(templateid=nil)
194
+ @TemplateId = templateid
195
+ end
196
+
197
+ def deserialize(params)
198
+ @TemplateId = params['TemplateId']
199
+ end
200
+ end
201
+
202
+ # 回执数据统计响应包体
203
+ class CallbackStatusStatistics < TencentCloud::Common::AbstractModel
204
+ # @param CallbackCount: 短信回执量统计。
205
+ # @type CallbackCount: Integer
206
+ # @param RequestSuccessCount: 短信提交成功量统计。
207
+ # @type RequestSuccessCount: Integer
208
+ # @param CallbackFailCount: 短信回执失败量统计。
209
+ # @type CallbackFailCount: Integer
210
+ # @param CallbackSuccessCount: 短信回执成功量统计。
211
+ # @type CallbackSuccessCount: Integer
212
+ # @param InternalErrorCount: 运营商内部错误统计。
213
+ # @type InternalErrorCount: Integer
214
+ # @param InvalidNumberCount: 号码无效或空号统计。
215
+ # @type InvalidNumberCount: Integer
216
+ # @param ShutdownErrorCount: 停机、关机等错误统计。
217
+ # @type ShutdownErrorCount: Integer
218
+ # @param BlackListCount: 号码拉入黑名单统计。
219
+ # @type BlackListCount: Integer
220
+ # @param FrequencyLimitCount: 运营商频率限制统计。
221
+ # @type FrequencyLimitCount: Integer
222
+
223
+ attr_accessor :CallbackCount, :RequestSuccessCount, :CallbackFailCount, :CallbackSuccessCount, :InternalErrorCount, :InvalidNumberCount, :ShutdownErrorCount, :BlackListCount, :FrequencyLimitCount
224
+
225
+ def initialize(callbackcount=nil, requestsuccesscount=nil, callbackfailcount=nil, callbacksuccesscount=nil, internalerrorcount=nil, invalidnumbercount=nil, shutdownerrorcount=nil, blacklistcount=nil, frequencylimitcount=nil)
226
+ @CallbackCount = callbackcount
227
+ @RequestSuccessCount = requestsuccesscount
228
+ @CallbackFailCount = callbackfailcount
229
+ @CallbackSuccessCount = callbacksuccesscount
230
+ @InternalErrorCount = internalerrorcount
231
+ @InvalidNumberCount = invalidnumbercount
232
+ @ShutdownErrorCount = shutdownerrorcount
233
+ @BlackListCount = blacklistcount
234
+ @FrequencyLimitCount = frequencylimitcount
235
+ end
236
+
237
+ def deserialize(params)
238
+ @CallbackCount = params['CallbackCount']
239
+ @RequestSuccessCount = params['RequestSuccessCount']
240
+ @CallbackFailCount = params['CallbackFailCount']
241
+ @CallbackSuccessCount = params['CallbackSuccessCount']
242
+ @InternalErrorCount = params['InternalErrorCount']
243
+ @InvalidNumberCount = params['InvalidNumberCount']
244
+ @ShutdownErrorCount = params['ShutdownErrorCount']
245
+ @BlackListCount = params['BlackListCount']
246
+ @FrequencyLimitCount = params['FrequencyLimitCount']
247
+ end
248
+ end
249
+
250
+ # CallbackStatusStatistics请求参数结构体
251
+ class CallbackStatusStatisticsRequest < TencentCloud::Common::AbstractModel
252
+ # @param StartDateTime: 开始时间,yyyymmddhh 需要拉取的起始时间,精确到小时。
253
+ # @type StartDateTime: Integer
254
+ # @param EndDataTime: 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时。
255
+ # 注:EndDataTime 必须大于 StartDateTime。
256
+ # @type EndDataTime: Integer
257
+ # @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
258
+ # @type SmsSdkAppid: String
259
+ # @param Limit: 最大上限。
260
+ # 注:目前固定设置为0。
261
+ # @type Limit: Integer
262
+ # @param Offset: 偏移量。
263
+ # 注:目前固定设置为0。
264
+ # @type Offset: Integer
265
+
266
+ attr_accessor :StartDateTime, :EndDataTime, :SmsSdkAppid, :Limit, :Offset
267
+
268
+ def initialize(startdatetime=nil, enddatatime=nil, smssdkappid=nil, limit=nil, offset=nil)
269
+ @StartDateTime = startdatetime
270
+ @EndDataTime = enddatatime
271
+ @SmsSdkAppid = smssdkappid
272
+ @Limit = limit
273
+ @Offset = offset
274
+ end
275
+
276
+ def deserialize(params)
277
+ @StartDateTime = params['StartDateTime']
278
+ @EndDataTime = params['EndDataTime']
279
+ @SmsSdkAppid = params['SmsSdkAppid']
280
+ @Limit = params['Limit']
281
+ @Offset = params['Offset']
282
+ end
283
+ end
284
+
285
+ # CallbackStatusStatistics返回参数结构体
286
+ class CallbackStatusStatisticsResponse < TencentCloud::Common::AbstractModel
287
+ # @param CallbackStatusStatistics: 回执数据统计响应包体。
288
+ # @type CallbackStatusStatistics: :class:`Tencentcloud::Sms.v20190711.models.CallbackStatusStatistics`
289
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
290
+ # @type RequestId: String
291
+
292
+ attr_accessor :CallbackStatusStatistics, :RequestId
293
+
294
+ def initialize(callbackstatusstatistics=nil, requestid=nil)
295
+ @CallbackStatusStatistics = callbackstatusstatistics
296
+ @RequestId = requestid
297
+ end
298
+
299
+ def deserialize(params)
300
+ unless params['CallbackStatusStatistics'].nil?
301
+ @CallbackStatusStatistics = CallbackStatusStatistics.new
302
+ @CallbackStatusStatistics.deserialize(params['CallbackStatusStatistics'])
303
+ end
304
+ @RequestId = params['RequestId']
305
+ end
306
+ end
307
+
308
+ # 删除签名响应
309
+ class DeleteSignStatus < TencentCloud::Common::AbstractModel
310
+ # @param DeleteStatus: 删除状态信息。
311
+ # @type DeleteStatus: String
312
+ # @param DeleteTime: 删除时间,UNIX 时间戳(单位:秒)。
313
+ # @type DeleteTime: Integer
314
+
315
+ attr_accessor :DeleteStatus, :DeleteTime
316
+
317
+ def initialize(deletestatus=nil, deletetime=nil)
318
+ @DeleteStatus = deletestatus
319
+ @DeleteTime = deletetime
320
+ end
321
+
322
+ def deserialize(params)
323
+ @DeleteStatus = params['DeleteStatus']
324
+ @DeleteTime = params['DeleteTime']
325
+ end
326
+ end
327
+
328
+ # DeleteSmsSign请求参数结构体
329
+ class DeleteSmsSignRequest < TencentCloud::Common::AbstractModel
330
+ # @param SignId: 待删除的签名 ID。
331
+ # @type SignId: Integer
332
+
333
+ attr_accessor :SignId
334
+
335
+ def initialize(signid=nil)
336
+ @SignId = signid
337
+ end
338
+
339
+ def deserialize(params)
340
+ @SignId = params['SignId']
341
+ end
342
+ end
343
+
344
+ # DeleteSmsSign返回参数结构体
345
+ class DeleteSmsSignResponse < TencentCloud::Common::AbstractModel
346
+ # @param DeleteSignStatus: 删除签名响应
347
+ # @type DeleteSignStatus: :class:`Tencentcloud::Sms.v20190711.models.DeleteSignStatus`
348
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
349
+ # @type RequestId: String
350
+
351
+ attr_accessor :DeleteSignStatus, :RequestId
352
+
353
+ def initialize(deletesignstatus=nil, requestid=nil)
354
+ @DeleteSignStatus = deletesignstatus
355
+ @RequestId = requestid
356
+ end
357
+
358
+ def deserialize(params)
359
+ unless params['DeleteSignStatus'].nil?
360
+ @DeleteSignStatus = DeleteSignStatus.new
361
+ @DeleteSignStatus.deserialize(params['DeleteSignStatus'])
362
+ end
363
+ @RequestId = params['RequestId']
364
+ end
365
+ end
366
+
367
+ # DeleteSmsTemplate请求参数结构体
368
+ class DeleteSmsTemplateRequest < TencentCloud::Common::AbstractModel
369
+ # @param TemplateId: 待删除的模板 ID。
370
+ # @type TemplateId: Integer
371
+
372
+ attr_accessor :TemplateId
373
+
374
+ def initialize(templateid=nil)
375
+ @TemplateId = templateid
376
+ end
377
+
378
+ def deserialize(params)
379
+ @TemplateId = params['TemplateId']
380
+ end
381
+ end
382
+
383
+ # DeleteSmsTemplate返回参数结构体
384
+ class DeleteSmsTemplateResponse < TencentCloud::Common::AbstractModel
385
+ # @param DeleteTemplateStatus: 删除模板响应
386
+ # @type DeleteTemplateStatus: :class:`Tencentcloud::Sms.v20190711.models.DeleteTemplateStatus`
387
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
388
+ # @type RequestId: String
389
+
390
+ attr_accessor :DeleteTemplateStatus, :RequestId
391
+
392
+ def initialize(deletetemplatestatus=nil, requestid=nil)
393
+ @DeleteTemplateStatus = deletetemplatestatus
394
+ @RequestId = requestid
395
+ end
396
+
397
+ def deserialize(params)
398
+ unless params['DeleteTemplateStatus'].nil?
399
+ @DeleteTemplateStatus = DeleteTemplateStatus.new
400
+ @DeleteTemplateStatus.deserialize(params['DeleteTemplateStatus'])
401
+ end
402
+ @RequestId = params['RequestId']
403
+ end
404
+ end
405
+
406
+ # 删除模板响应
407
+ class DeleteTemplateStatus < TencentCloud::Common::AbstractModel
408
+ # @param DeleteStatus: 删除状态信息。
409
+ # @type DeleteStatus: String
410
+ # @param DeleteTime: 删除时间,UNIX 时间戳(单位:秒)。
411
+ # @type DeleteTime: Integer
412
+
413
+ attr_accessor :DeleteStatus, :DeleteTime
414
+
415
+ def initialize(deletestatus=nil, deletetime=nil)
416
+ @DeleteStatus = deletestatus
417
+ @DeleteTime = deletetime
418
+ end
419
+
420
+ def deserialize(params)
421
+ @DeleteStatus = params['DeleteStatus']
422
+ @DeleteTime = params['DeleteTime']
423
+ end
424
+ end
425
+
426
+ # 获取短信签名信息响应
427
+ class DescribeSignListStatus < TencentCloud::Common::AbstractModel
428
+ # @param SignId: 签名Id
429
+ # @type SignId: Integer
430
+ # @param International: 是否国际/港澳台短信:
431
+ # 0:表示国内短信。
432
+ # 1:表示国际/港澳台短信。
433
+ # @type International: Integer
434
+ # @param StatusCode: 申请签名状态。其中:
435
+ # 0:表示审核通过。
436
+ # 1:表示审核中。
437
+ # -1:表示审核未通过或审核失败。
438
+ # @type StatusCode: Integer
439
+ # @param ReviewReply: 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
440
+ # @type ReviewReply: String
441
+ # @param SignName: 签名名称。
442
+ # @type SignName: String
443
+ # @param CreateTime: 提交审核时间,UNIX 时间戳(单位:秒)。
444
+ # @type CreateTime: Integer
445
+
446
+ attr_accessor :SignId, :International, :StatusCode, :ReviewReply, :SignName, :CreateTime
447
+
448
+ def initialize(signid=nil, international=nil, statuscode=nil, reviewreply=nil, signname=nil, createtime=nil)
449
+ @SignId = signid
450
+ @International = international
451
+ @StatusCode = statuscode
452
+ @ReviewReply = reviewreply
453
+ @SignName = signname
454
+ @CreateTime = createtime
455
+ end
456
+
457
+ def deserialize(params)
458
+ @SignId = params['SignId']
459
+ @International = params['International']
460
+ @StatusCode = params['StatusCode']
461
+ @ReviewReply = params['ReviewReply']
462
+ @SignName = params['SignName']
463
+ @CreateTime = params['CreateTime']
464
+ end
465
+ end
466
+
467
+ # DescribeSmsSignList请求参数结构体
468
+ class DescribeSmsSignListRequest < TencentCloud::Common::AbstractModel
469
+ # @param SignIdSet: 签名 ID 数组。
470
+ # @type SignIdSet: Array
471
+ # @param International: 是否国际/港澳台短信:
472
+ # 0:表示国内短信。
473
+ # 1:表示国际/港澳台短信。
474
+ # @type International: Integer
475
+
476
+ attr_accessor :SignIdSet, :International
477
+
478
+ def initialize(signidset=nil, international=nil)
479
+ @SignIdSet = signidset
480
+ @International = international
481
+ end
482
+
483
+ def deserialize(params)
484
+ @SignIdSet = params['SignIdSet']
485
+ @International = params['International']
486
+ end
487
+ end
488
+
489
+ # DescribeSmsSignList返回参数结构体
490
+ class DescribeSmsSignListResponse < TencentCloud::Common::AbstractModel
491
+ # @param DescribeSignListStatusSet: 获取签名信息响应
492
+ # @type DescribeSignListStatusSet: Array
493
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
494
+ # @type RequestId: String
495
+
496
+ attr_accessor :DescribeSignListStatusSet, :RequestId
497
+
498
+ def initialize(describesignliststatusset=nil, requestid=nil)
499
+ @DescribeSignListStatusSet = describesignliststatusset
500
+ @RequestId = requestid
501
+ end
502
+
503
+ def deserialize(params)
504
+ unless params['DescribeSignListStatusSet'].nil?
505
+ @DescribeSignListStatusSet = []
506
+ params['DescribeSignListStatusSet'].each do |i|
507
+ describesignliststatus_tmp = DescribeSignListStatus.new
508
+ describesignliststatus_tmp.deserialize(i)
509
+ @DescribeSignListStatusSet << describesignliststatus_tmp
510
+ end
511
+ end
512
+ @RequestId = params['RequestId']
513
+ end
514
+ end
515
+
516
+ # DescribeSmsTemplateList请求参数结构体
517
+ class DescribeSmsTemplateListRequest < TencentCloud::Common::AbstractModel
518
+ # @param TemplateIdSet: 模板 ID 数组。
519
+ # @type TemplateIdSet: Array
520
+ # @param International: 是否国际/港澳台短信:
521
+ # 0:表示国内短信。
522
+ # 1:表示国际/港澳台短信。
523
+ # @type International: Integer
524
+
525
+ attr_accessor :TemplateIdSet, :International
526
+
527
+ def initialize(templateidset=nil, international=nil)
528
+ @TemplateIdSet = templateidset
529
+ @International = international
530
+ end
531
+
532
+ def deserialize(params)
533
+ @TemplateIdSet = params['TemplateIdSet']
534
+ @International = params['International']
535
+ end
536
+ end
537
+
538
+ # DescribeSmsTemplateList返回参数结构体
539
+ class DescribeSmsTemplateListResponse < TencentCloud::Common::AbstractModel
540
+ # @param DescribeTemplateStatusSet: 获取短信模板信息响应
541
+ # @type DescribeTemplateStatusSet: Array
542
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
543
+ # @type RequestId: String
544
+
545
+ attr_accessor :DescribeTemplateStatusSet, :RequestId
546
+
547
+ def initialize(describetemplatestatusset=nil, requestid=nil)
548
+ @DescribeTemplateStatusSet = describetemplatestatusset
549
+ @RequestId = requestid
550
+ end
551
+
552
+ def deserialize(params)
553
+ unless params['DescribeTemplateStatusSet'].nil?
554
+ @DescribeTemplateStatusSet = []
555
+ params['DescribeTemplateStatusSet'].each do |i|
556
+ describetemplateliststatus_tmp = DescribeTemplateListStatus.new
557
+ describetemplateliststatus_tmp.deserialize(i)
558
+ @DescribeTemplateStatusSet << describetemplateliststatus_tmp
559
+ end
560
+ end
561
+ @RequestId = params['RequestId']
562
+ end
563
+ end
564
+
565
+ # 获取短信模板信息响应
566
+ class DescribeTemplateListStatus < TencentCloud::Common::AbstractModel
567
+ # @param TemplateId: 模板Id
568
+ # @type TemplateId: Integer
569
+ # @param International: 是否国际/港澳台短信:
570
+ # 0:表示国内短信。
571
+ # 1:表示国际/港澳台短信。
572
+ # @type International: Integer
573
+ # @param StatusCode: 申请签名状态。其中:
574
+ # 0:表示审核通过。
575
+ # 1:表示审核中。
576
+ # -1:表示审核未通过或审核失败。
577
+ # @type StatusCode: Integer
578
+ # @param ReviewReply: 审核回复,审核人员审核后给出的回复,通常是审核未通过的原因。
579
+ # @type ReviewReply: String
580
+ # @param TemplateName: 模板名称。
581
+ # @type TemplateName: String
582
+ # @param CreateTime: 提交审核时间,UNIX 时间戳(单位:秒)。
583
+ # @type CreateTime: Integer
584
+
585
+ attr_accessor :TemplateId, :International, :StatusCode, :ReviewReply, :TemplateName, :CreateTime
586
+
587
+ def initialize(templateid=nil, international=nil, statuscode=nil, reviewreply=nil, templatename=nil, createtime=nil)
588
+ @TemplateId = templateid
589
+ @International = international
590
+ @StatusCode = statuscode
591
+ @ReviewReply = reviewreply
592
+ @TemplateName = templatename
593
+ @CreateTime = createtime
594
+ end
595
+
596
+ def deserialize(params)
597
+ @TemplateId = params['TemplateId']
598
+ @International = params['International']
599
+ @StatusCode = params['StatusCode']
600
+ @ReviewReply = params['ReviewReply']
601
+ @TemplateName = params['TemplateName']
602
+ @CreateTime = params['CreateTime']
603
+ end
604
+ end
605
+
606
+ # 修改签名响应
607
+ class ModifySignStatus < TencentCloud::Common::AbstractModel
608
+ # @param SignId: 签名Id
609
+ # @type SignId: Integer
610
+ # @param SignApplyId: 签名修改申请Id
611
+ # @type SignApplyId: String
612
+
613
+ attr_accessor :SignId, :SignApplyId
614
+
615
+ def initialize(signid=nil, signapplyid=nil)
616
+ @SignId = signid
617
+ @SignApplyId = signapplyid
618
+ end
619
+
620
+ def deserialize(params)
621
+ @SignId = params['SignId']
622
+ @SignApplyId = params['SignApplyId']
623
+ end
624
+ end
625
+
626
+ # ModifySmsSign请求参数结构体
627
+ class ModifySmsSignRequest < TencentCloud::Common::AbstractModel
628
+ # @param SignId: 待修改的签名 ID。
629
+ # @type SignId: Integer
630
+ # @param SignName: 签名名称。
631
+ # @type SignName: String
632
+ # @param SignType: 签名类型。其中每种类型后面标注了其可选的 DocumentType(证明类型):
633
+ # 0:公司(0,1,2,3)。
634
+ # 1:APP(0,1,2,3,4) 。
635
+ # 2:网站(0,1,2,3,5)。
636
+ # 3:公众号或者小程序(0,1,2,3,6)。
637
+ # 4:商标(7)。
638
+ # 5:政府/机关事业单位/其他机构(2,3)。
639
+ # 注:必须按照对应关系选择证明类型,否则会审核失败。
640
+ # @type SignType: Integer
641
+ # @param DocumentType: 证明类型:
642
+ # 0:三证合一。
643
+ # 1:企业营业执照。
644
+ # 2:组织机构代码证书。
645
+ # 3:社会信用代码证书。
646
+ # 4:应用后台管理截图(个人开发APP)。
647
+ # 5:网站备案后台截图(个人开发网站)。
648
+ # 6:小程序设置页面截图(个人认证小程序)。
649
+ # 7:商标注册书。
650
+ # @type DocumentType: Integer
651
+ # @param International: 是否国际/港澳台短信:
652
+ # 0:表示国内短信。
653
+ # 1:表示国际/港澳台短信。
654
+ # 注:需要和待修改签名International值保持一致,该参数不能直接修改国内签名到国际签名。
655
+ # @type International: Integer
656
+ # @param UsedMethod: 签名用途:
657
+ # 0:自用。
658
+ # 1:他用。
659
+ # @type UsedMethod: Integer
660
+ # @param ProofImage: 签名对应的资质证明图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
661
+ # @type ProofImage: String
662
+ # @param CommissionImage: 委托授权证明。选择 UsedMethod 为他用之后需要提交委托的授权证明。
663
+ # 图片需先进行 base64 编码格式转换,将转换后的字符串去掉前缀`data:image/jpeg;base64,`再赋值给该参数。
664
+ # 注:只有 UsedMethod 在选择为 1(他用)时,这个字段才会生效。
665
+ # @type CommissionImage: String
666
+ # @param Remark: 签名的申请备注。
667
+ # @type Remark: String
668
+
669
+ attr_accessor :SignId, :SignName, :SignType, :DocumentType, :International, :UsedMethod, :ProofImage, :CommissionImage, :Remark
670
+
671
+ def initialize(signid=nil, signname=nil, signtype=nil, documenttype=nil, international=nil, usedmethod=nil, proofimage=nil, commissionimage=nil, remark=nil)
672
+ @SignId = signid
673
+ @SignName = signname
674
+ @SignType = signtype
675
+ @DocumentType = documenttype
676
+ @International = international
677
+ @UsedMethod = usedmethod
678
+ @ProofImage = proofimage
679
+ @CommissionImage = commissionimage
680
+ @Remark = remark
681
+ end
682
+
683
+ def deserialize(params)
684
+ @SignId = params['SignId']
685
+ @SignName = params['SignName']
686
+ @SignType = params['SignType']
687
+ @DocumentType = params['DocumentType']
688
+ @International = params['International']
689
+ @UsedMethod = params['UsedMethod']
690
+ @ProofImage = params['ProofImage']
691
+ @CommissionImage = params['CommissionImage']
692
+ @Remark = params['Remark']
693
+ end
694
+ end
695
+
696
+ # ModifySmsSign返回参数结构体
697
+ class ModifySmsSignResponse < TencentCloud::Common::AbstractModel
698
+ # @param ModifySignStatus: 修改签名响应
699
+ # @type ModifySignStatus: :class:`Tencentcloud::Sms.v20190711.models.ModifySignStatus`
700
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
701
+ # @type RequestId: String
702
+
703
+ attr_accessor :ModifySignStatus, :RequestId
704
+
705
+ def initialize(modifysignstatus=nil, requestid=nil)
706
+ @ModifySignStatus = modifysignstatus
707
+ @RequestId = requestid
708
+ end
709
+
710
+ def deserialize(params)
711
+ unless params['ModifySignStatus'].nil?
712
+ @ModifySignStatus = ModifySignStatus.new
713
+ @ModifySignStatus.deserialize(params['ModifySignStatus'])
714
+ end
715
+ @RequestId = params['RequestId']
716
+ end
717
+ end
718
+
719
+ # ModifySmsTemplate请求参数结构体
720
+ class ModifySmsTemplateRequest < TencentCloud::Common::AbstractModel
721
+ # @param TemplateId: 待修改的模板的模板 ID。
722
+ # @type TemplateId: Integer
723
+ # @param TemplateName: 新的模板名称。
724
+ # @type TemplateName: String
725
+ # @param TemplateContent: 新的模板内容。
726
+ # @type TemplateContent: String
727
+ # @param SmsType: 短信类型,0表示普通短信, 1表示营销短信。
728
+ # @type SmsType: Integer
729
+ # @param International: 是否国际/港澳台短信:
730
+ # 0:表示国内短信。
731
+ # 1:表示国际/港澳台短信。
732
+ # @type International: Integer
733
+ # @param Remark: 模板备注,例如申请原因,使用场景等。
734
+ # @type Remark: String
735
+
736
+ attr_accessor :TemplateId, :TemplateName, :TemplateContent, :SmsType, :International, :Remark
737
+
738
+ def initialize(templateid=nil, templatename=nil, templatecontent=nil, smstype=nil, international=nil, remark=nil)
739
+ @TemplateId = templateid
740
+ @TemplateName = templatename
741
+ @TemplateContent = templatecontent
742
+ @SmsType = smstype
743
+ @International = international
744
+ @Remark = remark
745
+ end
746
+
747
+ def deserialize(params)
748
+ @TemplateId = params['TemplateId']
749
+ @TemplateName = params['TemplateName']
750
+ @TemplateContent = params['TemplateContent']
751
+ @SmsType = params['SmsType']
752
+ @International = params['International']
753
+ @Remark = params['Remark']
754
+ end
755
+ end
756
+
757
+ # ModifySmsTemplate返回参数结构体
758
+ class ModifySmsTemplateResponse < TencentCloud::Common::AbstractModel
759
+ # @param ModifyTemplateStatus: 修改模板参数响应
760
+ # @type ModifyTemplateStatus: :class:`Tencentcloud::Sms.v20190711.models.ModifyTemplateStatus`
761
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
762
+ # @type RequestId: String
763
+
764
+ attr_accessor :ModifyTemplateStatus, :RequestId
765
+
766
+ def initialize(modifytemplatestatus=nil, requestid=nil)
767
+ @ModifyTemplateStatus = modifytemplatestatus
768
+ @RequestId = requestid
769
+ end
770
+
771
+ def deserialize(params)
772
+ unless params['ModifyTemplateStatus'].nil?
773
+ @ModifyTemplateStatus = ModifyTemplateStatus.new
774
+ @ModifyTemplateStatus.deserialize(params['ModifyTemplateStatus'])
775
+ end
776
+ @RequestId = params['RequestId']
777
+ end
778
+ end
779
+
780
+ # 修改模板参数响应
781
+ class ModifyTemplateStatus < TencentCloud::Common::AbstractModel
782
+ # @param TemplateId: 模板参数
783
+ # @type TemplateId: Integer
784
+
785
+ attr_accessor :TemplateId
786
+
787
+ def initialize(templateid=nil)
788
+ @TemplateId = templateid
789
+ end
790
+
791
+ def deserialize(params)
792
+ @TemplateId = params['TemplateId']
793
+ end
794
+ end
795
+
796
+ # 短信回复状态
797
+ class PullSmsReplyStatus < TencentCloud::Common::AbstractModel
798
+ # @param ExtendCode: 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
799
+ # @type ExtendCode: String
800
+ # @param NationCode: 国家(或地区)码。
801
+ # @type NationCode: String
802
+ # @param PhoneNumber: 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
803
+ # @type PhoneNumber: String
804
+ # @param Sign: 短信签名。
805
+ # @type Sign: String
806
+ # @param ReplyContent: 用户回复的内容。
807
+ # @type ReplyContent: String
808
+ # @param ReplyTime: 回复时间(例如:2019-10-08 17:18:37)。
809
+ # @type ReplyTime: String
810
+ # @param ReplyUnixTime: 回复时间,UNIX 时间戳(单位:秒)。
811
+ # @type ReplyUnixTime: Integer
812
+
813
+ attr_accessor :ExtendCode, :NationCode, :PhoneNumber, :Sign, :ReplyContent, :ReplyTime, :ReplyUnixTime
814
+
815
+ def initialize(extendcode=nil, nationcode=nil, phonenumber=nil, sign=nil, replycontent=nil, replytime=nil, replyunixtime=nil)
816
+ @ExtendCode = extendcode
817
+ @NationCode = nationcode
818
+ @PhoneNumber = phonenumber
819
+ @Sign = sign
820
+ @ReplyContent = replycontent
821
+ @ReplyTime = replytime
822
+ @ReplyUnixTime = replyunixtime
823
+ end
824
+
825
+ def deserialize(params)
826
+ @ExtendCode = params['ExtendCode']
827
+ @NationCode = params['NationCode']
828
+ @PhoneNumber = params['PhoneNumber']
829
+ @Sign = params['Sign']
830
+ @ReplyContent = params['ReplyContent']
831
+ @ReplyTime = params['ReplyTime']
832
+ @ReplyUnixTime = params['ReplyUnixTime']
833
+ end
834
+ end
835
+
836
+ # PullSmsReplyStatusByPhoneNumber请求参数结构体
837
+ class PullSmsReplyStatusByPhoneNumberRequest < TencentCloud::Common::AbstractModel
838
+ # @param SendDateTime: 拉取起始时间,UNIX 时间戳(时间:秒)。
839
+ # 注:最大可拉取当前时期7天前的数据。
840
+ # @type SendDateTime: Integer
841
+ # @param Offset: 偏移量。
842
+ # 注:目前固定设置为0。
843
+ # @type Offset: Integer
844
+ # @param Limit: 拉取最大条数,最多 100。
845
+ # @type Limit: Integer
846
+ # @param PhoneNumber: 下发目的手机号码,依据 e.164 标准为:+[国家(或地区)码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
847
+ # @type PhoneNumber: String
848
+ # @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
849
+ # @type SmsSdkAppid: String
850
+ # @param EndDateTime: 拉取截止时间,UNIX 时间戳(时间:秒)。
851
+ # @type EndDateTime: Integer
852
+
853
+ attr_accessor :SendDateTime, :Offset, :Limit, :PhoneNumber, :SmsSdkAppid, :EndDateTime
854
+
855
+ def initialize(senddatetime=nil, offset=nil, limit=nil, phonenumber=nil, smssdkappid=nil, enddatetime=nil)
856
+ @SendDateTime = senddatetime
857
+ @Offset = offset
858
+ @Limit = limit
859
+ @PhoneNumber = phonenumber
860
+ @SmsSdkAppid = smssdkappid
861
+ @EndDateTime = enddatetime
862
+ end
863
+
864
+ def deserialize(params)
865
+ @SendDateTime = params['SendDateTime']
866
+ @Offset = params['Offset']
867
+ @Limit = params['Limit']
868
+ @PhoneNumber = params['PhoneNumber']
869
+ @SmsSdkAppid = params['SmsSdkAppid']
870
+ @EndDateTime = params['EndDateTime']
871
+ end
872
+ end
873
+
874
+ # PullSmsReplyStatusByPhoneNumber返回参数结构体
875
+ class PullSmsReplyStatusByPhoneNumberResponse < TencentCloud::Common::AbstractModel
876
+ # @param PullSmsReplyStatusSet: 回复状态响应集合。
877
+ # @type PullSmsReplyStatusSet: Array
878
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
879
+ # @type RequestId: String
880
+
881
+ attr_accessor :PullSmsReplyStatusSet, :RequestId
882
+
883
+ def initialize(pullsmsreplystatusset=nil, requestid=nil)
884
+ @PullSmsReplyStatusSet = pullsmsreplystatusset
885
+ @RequestId = requestid
886
+ end
887
+
888
+ def deserialize(params)
889
+ unless params['PullSmsReplyStatusSet'].nil?
890
+ @PullSmsReplyStatusSet = []
891
+ params['PullSmsReplyStatusSet'].each do |i|
892
+ pullsmsreplystatus_tmp = PullSmsReplyStatus.new
893
+ pullsmsreplystatus_tmp.deserialize(i)
894
+ @PullSmsReplyStatusSet << pullsmsreplystatus_tmp
895
+ end
896
+ end
897
+ @RequestId = params['RequestId']
898
+ end
899
+ end
900
+
901
+ # PullSmsReplyStatus请求参数结构体
902
+ class PullSmsReplyStatusRequest < TencentCloud::Common::AbstractModel
903
+ # @param Limit: 拉取最大条数,最多100条。
904
+ # @type Limit: Integer
905
+ # @param SmsSdkAppid: 短信 SdkAppid 在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际 SdkAppid,例如1400006666。
906
+ # @type SmsSdkAppid: String
907
+
908
+ attr_accessor :Limit, :SmsSdkAppid
909
+
910
+ def initialize(limit=nil, smssdkappid=nil)
911
+ @Limit = limit
912
+ @SmsSdkAppid = smssdkappid
913
+ end
914
+
915
+ def deserialize(params)
916
+ @Limit = params['Limit']
917
+ @SmsSdkAppid = params['SmsSdkAppid']
918
+ end
919
+ end
920
+
921
+ # PullSmsReplyStatus返回参数结构体
922
+ class PullSmsReplyStatusResponse < TencentCloud::Common::AbstractModel
923
+ # @param PullSmsReplyStatusSet: 回复状态响应集合。
924
+ # @type PullSmsReplyStatusSet: Array
925
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
926
+ # @type RequestId: String
927
+
928
+ attr_accessor :PullSmsReplyStatusSet, :RequestId
929
+
930
+ def initialize(pullsmsreplystatusset=nil, requestid=nil)
931
+ @PullSmsReplyStatusSet = pullsmsreplystatusset
932
+ @RequestId = requestid
933
+ end
934
+
935
+ def deserialize(params)
936
+ unless params['PullSmsReplyStatusSet'].nil?
937
+ @PullSmsReplyStatusSet = []
938
+ params['PullSmsReplyStatusSet'].each do |i|
939
+ pullsmsreplystatus_tmp = PullSmsReplyStatus.new
940
+ pullsmsreplystatus_tmp.deserialize(i)
941
+ @PullSmsReplyStatusSet << pullsmsreplystatus_tmp
942
+ end
943
+ end
944
+ @RequestId = params['RequestId']
945
+ end
946
+ end
947
+
948
+ # 短信的下发状态详细信息
949
+ class PullSmsSendStatus < TencentCloud::Common::AbstractModel
950
+ # @param UserReceiveTime: 用户实际接收到短信的时间。
951
+ # @type UserReceiveTime: String
952
+ # @param UserReceiveUnixTime: 用户实际接收到短信的时间,UNIX 时间戳(单位:秒)。
953
+ # @type UserReceiveUnixTime: Integer
954
+ # @param NationCode: 国家(或地区)码。
955
+ # @type NationCode: String
956
+ # @param PurePhoneNumber: 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
957
+ # @type PurePhoneNumber: String
958
+ # @param PhoneNumber: 手机号码,普通格式,示例如:13711112222。
959
+ # @type PhoneNumber: String
960
+ # @param SerialNo: 本次发送标识 ID。
961
+ # @type SerialNo: String
962
+ # @param ReportStatus: 实际是否收到短信接收状态,SUCCESS(成功)、FAIL(失败)。
963
+ # @type ReportStatus: String
964
+ # @param Description: 用户接收短信状态描述。
965
+ # @type Description: String
966
+
967
+ attr_accessor :UserReceiveTime, :UserReceiveUnixTime, :NationCode, :PurePhoneNumber, :PhoneNumber, :SerialNo, :ReportStatus, :Description
968
+
969
+ def initialize(userreceivetime=nil, userreceiveunixtime=nil, nationcode=nil, purephonenumber=nil, phonenumber=nil, serialno=nil, reportstatus=nil, description=nil)
970
+ @UserReceiveTime = userreceivetime
971
+ @UserReceiveUnixTime = userreceiveunixtime
972
+ @NationCode = nationcode
973
+ @PurePhoneNumber = purephonenumber
974
+ @PhoneNumber = phonenumber
975
+ @SerialNo = serialno
976
+ @ReportStatus = reportstatus
977
+ @Description = description
978
+ end
979
+
980
+ def deserialize(params)
981
+ @UserReceiveTime = params['UserReceiveTime']
982
+ @UserReceiveUnixTime = params['UserReceiveUnixTime']
983
+ @NationCode = params['NationCode']
984
+ @PurePhoneNumber = params['PurePhoneNumber']
985
+ @PhoneNumber = params['PhoneNumber']
986
+ @SerialNo = params['SerialNo']
987
+ @ReportStatus = params['ReportStatus']
988
+ @Description = params['Description']
989
+ end
990
+ end
991
+
992
+ # PullSmsSendStatusByPhoneNumber请求参数结构体
993
+ class PullSmsSendStatusByPhoneNumberRequest < TencentCloud::Common::AbstractModel
994
+ # @param SendDateTime: 拉取起始时间,UNIX 时间戳(时间:秒)。
995
+ # 注:最大可拉取当前时期7天前的数据。
996
+ # @type SendDateTime: Integer
997
+ # @param Offset: 偏移量。
998
+ # 注:目前固定设置为0。
999
+ # @type Offset: Integer
1000
+ # @param Limit: 拉取最大条数,最多 100。
1001
+ # @type Limit: Integer
1002
+ # @param PhoneNumber: 下发目的手机号码,依据 e.164 标准为:+[国家(或地区)码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
1003
+ # @type PhoneNumber: String
1004
+ # @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
1005
+ # @type SmsSdkAppid: String
1006
+ # @param EndDateTime: 拉取截止时间,UNIX 时间戳(时间:秒)。
1007
+ # @type EndDateTime: Integer
1008
+
1009
+ attr_accessor :SendDateTime, :Offset, :Limit, :PhoneNumber, :SmsSdkAppid, :EndDateTime
1010
+
1011
+ def initialize(senddatetime=nil, offset=nil, limit=nil, phonenumber=nil, smssdkappid=nil, enddatetime=nil)
1012
+ @SendDateTime = senddatetime
1013
+ @Offset = offset
1014
+ @Limit = limit
1015
+ @PhoneNumber = phonenumber
1016
+ @SmsSdkAppid = smssdkappid
1017
+ @EndDateTime = enddatetime
1018
+ end
1019
+
1020
+ def deserialize(params)
1021
+ @SendDateTime = params['SendDateTime']
1022
+ @Offset = params['Offset']
1023
+ @Limit = params['Limit']
1024
+ @PhoneNumber = params['PhoneNumber']
1025
+ @SmsSdkAppid = params['SmsSdkAppid']
1026
+ @EndDateTime = params['EndDateTime']
1027
+ end
1028
+ end
1029
+
1030
+ # PullSmsSendStatusByPhoneNumber返回参数结构体
1031
+ class PullSmsSendStatusByPhoneNumberResponse < TencentCloud::Common::AbstractModel
1032
+ # @param PullSmsSendStatusSet: 下发状态响应集合。
1033
+ # @type PullSmsSendStatusSet: Array
1034
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1035
+ # @type RequestId: String
1036
+
1037
+ attr_accessor :PullSmsSendStatusSet, :RequestId
1038
+
1039
+ def initialize(pullsmssendstatusset=nil, requestid=nil)
1040
+ @PullSmsSendStatusSet = pullsmssendstatusset
1041
+ @RequestId = requestid
1042
+ end
1043
+
1044
+ def deserialize(params)
1045
+ unless params['PullSmsSendStatusSet'].nil?
1046
+ @PullSmsSendStatusSet = []
1047
+ params['PullSmsSendStatusSet'].each do |i|
1048
+ pullsmssendstatus_tmp = PullSmsSendStatus.new
1049
+ pullsmssendstatus_tmp.deserialize(i)
1050
+ @PullSmsSendStatusSet << pullsmssendstatus_tmp
1051
+ end
1052
+ end
1053
+ @RequestId = params['RequestId']
1054
+ end
1055
+ end
1056
+
1057
+ # PullSmsSendStatus请求参数结构体
1058
+ class PullSmsSendStatusRequest < TencentCloud::Common::AbstractModel
1059
+ # @param Limit: 拉取最大条数,最多100条。
1060
+ # @type Limit: Integer
1061
+ # @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,例如1400006666。
1062
+ # @type SmsSdkAppid: String
1063
+
1064
+ attr_accessor :Limit, :SmsSdkAppid
1065
+
1066
+ def initialize(limit=nil, smssdkappid=nil)
1067
+ @Limit = limit
1068
+ @SmsSdkAppid = smssdkappid
1069
+ end
1070
+
1071
+ def deserialize(params)
1072
+ @Limit = params['Limit']
1073
+ @SmsSdkAppid = params['SmsSdkAppid']
1074
+ end
1075
+ end
1076
+
1077
+ # PullSmsSendStatus返回参数结构体
1078
+ class PullSmsSendStatusResponse < TencentCloud::Common::AbstractModel
1079
+ # @param PullSmsSendStatusSet: 下发状态响应集合。
1080
+ # @type PullSmsSendStatusSet: Array
1081
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1082
+ # @type RequestId: String
1083
+
1084
+ attr_accessor :PullSmsSendStatusSet, :RequestId
1085
+
1086
+ def initialize(pullsmssendstatusset=nil, requestid=nil)
1087
+ @PullSmsSendStatusSet = pullsmssendstatusset
1088
+ @RequestId = requestid
1089
+ end
1090
+
1091
+ def deserialize(params)
1092
+ unless params['PullSmsSendStatusSet'].nil?
1093
+ @PullSmsSendStatusSet = []
1094
+ params['PullSmsSendStatusSet'].each do |i|
1095
+ pullsmssendstatus_tmp = PullSmsSendStatus.new
1096
+ pullsmssendstatus_tmp.deserialize(i)
1097
+ @PullSmsSendStatusSet << pullsmssendstatus_tmp
1098
+ end
1099
+ end
1100
+ @RequestId = params['RequestId']
1101
+ end
1102
+ end
1103
+
1104
+ # SendSms请求参数结构体
1105
+ class SendSmsRequest < TencentCloud::Common::AbstractModel
1106
+ # @param PhoneNumberSet: 下发手机号码,采用 e.164 标准,格式为+[国家或地区码][手机号],单次请求最多支持200个手机号且要求全为境内手机号或全为境外手机号。
1107
+ # 例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
1108
+ # @type PhoneNumberSet: Array
1109
+ # @param TemplateID: 模板 ID,必须填写已审核通过的模板 ID。模板ID可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看,若向境外手机号发送短信,仅支持使用国际/港澳台短信模板。
1110
+ # @type TemplateID: String
1111
+ # @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
1112
+ # @type SmsSdkAppid: String
1113
+ # @param Sign: 短信签名内容,使用 UTF-8 编码,必须填写已审核通过的签名,签名信息可登录 [短信控制台](https://console.cloud.tencent.com/smsv2) 查看。注:国内短信为必填参数。
1114
+ # @type Sign: String
1115
+ # @param TemplateParamSet: 模板参数,若无模板参数,则设置为空。
1116
+ # @type TemplateParamSet: Array
1117
+ # @param ExtendCode: 短信码号扩展号,默认未开通,如需开通请联系 [sms helper](https://cloud.tencent.com/document/product/382/3773)。
1118
+ # @type ExtendCode: String
1119
+ # @param SessionContext: 用户的 session 内容,可以携带用户侧 ID 等上下文信息,server 会原样返回。
1120
+ # @type SessionContext: String
1121
+ # @param SenderId: 国内短信无senderid,无需填写该项;若需开通国际/港澳台短信senderid,请联系smshelper。
1122
+ # @type SenderId: String
1123
+
1124
+ attr_accessor :PhoneNumberSet, :TemplateID, :SmsSdkAppid, :Sign, :TemplateParamSet, :ExtendCode, :SessionContext, :SenderId
1125
+
1126
+ def initialize(phonenumberset=nil, templateid=nil, smssdkappid=nil, sign=nil, templateparamset=nil, extendcode=nil, sessioncontext=nil, senderid=nil)
1127
+ @PhoneNumberSet = phonenumberset
1128
+ @TemplateID = templateid
1129
+ @SmsSdkAppid = smssdkappid
1130
+ @Sign = sign
1131
+ @TemplateParamSet = templateparamset
1132
+ @ExtendCode = extendcode
1133
+ @SessionContext = sessioncontext
1134
+ @SenderId = senderid
1135
+ end
1136
+
1137
+ def deserialize(params)
1138
+ @PhoneNumberSet = params['PhoneNumberSet']
1139
+ @TemplateID = params['TemplateID']
1140
+ @SmsSdkAppid = params['SmsSdkAppid']
1141
+ @Sign = params['Sign']
1142
+ @TemplateParamSet = params['TemplateParamSet']
1143
+ @ExtendCode = params['ExtendCode']
1144
+ @SessionContext = params['SessionContext']
1145
+ @SenderId = params['SenderId']
1146
+ end
1147
+ end
1148
+
1149
+ # SendSms返回参数结构体
1150
+ class SendSmsResponse < TencentCloud::Common::AbstractModel
1151
+ # @param SendStatusSet: 短信发送状态。
1152
+ # @type SendStatusSet: Array
1153
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1154
+ # @type RequestId: String
1155
+
1156
+ attr_accessor :SendStatusSet, :RequestId
1157
+
1158
+ def initialize(sendstatusset=nil, requestid=nil)
1159
+ @SendStatusSet = sendstatusset
1160
+ @RequestId = requestid
1161
+ end
1162
+
1163
+ def deserialize(params)
1164
+ unless params['SendStatusSet'].nil?
1165
+ @SendStatusSet = []
1166
+ params['SendStatusSet'].each do |i|
1167
+ sendstatus_tmp = SendStatus.new
1168
+ sendstatus_tmp.deserialize(i)
1169
+ @SendStatusSet << sendstatus_tmp
1170
+ end
1171
+ end
1172
+ @RequestId = params['RequestId']
1173
+ end
1174
+ end
1175
+
1176
+ # 发送短信状态
1177
+ class SendStatus < TencentCloud::Common::AbstractModel
1178
+ # @param SerialNo: 发送流水号。
1179
+ # @type SerialNo: String
1180
+ # @param PhoneNumber: 手机号码,e.164标准,+[国家或地区码][手机号] ,示例如:+8613711112222, 其中前面有一个+号 ,86为国家码,13711112222为手机号。
1181
+ # @type PhoneNumber: String
1182
+ # @param Fee: 计费条数,计费规则请查询 [计费策略](https://cloud.tencent.com/document/product/382/36135)。
1183
+ # @type Fee: Integer
1184
+ # @param SessionContext: 用户Session内容。
1185
+ # @type SessionContext: String
1186
+ # @param Code: 短信请求错误码,具体含义请参考错误码。
1187
+ # @type Code: String
1188
+ # @param Message: 短信请求错误码描述。
1189
+ # @type Message: String
1190
+ # @param IsoCode: 国家码或地区码,例如CN,US等,对于未识别出国家码或者地区码,默认返回DEF,具体支持列表请参考国际/港澳台计费总览。
1191
+ # @type IsoCode: String
1192
+
1193
+ attr_accessor :SerialNo, :PhoneNumber, :Fee, :SessionContext, :Code, :Message, :IsoCode
1194
+
1195
+ def initialize(serialno=nil, phonenumber=nil, fee=nil, sessioncontext=nil, code=nil, message=nil, isocode=nil)
1196
+ @SerialNo = serialno
1197
+ @PhoneNumber = phonenumber
1198
+ @Fee = fee
1199
+ @SessionContext = sessioncontext
1200
+ @Code = code
1201
+ @Message = message
1202
+ @IsoCode = isocode
1203
+ end
1204
+
1205
+ def deserialize(params)
1206
+ @SerialNo = params['SerialNo']
1207
+ @PhoneNumber = params['PhoneNumber']
1208
+ @Fee = params['Fee']
1209
+ @SessionContext = params['SessionContext']
1210
+ @Code = params['Code']
1211
+ @Message = params['Message']
1212
+ @IsoCode = params['IsoCode']
1213
+ end
1214
+ end
1215
+
1216
+ # 发送数据统计响应包体
1217
+ class SendStatusStatistics < TencentCloud::Common::AbstractModel
1218
+ # @param FeeCount: 短信计费条数统计,例如提交成功量为100条,其中有20条是长短信(长度为80字)被拆分成2条,则计费条数为: ```80 * 1 + 20 * 2 = 120``` 条。
1219
+ # @type FeeCount: Integer
1220
+ # @param RequestCount: 短信提交量统计。
1221
+ # @type RequestCount: Integer
1222
+ # @param RequestSuccessCount: 短信提交成功量统计。
1223
+ # @type RequestSuccessCount: Integer
1224
+
1225
+ attr_accessor :FeeCount, :RequestCount, :RequestSuccessCount
1226
+
1227
+ def initialize(feecount=nil, requestcount=nil, requestsuccesscount=nil)
1228
+ @FeeCount = feecount
1229
+ @RequestCount = requestcount
1230
+ @RequestSuccessCount = requestsuccesscount
1231
+ end
1232
+
1233
+ def deserialize(params)
1234
+ @FeeCount = params['FeeCount']
1235
+ @RequestCount = params['RequestCount']
1236
+ @RequestSuccessCount = params['RequestSuccessCount']
1237
+ end
1238
+ end
1239
+
1240
+ # SendStatusStatistics请求参数结构体
1241
+ class SendStatusStatisticsRequest < TencentCloud::Common::AbstractModel
1242
+ # @param StartDateTime: 拉取起始时间,yyyymmddhh 需要拉取的起始时间,精确到小时。
1243
+ # @type StartDateTime: Integer
1244
+ # @param EndDataTime: 结束时间,yyyymmddhh 需要拉取的截止时间,精确到小时
1245
+ # 注:EndDataTime 必须大于 StartDateTime。
1246
+ # @type EndDataTime: Integer
1247
+ # @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
1248
+ # @type SmsSdkAppid: String
1249
+ # @param Limit: 最大上限。
1250
+ # 注:目前固定设置为0。
1251
+ # @type Limit: Integer
1252
+ # @param Offset: 偏移量。
1253
+ # 注:目前固定设置为0。
1254
+ # @type Offset: Integer
1255
+
1256
+ attr_accessor :StartDateTime, :EndDataTime, :SmsSdkAppid, :Limit, :Offset
1257
+
1258
+ def initialize(startdatetime=nil, enddatatime=nil, smssdkappid=nil, limit=nil, offset=nil)
1259
+ @StartDateTime = startdatetime
1260
+ @EndDataTime = enddatatime
1261
+ @SmsSdkAppid = smssdkappid
1262
+ @Limit = limit
1263
+ @Offset = offset
1264
+ end
1265
+
1266
+ def deserialize(params)
1267
+ @StartDateTime = params['StartDateTime']
1268
+ @EndDataTime = params['EndDataTime']
1269
+ @SmsSdkAppid = params['SmsSdkAppid']
1270
+ @Limit = params['Limit']
1271
+ @Offset = params['Offset']
1272
+ end
1273
+ end
1274
+
1275
+ # SendStatusStatistics返回参数结构体
1276
+ class SendStatusStatisticsResponse < TencentCloud::Common::AbstractModel
1277
+ # @param SendStatusStatistics: 发送数据统计响应包体。
1278
+ # @type SendStatusStatistics: :class:`Tencentcloud::Sms.v20190711.models.SendStatusStatistics`
1279
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1280
+ # @type RequestId: String
1281
+
1282
+ attr_accessor :SendStatusStatistics, :RequestId
1283
+
1284
+ def initialize(sendstatusstatistics=nil, requestid=nil)
1285
+ @SendStatusStatistics = sendstatusstatistics
1286
+ @RequestId = requestid
1287
+ end
1288
+
1289
+ def deserialize(params)
1290
+ unless params['SendStatusStatistics'].nil?
1291
+ @SendStatusStatistics = SendStatusStatistics.new
1292
+ @SendStatusStatistics.deserialize(params['SendStatusStatistics'])
1293
+ end
1294
+ @RequestId = params['RequestId']
1295
+ end
1296
+ end
1297
+
1298
+ # 套餐包信息统计响应包体
1299
+ class SmsPackagesStatistics < TencentCloud::Common::AbstractModel
1300
+ # @param PackageCreateTime: 套餐包创建时间,标准时间,例如:2019-10-08 17:18:37。
1301
+ # @type PackageCreateTime: String
1302
+ # @param PackageCreateUnixTime: 套餐包创建时间,UNIX 时间戳(单位:秒)。
1303
+ # @type PackageCreateUnixTime: Integer
1304
+ # @param PackageEffectiveTime: 套餐包生效时间,标准时间,例如:2019-10-08 17:18:37。
1305
+ # @type PackageEffectiveTime: String
1306
+ # @param PackageEffectiveUnixTime: 套餐包生效时间,UNIX 时间戳(单位:秒)。
1307
+ # @type PackageEffectiveUnixTime: Integer
1308
+ # @param PackageExpiredTime: 套餐包过期时间,标准时间,例如:2019-10-08 17:18:37。
1309
+ # @type PackageExpiredTime: String
1310
+ # @param PackageExpiredUnixTime: 套餐包过期时间,UNIX 时间戳(单位:秒)。
1311
+ # @type PackageExpiredUnixTime: Integer
1312
+ # @param AmountOfPackage: 套餐包条数。
1313
+ # @type AmountOfPackage: Integer
1314
+ # @param TypeOfPackage: 0表示赠送套餐包,1表示购买套餐包。
1315
+ # @type TypeOfPackage: Integer
1316
+ # @param PackageId: 套餐包 ID。
1317
+ # @type PackageId: Integer
1318
+ # @param CurrentUsage: 当前使用量。
1319
+ # @type CurrentUsage: Integer
1320
+
1321
+ attr_accessor :PackageCreateTime, :PackageCreateUnixTime, :PackageEffectiveTime, :PackageEffectiveUnixTime, :PackageExpiredTime, :PackageExpiredUnixTime, :AmountOfPackage, :TypeOfPackage, :PackageId, :CurrentUsage
1322
+
1323
+ def initialize(packagecreatetime=nil, packagecreateunixtime=nil, packageeffectivetime=nil, packageeffectiveunixtime=nil, packageexpiredtime=nil, packageexpiredunixtime=nil, amountofpackage=nil, typeofpackage=nil, packageid=nil, currentusage=nil)
1324
+ @PackageCreateTime = packagecreatetime
1325
+ @PackageCreateUnixTime = packagecreateunixtime
1326
+ @PackageEffectiveTime = packageeffectivetime
1327
+ @PackageEffectiveUnixTime = packageeffectiveunixtime
1328
+ @PackageExpiredTime = packageexpiredtime
1329
+ @PackageExpiredUnixTime = packageexpiredunixtime
1330
+ @AmountOfPackage = amountofpackage
1331
+ @TypeOfPackage = typeofpackage
1332
+ @PackageId = packageid
1333
+ @CurrentUsage = currentusage
1334
+ end
1335
+
1336
+ def deserialize(params)
1337
+ @PackageCreateTime = params['PackageCreateTime']
1338
+ @PackageCreateUnixTime = params['PackageCreateUnixTime']
1339
+ @PackageEffectiveTime = params['PackageEffectiveTime']
1340
+ @PackageEffectiveUnixTime = params['PackageEffectiveUnixTime']
1341
+ @PackageExpiredTime = params['PackageExpiredTime']
1342
+ @PackageExpiredUnixTime = params['PackageExpiredUnixTime']
1343
+ @AmountOfPackage = params['AmountOfPackage']
1344
+ @TypeOfPackage = params['TypeOfPackage']
1345
+ @PackageId = params['PackageId']
1346
+ @CurrentUsage = params['CurrentUsage']
1347
+ end
1348
+ end
1349
+
1350
+ # SmsPackagesStatistics请求参数结构体
1351
+ class SmsPackagesStatisticsRequest < TencentCloud::Common::AbstractModel
1352
+ # @param SmsSdkAppid: 短信SdkAppid在 [短信控制台](https://console.cloud.tencent.com/smsv2) 添加应用后生成的实际SdkAppid,示例如1400006666。
1353
+ # @type SmsSdkAppid: String
1354
+ # @param Limit: 最大上限(需要拉取的套餐包个数)。
1355
+ # @type Limit: Integer
1356
+ # @param Offset: 偏移量。
1357
+ # 注:目前固定设置为0。
1358
+ # @type Offset: Integer
1359
+
1360
+ attr_accessor :SmsSdkAppid, :Limit, :Offset
1361
+
1362
+ def initialize(smssdkappid=nil, limit=nil, offset=nil)
1363
+ @SmsSdkAppid = smssdkappid
1364
+ @Limit = limit
1365
+ @Offset = offset
1366
+ end
1367
+
1368
+ def deserialize(params)
1369
+ @SmsSdkAppid = params['SmsSdkAppid']
1370
+ @Limit = params['Limit']
1371
+ @Offset = params['Offset']
1372
+ end
1373
+ end
1374
+
1375
+ # SmsPackagesStatistics返回参数结构体
1376
+ class SmsPackagesStatisticsResponse < TencentCloud::Common::AbstractModel
1377
+ # @param SmsPackagesStatisticsSet: 发送数据统计响应包体。
1378
+ # @type SmsPackagesStatisticsSet: Array
1379
+ # @param RequestId: 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。
1380
+ # @type RequestId: String
1381
+
1382
+ attr_accessor :SmsPackagesStatisticsSet, :RequestId
1383
+
1384
+ def initialize(smspackagesstatisticsset=nil, requestid=nil)
1385
+ @SmsPackagesStatisticsSet = smspackagesstatisticsset
1386
+ @RequestId = requestid
1387
+ end
1388
+
1389
+ def deserialize(params)
1390
+ unless params['SmsPackagesStatisticsSet'].nil?
1391
+ @SmsPackagesStatisticsSet = []
1392
+ params['SmsPackagesStatisticsSet'].each do |i|
1393
+ smspackagesstatistics_tmp = SmsPackagesStatistics.new
1394
+ smspackagesstatistics_tmp.deserialize(i)
1395
+ @SmsPackagesStatisticsSet << smspackagesstatistics_tmp
1396
+ end
1397
+ end
1398
+ @RequestId = params['RequestId']
1399
+ end
1400
+ end
1401
+
1402
+ end
1403
+ end
1404
+ end
1405
+