tencentcloud-sdk-python-intl-en 3.0.1075__py2.py3-none-any.whl → 3.0.1076__py2.py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Potentially problematic release.


This version of tencentcloud-sdk-python-intl-en might be problematic. Click here for more details.

Files changed (122) hide show
  1. tencentcloud/__init__.py +1 -1
  2. tencentcloud/advisor/v20200721/models.py +120 -0
  3. tencentcloud/aiart/v20221229/models.py +95 -0
  4. tencentcloud/ams/v20201229/models.py +432 -0
  5. tencentcloud/antiddos/v20200309/models.py +2806 -0
  6. tencentcloud/apigateway/v20180808/models.py +3945 -0
  7. tencentcloud/autoscaling/v20180419/models.py +2449 -5
  8. tencentcloud/batch/v20170312/models.py +1566 -0
  9. tencentcloud/billing/v20180709/models.py +2418 -0
  10. tencentcloud/cam/v20190116/models.py +1697 -0
  11. tencentcloud/captcha/v20190722/models.py +70 -0
  12. tencentcloud/car/v20220110/models.py +803 -0
  13. tencentcloud/cbs/v20170312/models.py +1245 -0
  14. tencentcloud/ccc/v20200210/models.py +1949 -1
  15. tencentcloud/cdb/v20170320/models.py +4821 -0
  16. tencentcloud/cdn/v20180606/models.py +4870 -8
  17. tencentcloud/cdwdoris/v20211228/models.py +3337 -0
  18. tencentcloud/cfg/v20210820/models.py +1194 -0
  19. tencentcloud/cfs/v20190719/models.py +1178 -0
  20. tencentcloud/cfw/v20190904/models.py +2378 -0
  21. tencentcloud/chdfs/v20201112/models.py +513 -0
  22. tencentcloud/ciam/v20210420/models.py +49 -0
  23. tencentcloud/ciam/v20220331/models.py +789 -0
  24. tencentcloud/ckafka/v20190819/models.py +2576 -0
  25. tencentcloud/clb/v20180317/models.py +3220 -1
  26. tencentcloud/cloudaudit/v20190319/models.py +519 -0
  27. tencentcloud/cls/v20201016/models.py +3652 -1
  28. tencentcloud/cmq/v20190304/models.py +571 -0
  29. tencentcloud/controlcenter/v20230110/models.py +15 -0
  30. tencentcloud/csip/v20221121/models.py +2881 -2
  31. tencentcloud/cvm/v20170312/models.py +2827 -0
  32. tencentcloud/cwp/v20180228/models.py +16412 -0
  33. tencentcloud/cynosdb/v20190107/models.py +4263 -0
  34. tencentcloud/dataintegration/v20220613/models.py +18 -0
  35. tencentcloud/dayu/v20180709/models.py +3541 -12
  36. tencentcloud/dbbrain/v20191016/models.py +1056 -0
  37. tencentcloud/dbbrain/v20210527/models.py +1763 -0
  38. tencentcloud/dc/v20180410/models.py +767 -0
  39. tencentcloud/dcdb/v20180411/models.py +2335 -0
  40. tencentcloud/dlc/v20210125/models.py +3985 -5
  41. tencentcloud/dms/v20200819/models.py +51 -0
  42. tencentcloud/dnspod/v20210323/models.py +1286 -0
  43. tencentcloud/domain/v20180808/models.py +855 -0
  44. tencentcloud/dts/v20180330/models.py +791 -0
  45. tencentcloud/dts/v20211206/models.py +2317 -1
  46. tencentcloud/eb/v20210416/models.py +858 -0
  47. tencentcloud/ecdn/v20191012/models.py +811 -0
  48. tencentcloud/ecm/v20190719/models.py +3972 -1
  49. tencentcloud/eiam/v20210420/models.py +1265 -0
  50. tencentcloud/emr/v20190103/models.py +2926 -7
  51. tencentcloud/es/v20180416/models.py +1523 -0
  52. tencentcloud/facefusion/v20220927/models.py +211 -0
  53. tencentcloud/faceid/v20180301/models.py +2071 -0
  54. tencentcloud/gaap/v20180529/models.py +3103 -8
  55. tencentcloud/gme/v20180711/models.py +388 -0
  56. tencentcloud/gpm/v20200820/models.py +674 -0
  57. tencentcloud/gse/v20191112/models.py +972 -0
  58. tencentcloud/iai/v20200303/models.py +1430 -0
  59. tencentcloud/ims/v20201229/models.py +329 -0
  60. tencentcloud/intlpartnersmgt/v20220928/models.py +988 -0
  61. tencentcloud/iotcloud/v20210408/models.py +585 -0
  62. tencentcloud/ip/v20210409/models.py +178 -0
  63. tencentcloud/kms/v20190118/models.py +869 -0
  64. tencentcloud/lcic/v20220817/models.py +1658 -0
  65. tencentcloud/lighthouse/v20200324/models.py +2088 -0
  66. tencentcloud/live/v20180801/models.py +4287 -0
  67. tencentcloud/mariadb/v20170312/models.py +1905 -0
  68. tencentcloud/mdc/v20200828/models.py +1104 -0
  69. tencentcloud/mdl/v20200326/models.py +1911 -1
  70. tencentcloud/mdp/v20200527/models.py +452 -0
  71. tencentcloud/mongodb/v20190725/models.py +1234 -0
  72. tencentcloud/monitor/v20180724/models.py +5798 -2
  73. tencentcloud/mps/v20190612/models.py +8135 -0
  74. tencentcloud/msp/v20180319/models.py +183 -0
  75. tencentcloud/ocr/v20181119/models.py +3160 -1
  76. tencentcloud/omics/v20221128/models.py +1086 -0
  77. tencentcloud/organization/v20181225/models.py +285 -0
  78. tencentcloud/organization/v20210331/models.py +2267 -0
  79. tencentcloud/postgres/v20170312/models.py +3248 -0
  80. tencentcloud/privatedns/v20201028/errorcodes.py +34 -1
  81. tencentcloud/privatedns/v20201028/models.py +1700 -0
  82. tencentcloud/privatedns/v20201028/privatedns_client.py +115 -0
  83. tencentcloud/redis/v20180412/models.py +3298 -3
  84. tencentcloud/rum/v20210622/models.py +2114 -0
  85. tencentcloud/scf/v20180416/models.py +1561 -0
  86. tencentcloud/ses/v20201002/models.py +649 -0
  87. tencentcloud/sms/v20190711/models.py +575 -0
  88. tencentcloud/sms/v20210111/models.py +593 -0
  89. tencentcloud/sqlserver/v20180328/models.py +2780 -0
  90. tencentcloud/ssl/v20191205/models.py +2267 -0
  91. tencentcloud/ssm/v20190923/models.py +678 -0
  92. tencentcloud/sts/v20180813/models.py +161 -0
  93. tencentcloud/tag/v20180813/models.py +784 -0
  94. tencentcloud/tat/v20201028/models.py +806 -0
  95. tencentcloud/tcaplusdb/v20190823/models.py +1860 -0
  96. tencentcloud/tchd/v20230306/models.py +41 -0
  97. tencentcloud/tcmpp/v20240801/models.py +3761 -1
  98. tencentcloud/tcr/v20190924/models.py +1851 -0
  99. tencentcloud/tcss/v20201101/models.py +12523 -0
  100. tencentcloud/tdid/v20210519/models.py +1258 -0
  101. tencentcloud/tdmq/v20200217/models.py +3495 -0
  102. tencentcloud/tem/v20201221/models.py +803 -0
  103. tencentcloud/tem/v20210701/models.py +2551 -1
  104. tencentcloud/teo/v20220106/models.py +4731 -0
  105. tencentcloud/teo/v20220901/models.py +6066 -0
  106. tencentcloud/tiw/v20190919/models.py +1678 -1
  107. tencentcloud/tke/v20180525/models.py +3662 -0
  108. tencentcloud/tms/v20201229/models.py +176 -0
  109. tencentcloud/tmt/v20180321/models.py +65 -0
  110. tencentcloud/trtc/v20190722/models.py +1698 -8
  111. tencentcloud/tts/v20190823/models.py +72 -0
  112. tencentcloud/vm/v20201229/models.py +568 -0
  113. tencentcloud/vm/v20210922/models.py +636 -0
  114. tencentcloud/vod/v20180717/models.py +13490 -1
  115. tencentcloud/vpc/v20170312/models.py +6543 -1
  116. tencentcloud/waf/v20180125/models.py +4814 -0
  117. tencentcloud/wedata/v20210820/models.py +12594 -0
  118. tencentcloud/yunjing/v20180228/models.py +1867 -0
  119. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/METADATA +1 -1
  120. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/RECORD +122 -122
  121. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/WHEEL +0 -0
  122. {tencentcloud_sdk_python_intl_en-3.0.1075.dist-info → tencentcloud_sdk_python_intl_en-3.0.1076.dist-info}/top_level.txt +0 -0
@@ -32,6 +32,9 @@ class AddSignStatus(AbstractModel):
32
32
 
33
33
  @property
34
34
  def SignId(self):
35
+ """Signature ID.
36
+ :rtype: int
37
+ """
35
38
  return self._SignId
36
39
 
37
40
  @SignId.setter
@@ -110,6 +113,10 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
110
113
 
111
114
  @property
112
115
  def SignName(self):
116
+ """Signature name.
117
+ Note: you cannot apply for an approved or pending signature again.
118
+ :rtype: str
119
+ """
113
120
  return self._SignName
114
121
 
115
122
  @SignName.setter
@@ -118,6 +125,17 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
118
125
 
119
126
  @property
120
127
  def SignType(self):
128
+ """Signature type. Each of these types is followed by their `DocumentType` (identity certificate type) option:
129
+ 0: company. Valid values of `DocumentType` include 0 and 1.
130
+ 1: app. Valid values of `DocumentType` include 0, 1, 2, 3, and 4.
131
+ 2: website. Valid values of `DocumentType` include 0, 1, 2, 3, and 5.
132
+ 3: WeChat Official Account. Valid values of `DocumentType` include 0, 1, 2, 3, and 8.
133
+ 4: trademark. Valid values of `DocumentType` include 7.
134
+ 5: government/public institution/other. Valid values of `DocumentType` include 2 and 3.
135
+ 6: WeChat Mini Program. Valid values of `DocumentType` include 0, 1, 2, 3, and 6.
136
+ Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail.
137
+ :rtype: int
138
+ """
121
139
  return self._SignType
122
140
 
123
141
  @SignType.setter
@@ -126,6 +144,18 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
126
144
 
127
145
  @property
128
146
  def DocumentType(self):
147
+ """Identity certificate type:
148
+ 0: three-in-one licence.
149
+ 1: business license.
150
+ 2: organization code certificate.
151
+ 3: social credit code certificate.
152
+ 4: screenshot of application backend management (for personal app).
153
+ 5: screenshot of website ICP filing backend (for personal website).
154
+ 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program).
155
+ 7: trademark registration certificate.
156
+ 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account).
157
+ :rtype: int
158
+ """
129
159
  return self._DocumentType
130
160
 
131
161
  @DocumentType.setter
@@ -134,6 +164,11 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
134
164
 
135
165
  @property
136
166
  def International(self):
167
+ """Whether it is Global SMS:
168
+ 0: Mainland China SMS.
169
+ 1: Global SMS.
170
+ :rtype: int
171
+ """
137
172
  return self._International
138
173
 
139
174
  @International.setter
@@ -142,6 +177,11 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
142
177
 
143
178
  @property
144
179
  def SignPurpose(self):
180
+ """Signature purpose:
181
+ 0: for personal use.
182
+ 1: for others.
183
+ :rtype: int
184
+ """
145
185
  return self._SignPurpose
146
186
 
147
187
  @SignPurpose.setter
@@ -150,6 +190,9 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
150
190
 
151
191
  @property
152
192
  def ProofImage(self):
193
+ """You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
194
+ :rtype: str
195
+ """
153
196
  return self._ProofImage
154
197
 
155
198
  @ProofImage.setter
@@ -158,6 +201,11 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
158
201
 
159
202
  @property
160
203
  def CommissionImage(self):
204
+ """Power of attorney, which should be submitted if `SignPurpose` is for use by others.
205
+ You should Base64-encode the image first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
206
+ Note: this field will take effect only when `SignPurpose` is 1 (for user by others).
207
+ :rtype: str
208
+ """
161
209
  return self._CommissionImage
162
210
 
163
211
  @CommissionImage.setter
@@ -166,6 +214,9 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
166
214
 
167
215
  @property
168
216
  def Remark(self):
217
+ """Signature application remarks.
218
+ :rtype: str
219
+ """
169
220
  return self._Remark
170
221
 
171
222
  @Remark.setter
@@ -209,6 +260,9 @@ class AddSmsSignResponse(AbstractModel):
209
260
 
210
261
  @property
211
262
  def AddSignStatus(self):
263
+ """Signature addition response
264
+ :rtype: :class:`tencentcloud.sms.v20210111.models.AddSignStatus`
265
+ """
212
266
  return self._AddSignStatus
213
267
 
214
268
  @AddSignStatus.setter
@@ -217,6 +271,9 @@ class AddSmsSignResponse(AbstractModel):
217
271
 
218
272
  @property
219
273
  def RequestId(self):
274
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
275
+ :rtype: str
276
+ """
220
277
  return self._RequestId
221
278
 
222
279
  @RequestId.setter
@@ -260,6 +317,9 @@ Note: To further improve the quality of SMS service and increase the approval ra
260
317
 
261
318
  @property
262
319
  def TemplateName(self):
320
+ """Template name.
321
+ :rtype: str
322
+ """
263
323
  return self._TemplateName
264
324
 
265
325
  @TemplateName.setter
@@ -268,6 +328,9 @@ Note: To further improve the quality of SMS service and increase the approval ra
268
328
 
269
329
  @property
270
330
  def TemplateContent(self):
331
+ """Template content.
332
+ :rtype: str
333
+ """
271
334
  return self._TemplateContent
272
335
 
273
336
  @TemplateContent.setter
@@ -276,6 +339,10 @@ Note: To further improve the quality of SMS service and increase the approval ra
276
339
 
277
340
  @property
278
341
  def SmsType(self):
342
+ """SMS type. 1: Marketing SMS, 2: Notification SMS, 3: OTP SMS.
343
+ Note: To further improve the quality of SMS service and increase the approval rate of SMS templates, Tencent Cloud SMS template types will be optimized to "OTP", "Notification", and "Marketing" from May 16, 2024. You can Refer to [Optimization of Tencent Cloud SMS Template Types](https://www.tencentcloud.com/document/product/382/60410). Customers who newly register for SMS service must strictly refer to the new SMS type to apply for SMS template.
344
+ :rtype: int
345
+ """
279
346
  return self._SmsType
280
347
 
281
348
  @SmsType.setter
@@ -284,6 +351,11 @@ Note: To further improve the quality of SMS service and increase the approval ra
284
351
 
285
352
  @property
286
353
  def International(self):
354
+ """Whether it is Global SMS:
355
+ 0: Mainland China SMS.
356
+ 1: Global SMS.
357
+ :rtype: int
358
+ """
287
359
  return self._International
288
360
 
289
361
  @International.setter
@@ -292,6 +364,9 @@ Note: To further improve the quality of SMS service and increase the approval ra
292
364
 
293
365
  @property
294
366
  def Remark(self):
367
+ """Template remarks, such as reason for application and use case.
368
+ :rtype: str
369
+ """
295
370
  return self._Remark
296
371
 
297
372
  @Remark.setter
@@ -332,6 +407,9 @@ class AddSmsTemplateResponse(AbstractModel):
332
407
 
333
408
  @property
334
409
  def AddTemplateStatus(self):
410
+ """SMS template addition response body
411
+ :rtype: :class:`tencentcloud.sms.v20210111.models.AddTemplateStatus`
412
+ """
335
413
  return self._AddTemplateStatus
336
414
 
337
415
  @AddTemplateStatus.setter
@@ -340,6 +418,9 @@ class AddSmsTemplateResponse(AbstractModel):
340
418
 
341
419
  @property
342
420
  def RequestId(self):
421
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
422
+ :rtype: str
423
+ """
343
424
  return self._RequestId
344
425
 
345
426
  @RequestId.setter
@@ -368,6 +449,9 @@ class AddTemplateStatus(AbstractModel):
368
449
 
369
450
  @property
370
451
  def TemplateId(self):
452
+ """Template ID.
453
+ :rtype: str
454
+ """
371
455
  return self._TemplateId
372
456
 
373
457
  @TemplateId.setter
@@ -425,6 +509,9 @@ class CallbackStatusStatistics(AbstractModel):
425
509
 
426
510
  @property
427
511
  def CallbackCount(self):
512
+ """Messages with receipt.
513
+ :rtype: int
514
+ """
428
515
  return self._CallbackCount
429
516
 
430
517
  @CallbackCount.setter
@@ -433,6 +520,9 @@ class CallbackStatusStatistics(AbstractModel):
433
520
 
434
521
  @property
435
522
  def RequestSuccessCount(self):
523
+ """Successfully submitted SMS messages.
524
+ :rtype: int
525
+ """
436
526
  return self._RequestSuccessCount
437
527
 
438
528
  @RequestSuccessCount.setter
@@ -441,6 +531,9 @@ class CallbackStatusStatistics(AbstractModel):
441
531
 
442
532
  @property
443
533
  def CallbackFailCount(self):
534
+ """Failed receipts.
535
+ :rtype: int
536
+ """
444
537
  return self._CallbackFailCount
445
538
 
446
539
  @CallbackFailCount.setter
@@ -449,6 +542,9 @@ class CallbackStatusStatistics(AbstractModel):
449
542
 
450
543
  @property
451
544
  def CallbackSuccessCount(self):
545
+ """Successful receipts.
546
+ :rtype: int
547
+ """
452
548
  return self._CallbackSuccessCount
453
549
 
454
550
  @CallbackSuccessCount.setter
@@ -457,6 +553,9 @@ class CallbackStatusStatistics(AbstractModel):
457
553
 
458
554
  @property
459
555
  def InternalErrorCount(self):
556
+ """Carrier's internal error.
557
+ :rtype: int
558
+ """
460
559
  return self._InternalErrorCount
461
560
 
462
561
  @InternalErrorCount.setter
@@ -465,6 +564,9 @@ class CallbackStatusStatistics(AbstractModel):
465
564
 
466
565
  @property
467
566
  def InvalidNumberCount(self):
567
+ """Invalid numbers.
568
+ :rtype: int
569
+ """
468
570
  return self._InvalidNumberCount
469
571
 
470
572
  @InvalidNumberCount.setter
@@ -473,6 +575,9 @@ class CallbackStatusStatistics(AbstractModel):
473
575
 
474
576
  @property
475
577
  def ShutdownErrorCount(self):
578
+ """Errors such as out-of-service or power-off.
579
+ :rtype: int
580
+ """
476
581
  return self._ShutdownErrorCount
477
582
 
478
583
  @ShutdownErrorCount.setter
@@ -481,6 +586,9 @@ class CallbackStatusStatistics(AbstractModel):
481
586
 
482
587
  @property
483
588
  def BlackListCount(self):
589
+ """Blocked mobile numbers.
590
+ :rtype: int
591
+ """
484
592
  return self._BlackListCount
485
593
 
486
594
  @BlackListCount.setter
@@ -489,6 +597,9 @@ class CallbackStatusStatistics(AbstractModel):
489
597
 
490
598
  @property
491
599
  def FrequencyLimitCount(self):
600
+ """Carrier rate limit hits.
601
+ :rtype: int
602
+ """
492
603
  return self._FrequencyLimitCount
493
604
 
494
605
  @FrequencyLimitCount.setter
@@ -545,6 +656,9 @@ Note: this parameter is currently fixed at 0.
545
656
 
546
657
  @property
547
658
  def BeginTime(self):
659
+ """Start time in the format of `yyyymmddhh` accurate to the hour, such as 2021050113 (13:00 on May 1, 2021).
660
+ :rtype: str
661
+ """
548
662
  return self._BeginTime
549
663
 
550
664
  @BeginTime.setter
@@ -553,6 +667,10 @@ Note: this parameter is currently fixed at 0.
553
667
 
554
668
  @property
555
669
  def EndTime(self):
670
+ """End time in the format of `yyyymmddhh` accurate to the hour, such as 2021050118 (18:00 on May 1, 2021).
671
+ Note: `EndTime` must be after `BeginTime`, and the difference should not exceed 32 days.
672
+ :rtype: str
673
+ """
556
674
  return self._EndTime
557
675
 
558
676
  @EndTime.setter
@@ -561,6 +679,9 @@ Note: this parameter is currently fixed at 0.
561
679
 
562
680
  @property
563
681
  def SmsSdkAppId(self):
682
+ """The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
683
+ :rtype: str
684
+ """
564
685
  return self._SmsSdkAppId
565
686
 
566
687
  @SmsSdkAppId.setter
@@ -569,6 +690,10 @@ Note: this parameter is currently fixed at 0.
569
690
 
570
691
  @property
571
692
  def Limit(self):
693
+ """Upper limit.
694
+ Note: this parameter is currently fixed at 0.
695
+ :rtype: int
696
+ """
572
697
  return self._Limit
573
698
 
574
699
  @Limit.setter
@@ -577,6 +702,10 @@ Note: this parameter is currently fixed at 0.
577
702
 
578
703
  @property
579
704
  def Offset(self):
705
+ """Offset.
706
+ Note: this parameter is currently fixed at 0.
707
+ :rtype: int
708
+ """
580
709
  return self._Offset
581
710
 
582
711
  @Offset.setter
@@ -617,6 +746,9 @@ class CallbackStatusStatisticsResponse(AbstractModel):
617
746
 
618
747
  @property
619
748
  def CallbackStatusStatistics(self):
749
+ """Receipt statistics response body.
750
+ :rtype: :class:`tencentcloud.sms.v20210111.models.CallbackStatusStatistics`
751
+ """
620
752
  return self._CallbackStatusStatistics
621
753
 
622
754
  @CallbackStatusStatistics.setter
@@ -625,6 +757,9 @@ class CallbackStatusStatisticsResponse(AbstractModel):
625
757
 
626
758
  @property
627
759
  def RequestId(self):
760
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
761
+ :rtype: str
762
+ """
628
763
  return self._RequestId
629
764
 
630
765
  @RequestId.setter
@@ -656,6 +791,9 @@ class DeleteSignStatus(AbstractModel):
656
791
 
657
792
  @property
658
793
  def DeleteStatus(self):
794
+ """Deletion status information.
795
+ :rtype: str
796
+ """
659
797
  return self._DeleteStatus
660
798
 
661
799
  @DeleteStatus.setter
@@ -664,6 +802,9 @@ class DeleteSignStatus(AbstractModel):
664
802
 
665
803
  @property
666
804
  def DeleteTime(self):
805
+ """Deleted time in seconds in the format of UNIX timestamp.
806
+ :rtype: int
807
+ """
667
808
  return self._DeleteTime
668
809
 
669
810
  @DeleteTime.setter
@@ -698,6 +839,9 @@ class DeleteSmsSignRequest(AbstractModel):
698
839
 
699
840
  @property
700
841
  def SignId(self):
842
+ """ID of the signature to be deleted.
843
+ :rtype: int
844
+ """
701
845
  return self._SignId
702
846
 
703
847
  @SignId.setter
@@ -734,6 +878,9 @@ class DeleteSmsSignResponse(AbstractModel):
734
878
 
735
879
  @property
736
880
  def DeleteSignStatus(self):
881
+ """Signature deletion response
882
+ :rtype: :class:`tencentcloud.sms.v20210111.models.DeleteSignStatus`
883
+ """
737
884
  return self._DeleteSignStatus
738
885
 
739
886
  @DeleteSignStatus.setter
@@ -742,6 +889,9 @@ class DeleteSmsSignResponse(AbstractModel):
742
889
 
743
890
  @property
744
891
  def RequestId(self):
892
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
893
+ :rtype: str
894
+ """
745
895
  return self._RequestId
746
896
 
747
897
  @RequestId.setter
@@ -770,6 +920,9 @@ class DeleteSmsTemplateRequest(AbstractModel):
770
920
 
771
921
  @property
772
922
  def TemplateId(self):
923
+ """ID of the template to be deleted.
924
+ :rtype: int
925
+ """
773
926
  return self._TemplateId
774
927
 
775
928
  @TemplateId.setter
@@ -806,6 +959,9 @@ class DeleteSmsTemplateResponse(AbstractModel):
806
959
 
807
960
  @property
808
961
  def DeleteTemplateStatus(self):
962
+ """Template deletion response
963
+ :rtype: :class:`tencentcloud.sms.v20210111.models.DeleteTemplateStatus`
964
+ """
809
965
  return self._DeleteTemplateStatus
810
966
 
811
967
  @DeleteTemplateStatus.setter
@@ -814,6 +970,9 @@ class DeleteSmsTemplateResponse(AbstractModel):
814
970
 
815
971
  @property
816
972
  def RequestId(self):
973
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
974
+ :rtype: str
975
+ """
817
976
  return self._RequestId
818
977
 
819
978
  @RequestId.setter
@@ -845,6 +1004,9 @@ class DeleteTemplateStatus(AbstractModel):
845
1004
 
846
1005
  @property
847
1006
  def DeleteStatus(self):
1007
+ """Deletion status information.
1008
+ :rtype: str
1009
+ """
848
1010
  return self._DeleteStatus
849
1011
 
850
1012
  @DeleteStatus.setter
@@ -853,6 +1015,9 @@ class DeleteTemplateStatus(AbstractModel):
853
1015
 
854
1016
  @property
855
1017
  def DeleteTime(self):
1018
+ """Deleted time in seconds in the format of UNIX timestamp.
1019
+ :rtype: int
1020
+ """
856
1021
  return self._DeleteTime
857
1022
 
858
1023
  @DeleteTime.setter
@@ -888,6 +1053,10 @@ Take the number +8613711112222 as an example. “86” is the country code (with
888
1053
 
889
1054
  @property
890
1055
  def PhoneNumberSet(self):
1056
+ """A parameter used to query mobile numbers in E.164 format (+[country/region code][subscriber number]). Up to 200 mobile numbers can be queried at a time.
1057
+ Take the number +8613711112222 as an example. “86” is the country code (with a “+” sign in its front) and “13711112222” is the subscriber number.
1058
+ :rtype: list of str
1059
+ """
891
1060
  return self._PhoneNumberSet
892
1061
 
893
1062
  @PhoneNumberSet.setter
@@ -924,6 +1093,9 @@ class DescribePhoneNumberInfoResponse(AbstractModel):
924
1093
 
925
1094
  @property
926
1095
  def PhoneNumberInfoSet(self):
1096
+ """A parameter used to obtain mobile number information.
1097
+ :rtype: list of PhoneNumberInfo
1098
+ """
927
1099
  return self._PhoneNumberInfoSet
928
1100
 
929
1101
  @PhoneNumberInfoSet.setter
@@ -932,6 +1104,9 @@ class DescribePhoneNumberInfoResponse(AbstractModel):
932
1104
 
933
1105
  @property
934
1106
  def RequestId(self):
1107
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1108
+ :rtype: str
1109
+ """
935
1110
  return self._RequestId
936
1111
 
937
1112
  @RequestId.setter
@@ -979,6 +1154,9 @@ class DescribeSignListStatus(AbstractModel):
979
1154
 
980
1155
  @property
981
1156
  def SignId(self):
1157
+ """Signature ID.
1158
+ :rtype: int
1159
+ """
982
1160
  return self._SignId
983
1161
 
984
1162
  @SignId.setter
@@ -987,6 +1165,9 @@ class DescribeSignListStatus(AbstractModel):
987
1165
 
988
1166
  @property
989
1167
  def International(self):
1168
+ """Whether it is Global SMS. 0: Mainland China SMS; 1: Global SMS.
1169
+ :rtype: int
1170
+ """
990
1171
  return self._International
991
1172
 
992
1173
  @International.setter
@@ -995,6 +1176,10 @@ class DescribeSignListStatus(AbstractModel):
995
1176
 
996
1177
  @property
997
1178
  def StatusCode(self):
1179
+ """Signature application status. Valid values: 0: approved; 1: under review.
1180
+ -1: application rejected or failed.
1181
+ :rtype: int
1182
+ """
998
1183
  return self._StatusCode
999
1184
 
1000
1185
  @StatusCode.setter
@@ -1003,6 +1188,9 @@ class DescribeSignListStatus(AbstractModel):
1003
1188
 
1004
1189
  @property
1005
1190
  def ReviewReply(self):
1191
+ """Review reply, i.e., response given by the reviewer, which is usually the reason for rejection.
1192
+ :rtype: str
1193
+ """
1006
1194
  return self._ReviewReply
1007
1195
 
1008
1196
  @ReviewReply.setter
@@ -1011,6 +1199,9 @@ class DescribeSignListStatus(AbstractModel):
1011
1199
 
1012
1200
  @property
1013
1201
  def SignName(self):
1202
+ """Signature name.
1203
+ :rtype: str
1204
+ """
1014
1205
  return self._SignName
1015
1206
 
1016
1207
  @SignName.setter
@@ -1019,6 +1210,9 @@ class DescribeSignListStatus(AbstractModel):
1019
1210
 
1020
1211
  @property
1021
1212
  def CreateTime(self):
1213
+ """Application submission time in the format of UNIX timestamp in seconds.
1214
+ :rtype: int
1215
+ """
1022
1216
  return self._CreateTime
1023
1217
 
1024
1218
  @CreateTime.setter
@@ -1063,6 +1257,10 @@ Note: the maximum length of the array is 100 by default.
1063
1257
 
1064
1258
  @property
1065
1259
  def SignIdSet(self):
1260
+ """Signature ID array.
1261
+ Note: the maximum length of the array is 100 by default.
1262
+ :rtype: list of int non-negative
1263
+ """
1066
1264
  return self._SignIdSet
1067
1265
 
1068
1266
  @SignIdSet.setter
@@ -1071,6 +1269,11 @@ Note: the maximum length of the array is 100 by default.
1071
1269
 
1072
1270
  @property
1073
1271
  def International(self):
1272
+ """Whether it is Global SMS:
1273
+ 0: Mainland China SMS.
1274
+ 1: Global SMS.
1275
+ :rtype: int
1276
+ """
1074
1277
  return self._International
1075
1278
 
1076
1279
  @International.setter
@@ -1108,6 +1311,9 @@ class DescribeSmsSignListResponse(AbstractModel):
1108
1311
 
1109
1312
  @property
1110
1313
  def DescribeSignListStatusSet(self):
1314
+ """Response for getting signature information
1315
+ :rtype: list of DescribeSignListStatus
1316
+ """
1111
1317
  return self._DescribeSignListStatusSet
1112
1318
 
1113
1319
  @DescribeSignListStatusSet.setter
@@ -1116,6 +1322,9 @@ class DescribeSmsSignListResponse(AbstractModel):
1116
1322
 
1117
1323
  @property
1118
1324
  def RequestId(self):
1325
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1326
+ :rtype: str
1327
+ """
1119
1328
  return self._RequestId
1120
1329
 
1121
1330
  @RequestId.setter
@@ -1161,6 +1370,11 @@ Note: it is 0 by default and is enabled when `TemplateIdSet` is empty.
1161
1370
 
1162
1371
  @property
1163
1372
  def International(self):
1373
+ """Whether it is Global SMS:
1374
+ 0: Mainland China SMS.
1375
+ 1: Global SMS.
1376
+ :rtype: int
1377
+ """
1164
1378
  return self._International
1165
1379
 
1166
1380
  @International.setter
@@ -1169,6 +1383,10 @@ Note: it is 0 by default and is enabled when `TemplateIdSet` is empty.
1169
1383
 
1170
1384
  @property
1171
1385
  def TemplateIdSet(self):
1386
+ """Array of template IDs. If the array is empty, the template list information will be queried by default. You need to use the `Limit` and `Offset` fields to set the query range.
1387
+ <dx-alert infotype="notice" title="Note">The max array length is 100 by default.</dx-alert>
1388
+ :rtype: list of int non-negative
1389
+ """
1172
1390
  return self._TemplateIdSet
1173
1391
 
1174
1392
  @TemplateIdSet.setter
@@ -1177,6 +1395,10 @@ Note: it is 0 by default and is enabled when `TemplateIdSet` is empty.
1177
1395
 
1178
1396
  @property
1179
1397
  def Limit(self):
1398
+ """Upper limit. Maximum value: 100.
1399
+ Note: it is 0 by default and is enabled when `TemplateIdSet` is empty.
1400
+ :rtype: int
1401
+ """
1180
1402
  return self._Limit
1181
1403
 
1182
1404
  @Limit.setter
@@ -1185,6 +1407,10 @@ Note: it is 0 by default and is enabled when `TemplateIdSet` is empty.
1185
1407
 
1186
1408
  @property
1187
1409
  def Offset(self):
1410
+ """Offset.
1411
+ Note: it is 0 by default and is enabled when `TemplateIdSet` is empty.
1412
+ :rtype: int
1413
+ """
1188
1414
  return self._Offset
1189
1415
 
1190
1416
  @Offset.setter
@@ -1224,6 +1450,9 @@ class DescribeSmsTemplateListResponse(AbstractModel):
1224
1450
 
1225
1451
  @property
1226
1452
  def DescribeTemplateStatusSet(self):
1453
+ """Response for getting SMS template information
1454
+ :rtype: list of DescribeTemplateListStatus
1455
+ """
1227
1456
  return self._DescribeTemplateStatusSet
1228
1457
 
1229
1458
  @DescribeTemplateStatusSet.setter
@@ -1232,6 +1461,9 @@ class DescribeSmsTemplateListResponse(AbstractModel):
1232
1461
 
1233
1462
  @property
1234
1463
  def RequestId(self):
1464
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1465
+ :rtype: str
1466
+ """
1235
1467
  return self._RequestId
1236
1468
 
1237
1469
  @RequestId.setter
@@ -1281,6 +1513,9 @@ class DescribeTemplateListStatus(AbstractModel):
1281
1513
 
1282
1514
  @property
1283
1515
  def TemplateId(self):
1516
+ """Template ID.
1517
+ :rtype: int
1518
+ """
1284
1519
  return self._TemplateId
1285
1520
 
1286
1521
  @TemplateId.setter
@@ -1289,6 +1524,9 @@ class DescribeTemplateListStatus(AbstractModel):
1289
1524
 
1290
1525
  @property
1291
1526
  def International(self):
1527
+ """Whether it is Global SMS. 0: Mainland China SMS; 1: Global SMS.
1528
+ :rtype: int
1529
+ """
1292
1530
  return self._International
1293
1531
 
1294
1532
  @International.setter
@@ -1297,6 +1535,9 @@ class DescribeTemplateListStatus(AbstractModel):
1297
1535
 
1298
1536
  @property
1299
1537
  def StatusCode(self):
1538
+ """Template application status. Valid values: 0: approved and effective; 1: under review; 2: approved but to be effective; -1: application rejected or failed.
1539
+ :rtype: int
1540
+ """
1300
1541
  return self._StatusCode
1301
1542
 
1302
1543
  @StatusCode.setter
@@ -1305,6 +1546,9 @@ class DescribeTemplateListStatus(AbstractModel):
1305
1546
 
1306
1547
  @property
1307
1548
  def ReviewReply(self):
1549
+ """Review reply, i.e., response given by the reviewer, which is usually the reason for rejection.
1550
+ :rtype: str
1551
+ """
1308
1552
  return self._ReviewReply
1309
1553
 
1310
1554
  @ReviewReply.setter
@@ -1313,6 +1557,9 @@ class DescribeTemplateListStatus(AbstractModel):
1313
1557
 
1314
1558
  @property
1315
1559
  def TemplateName(self):
1560
+ """Template name.
1561
+ :rtype: str
1562
+ """
1316
1563
  return self._TemplateName
1317
1564
 
1318
1565
  @TemplateName.setter
@@ -1321,6 +1568,9 @@ class DescribeTemplateListStatus(AbstractModel):
1321
1568
 
1322
1569
  @property
1323
1570
  def CreateTime(self):
1571
+ """Application submission time in the format of UNIX timestamp in seconds.
1572
+ :rtype: int
1573
+ """
1324
1574
  return self._CreateTime
1325
1575
 
1326
1576
  @CreateTime.setter
@@ -1329,6 +1579,9 @@ class DescribeTemplateListStatus(AbstractModel):
1329
1579
 
1330
1580
  @property
1331
1581
  def TemplateContent(self):
1582
+ """Template content.
1583
+ :rtype: str
1584
+ """
1332
1585
  return self._TemplateContent
1333
1586
 
1334
1587
  @TemplateContent.setter
@@ -1368,6 +1621,9 @@ class ModifySignStatus(AbstractModel):
1368
1621
 
1369
1622
  @property
1370
1623
  def SignId(self):
1624
+ """Signature ID.
1625
+ :rtype: int
1626
+ """
1371
1627
  return self._SignId
1372
1628
 
1373
1629
  @SignId.setter
@@ -1449,6 +1705,9 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1449
1705
 
1450
1706
  @property
1451
1707
  def SignId(self):
1708
+ """ID of the signature to be modified.
1709
+ :rtype: int
1710
+ """
1452
1711
  return self._SignId
1453
1712
 
1454
1713
  @SignId.setter
@@ -1457,6 +1716,9 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1457
1716
 
1458
1717
  @property
1459
1718
  def SignName(self):
1719
+ """Signature name.
1720
+ :rtype: str
1721
+ """
1460
1722
  return self._SignName
1461
1723
 
1462
1724
  @SignName.setter
@@ -1465,6 +1727,17 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1465
1727
 
1466
1728
  @property
1467
1729
  def SignType(self):
1730
+ """Signature type. Each of these types is followed by their `DocumentType` (identity certificate type) option:
1731
+ 0: company. Valid values of `DocumentType` include 0 and 1.
1732
+ 1: app. Valid values of `DocumentType` include 0, 1, 2, 3, and 4.
1733
+ 2: website. Valid values of `DocumentType` include 0, 1, 2, 3, and 5.
1734
+ 3: WeChat Official Account. Valid values of `DocumentType` include 0, 1, 2, 3, and 8.
1735
+ 4: trademark. Valid values of `DocumentType` include 7.
1736
+ 5: government/public institution/other. Valid values of `DocumentType` include 2 and 3.
1737
+ 6: WeChat Mini Program. Valid values of `DocumentType` include 0, 1, 2, 3, and 6.
1738
+ Note: the identity certificate type must be selected according to the correspondence; otherwise, the review will fail.
1739
+ :rtype: int
1740
+ """
1468
1741
  return self._SignType
1469
1742
 
1470
1743
  @SignType.setter
@@ -1473,6 +1746,18 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1473
1746
 
1474
1747
  @property
1475
1748
  def DocumentType(self):
1749
+ """Identity certificate type:
1750
+ 0: three-in-one.
1751
+ 1: business license.
1752
+ 2: organization code certificate.
1753
+ 3: social credit code certificate.
1754
+ 4: screenshot of application backend management (for personal app).
1755
+ 5: screenshot of website ICP filing backend (for personal website).
1756
+ 6: screenshot of WeChat Mini Program settings page (for personal WeChat Mini Program).
1757
+ 7: trademark registration certificate.
1758
+ 8: screenshot of WeChat Official Account settings page (for personal WeChat Official Account).
1759
+ :rtype: int
1760
+ """
1476
1761
  return self._DocumentType
1477
1762
 
1478
1763
  @DocumentType.setter
@@ -1481,6 +1766,12 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1481
1766
 
1482
1767
  @property
1483
1768
  def International(self):
1769
+ """A parameter used to specify whether it is Global SMS:
1770
+ `0`: Chinese mainland SMS.
1771
+ `1`: Global SMS.
1772
+ Note: the value of this parameter must be consistent with the `International` value of the signature to be modified. This parameter cannot be used to directly change a Chinese mainland signature to an international signature.
1773
+ :rtype: int
1774
+ """
1484
1775
  return self._International
1485
1776
 
1486
1777
  @International.setter
@@ -1489,6 +1780,11 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1489
1780
 
1490
1781
  @property
1491
1782
  def SignPurpose(self):
1783
+ """Signature purpose:
1784
+ 0: for personal use.
1785
+ 1: for others.
1786
+ :rtype: int
1787
+ """
1492
1788
  return self._SignPurpose
1493
1789
 
1494
1790
  @SignPurpose.setter
@@ -1497,6 +1793,9 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1497
1793
 
1498
1794
  @property
1499
1795
  def ProofImage(self):
1796
+ """You should Base64-encode the image of the identity certificate corresponding to the signature first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
1797
+ :rtype: str
1798
+ """
1500
1799
  return self._ProofImage
1501
1800
 
1502
1801
  @ProofImage.setter
@@ -1505,6 +1804,11 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1505
1804
 
1506
1805
  @property
1507
1806
  def CommissionImage(self):
1807
+ """Power of attorney, which should be submitted if `SignPurpose` is for use by others.
1808
+ You should Base64-encode the image first, remove the prefix `data:image/jpeg;base64,` from the resulted string, and then use it as the value of this parameter.
1809
+ Note: this field will take effect only when `SignPurpose` is 1 (for user by others).
1810
+ :rtype: str
1811
+ """
1508
1812
  return self._CommissionImage
1509
1813
 
1510
1814
  @CommissionImage.setter
@@ -1513,6 +1817,9 @@ Note: this field will take effect only when `SignPurpose` is 1 (for user by othe
1513
1817
 
1514
1818
  @property
1515
1819
  def Remark(self):
1820
+ """Signature application remarks.
1821
+ :rtype: str
1822
+ """
1516
1823
  return self._Remark
1517
1824
 
1518
1825
  @Remark.setter
@@ -1557,6 +1864,9 @@ class ModifySmsSignResponse(AbstractModel):
1557
1864
 
1558
1865
  @property
1559
1866
  def ModifySignStatus(self):
1867
+ """Signature modification response
1868
+ :rtype: :class:`tencentcloud.sms.v20210111.models.ModifySignStatus`
1869
+ """
1560
1870
  return self._ModifySignStatus
1561
1871
 
1562
1872
  @ModifySignStatus.setter
@@ -1565,6 +1875,9 @@ class ModifySmsSignResponse(AbstractModel):
1565
1875
 
1566
1876
  @property
1567
1877
  def RequestId(self):
1878
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
1879
+ :rtype: str
1880
+ """
1568
1881
  return self._RequestId
1569
1882
 
1570
1883
  @RequestId.setter
@@ -1611,6 +1924,9 @@ Note: To further improve the quality of SMS service and increase the approval ra
1611
1924
 
1612
1925
  @property
1613
1926
  def TemplateId(self):
1927
+ """ID of the template to be modified.
1928
+ :rtype: int
1929
+ """
1614
1930
  return self._TemplateId
1615
1931
 
1616
1932
  @TemplateId.setter
@@ -1619,6 +1935,9 @@ Note: To further improve the quality of SMS service and increase the approval ra
1619
1935
 
1620
1936
  @property
1621
1937
  def TemplateName(self):
1938
+ """New template name.
1939
+ :rtype: str
1940
+ """
1622
1941
  return self._TemplateName
1623
1942
 
1624
1943
  @TemplateName.setter
@@ -1627,6 +1946,9 @@ Note: To further improve the quality of SMS service and increase the approval ra
1627
1946
 
1628
1947
  @property
1629
1948
  def TemplateContent(self):
1949
+ """New template content.
1950
+ :rtype: str
1951
+ """
1630
1952
  return self._TemplateContent
1631
1953
 
1632
1954
  @TemplateContent.setter
@@ -1635,6 +1957,10 @@ Note: To further improve the quality of SMS service and increase the approval ra
1635
1957
 
1636
1958
  @property
1637
1959
  def SmsType(self):
1960
+ """SMS type. 1: Marketing SMS, 2: Notification SMS, 3: OTP SMS.
1961
+ Note: To further improve the quality of SMS service and increase the approval rate of SMS templates, Tencent Cloud SMS template types will be optimized to "OTP", "Notification", and "Marketing" from May 16, 2024. You can Refer to [Optimization of Tencent Cloud SMS Template Types](https://www.tencentcloud.com/document/product/382/60410). Customers who newly register for SMS service must strictly refer to the new SMS type to apply for SMS template.
1962
+ :rtype: int
1963
+ """
1638
1964
  return self._SmsType
1639
1965
 
1640
1966
  @SmsType.setter
@@ -1643,6 +1969,11 @@ Note: To further improve the quality of SMS service and increase the approval ra
1643
1969
 
1644
1970
  @property
1645
1971
  def International(self):
1972
+ """Whether it is Global SMS:
1973
+ 0: Mainland China SMS.
1974
+ 1: Global SMS.
1975
+ :rtype: int
1976
+ """
1646
1977
  return self._International
1647
1978
 
1648
1979
  @International.setter
@@ -1651,6 +1982,9 @@ Note: To further improve the quality of SMS service and increase the approval ra
1651
1982
 
1652
1983
  @property
1653
1984
  def Remark(self):
1985
+ """Template remarks, such as reason for application and use case.
1986
+ :rtype: str
1987
+ """
1654
1988
  return self._Remark
1655
1989
 
1656
1990
  @Remark.setter
@@ -1692,6 +2026,9 @@ class ModifySmsTemplateResponse(AbstractModel):
1692
2026
 
1693
2027
  @property
1694
2028
  def ModifyTemplateStatus(self):
2029
+ """Template parameter modification response
2030
+ :rtype: :class:`tencentcloud.sms.v20210111.models.ModifyTemplateStatus`
2031
+ """
1695
2032
  return self._ModifyTemplateStatus
1696
2033
 
1697
2034
  @ModifyTemplateStatus.setter
@@ -1700,6 +2037,9 @@ class ModifySmsTemplateResponse(AbstractModel):
1700
2037
 
1701
2038
  @property
1702
2039
  def RequestId(self):
2040
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2041
+ :rtype: str
2042
+ """
1703
2043
  return self._RequestId
1704
2044
 
1705
2045
  @RequestId.setter
@@ -1728,6 +2068,9 @@ class ModifyTemplateStatus(AbstractModel):
1728
2068
 
1729
2069
  @property
1730
2070
  def TemplateId(self):
2071
+ """Template ID.
2072
+ :rtype: int
2073
+ """
1731
2074
  return self._TemplateId
1732
2075
 
1733
2076
  @TemplateId.setter
@@ -1779,6 +2122,9 @@ class PhoneNumberInfo(AbstractModel):
1779
2122
 
1780
2123
  @property
1781
2124
  def Code(self):
2125
+ """Error code for mobile number information query. `Ok` will be returned if the query is successful.
2126
+ :rtype: str
2127
+ """
1782
2128
  return self._Code
1783
2129
 
1784
2130
  @Code.setter
@@ -1787,6 +2133,9 @@ class PhoneNumberInfo(AbstractModel):
1787
2133
 
1788
2134
  @property
1789
2135
  def Message(self):
2136
+ """Description of the error code for mobile number information query.
2137
+ :rtype: str
2138
+ """
1790
2139
  return self._Message
1791
2140
 
1792
2141
  @Message.setter
@@ -1795,6 +2144,9 @@ class PhoneNumberInfo(AbstractModel):
1795
2144
 
1796
2145
  @property
1797
2146
  def NationCode(self):
2147
+ """Country (or region) code.
2148
+ :rtype: str
2149
+ """
1798
2150
  return self._NationCode
1799
2151
 
1800
2152
  @NationCode.setter
@@ -1803,6 +2155,9 @@ class PhoneNumberInfo(AbstractModel):
1803
2155
 
1804
2156
  @property
1805
2157
  def SubscriberNumber(self):
2158
+ """Subscriber number in normal format such as 13711112222, without any prefix (country or region code).
2159
+ :rtype: str
2160
+ """
1806
2161
  return self._SubscriberNumber
1807
2162
 
1808
2163
  @SubscriberNumber.setter
@@ -1811,6 +2166,9 @@ class PhoneNumberInfo(AbstractModel):
1811
2166
 
1812
2167
  @property
1813
2168
  def PhoneNumber(self):
2169
+ """The standardized mobile number in E.164 format after parsing, which is consistent with the parsed number for SMS message delivery. If the parsing fails, the original number will be returned.
2170
+ :rtype: str
2171
+ """
1814
2172
  return self._PhoneNumber
1815
2173
 
1816
2174
  @PhoneNumber.setter
@@ -1819,6 +2177,9 @@ class PhoneNumberInfo(AbstractModel):
1819
2177
 
1820
2178
  @property
1821
2179
  def IsoCode(self):
2180
+ """Country or region code such as CN and US. If the country or region code cannot be identified, `DEF` will be returned by default.
2181
+ :rtype: str
2182
+ """
1822
2183
  return self._IsoCode
1823
2184
 
1824
2185
  @IsoCode.setter
@@ -1827,6 +2188,9 @@ class PhoneNumberInfo(AbstractModel):
1827
2188
 
1828
2189
  @property
1829
2190
  def IsoName(self):
2191
+ """Country code or region name such as China. For more information, see [Global SMS Price Overview](https://intl.cloud.tencent.com/document/product/382/18051?from_cn_redirect=1#.E6.97.A5.E7.BB.93.E5.90.8E.E4.BB.98.E8.B4.B9.3Ca-id.3D.22post-payment.22.3E.3C.2Fa.3E)
2192
+ :rtype: str
2193
+ """
1830
2194
  return self._IsoName
1831
2195
 
1832
2196
  @IsoName.setter
@@ -1884,6 +2248,9 @@ class PullSmsReplyStatus(AbstractModel):
1884
2248
 
1885
2249
  @property
1886
2250
  def ExtendCode(self):
2251
+ """SMS code number extension, which is not activated by default. If you need to activate it, please contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).
2252
+ :rtype: str
2253
+ """
1887
2254
  return self._ExtendCode
1888
2255
 
1889
2256
  @ExtendCode.setter
@@ -1892,6 +2259,9 @@ class PullSmsReplyStatus(AbstractModel):
1892
2259
 
1893
2260
  @property
1894
2261
  def CountryCode(self):
2262
+ """Country (or region) code.
2263
+ :rtype: str
2264
+ """
1895
2265
  return self._CountryCode
1896
2266
 
1897
2267
  @CountryCode.setter
@@ -1900,6 +2270,9 @@ class PullSmsReplyStatus(AbstractModel):
1900
2270
 
1901
2271
  @property
1902
2272
  def PhoneNumber(self):
2273
+ """Mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
2274
+ :rtype: str
2275
+ """
1903
2276
  return self._PhoneNumber
1904
2277
 
1905
2278
  @PhoneNumber.setter
@@ -1908,6 +2281,9 @@ class PullSmsReplyStatus(AbstractModel):
1908
2281
 
1909
2282
  @property
1910
2283
  def SignName(self):
2284
+ """SMS signature name.
2285
+ :rtype: str
2286
+ """
1911
2287
  return self._SignName
1912
2288
 
1913
2289
  @SignName.setter
@@ -1916,6 +2292,9 @@ class PullSmsReplyStatus(AbstractModel):
1916
2292
 
1917
2293
  @property
1918
2294
  def ReplyContent(self):
2295
+ """User reply.
2296
+ :rtype: str
2297
+ """
1919
2298
  return self._ReplyContent
1920
2299
 
1921
2300
  @ReplyContent.setter
@@ -1924,6 +2303,9 @@ class PullSmsReplyStatus(AbstractModel):
1924
2303
 
1925
2304
  @property
1926
2305
  def ReplyTime(self):
2306
+ """Reply time in seconds in the format of UNIX timestamp.
2307
+ :rtype: int
2308
+ """
1927
2309
  return self._ReplyTime
1928
2310
 
1929
2311
  @ReplyTime.setter
@@ -1932,6 +2314,9 @@ class PullSmsReplyStatus(AbstractModel):
1932
2314
 
1933
2315
  @property
1934
2316
  def SubscriberNumber(self):
2317
+ """User's mobile number in a common format such as 13711112222.
2318
+ :rtype: str
2319
+ """
1935
2320
  return self._SubscriberNumber
1936
2321
 
1937
2322
  @SubscriberNumber.setter
@@ -1988,6 +2373,10 @@ Note: this parameter is currently fixed at 0.
1988
2373
 
1989
2374
  @property
1990
2375
  def BeginTime(self):
2376
+ """Pull start time in seconds in the format of UNIX timestamp.
2377
+ Note: the data for the last 7 days can be pulled at most.
2378
+ :rtype: int
2379
+ """
1991
2380
  return self._BeginTime
1992
2381
 
1993
2382
  @BeginTime.setter
@@ -1996,6 +2385,10 @@ Note: this parameter is currently fixed at 0.
1996
2385
 
1997
2386
  @property
1998
2387
  def Offset(self):
2388
+ """Offset.
2389
+ Note: this parameter is currently fixed at 0.
2390
+ :rtype: int
2391
+ """
1999
2392
  return self._Offset
2000
2393
 
2001
2394
  @Offset.setter
@@ -2004,6 +2397,9 @@ Note: this parameter is currently fixed at 0.
2004
2397
 
2005
2398
  @property
2006
2399
  def Limit(self):
2400
+ """Maximum number of pulled entries. Maximum value: 100.
2401
+ :rtype: int
2402
+ """
2007
2403
  return self._Limit
2008
2404
 
2009
2405
  @Limit.setter
@@ -2012,6 +2408,9 @@ Note: this parameter is currently fixed at 0.
2012
2408
 
2013
2409
  @property
2014
2410
  def PhoneNumber(self):
2411
+ """Target mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
2412
+ :rtype: str
2413
+ """
2015
2414
  return self._PhoneNumber
2016
2415
 
2017
2416
  @PhoneNumber.setter
@@ -2020,6 +2419,9 @@ Note: this parameter is currently fixed at 0.
2020
2419
 
2021
2420
  @property
2022
2421
  def SmsSdkAppId(self):
2422
+ """The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
2423
+ :rtype: str
2424
+ """
2023
2425
  return self._SmsSdkAppId
2024
2426
 
2025
2427
  @SmsSdkAppId.setter
@@ -2028,6 +2430,9 @@ Note: this parameter is currently fixed at 0.
2028
2430
 
2029
2431
  @property
2030
2432
  def EndTime(self):
2433
+ """Pull end time in seconds in the format of UNIX timestamp.
2434
+ :rtype: int
2435
+ """
2031
2436
  return self._EndTime
2032
2437
 
2033
2438
  @EndTime.setter
@@ -2069,6 +2474,9 @@ class PullSmsReplyStatusByPhoneNumberResponse(AbstractModel):
2069
2474
 
2070
2475
  @property
2071
2476
  def PullSmsReplyStatusSet(self):
2477
+ """Reply status response set.
2478
+ :rtype: list of PullSmsReplyStatus
2479
+ """
2072
2480
  return self._PullSmsReplyStatusSet
2073
2481
 
2074
2482
  @PullSmsReplyStatusSet.setter
@@ -2077,6 +2485,9 @@ class PullSmsReplyStatusByPhoneNumberResponse(AbstractModel):
2077
2485
 
2078
2486
  @property
2079
2487
  def RequestId(self):
2488
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2489
+ :rtype: str
2490
+ """
2080
2491
  return self._RequestId
2081
2492
 
2082
2493
  @RequestId.setter
@@ -2111,6 +2522,9 @@ class PullSmsReplyStatusRequest(AbstractModel):
2111
2522
 
2112
2523
  @property
2113
2524
  def Limit(self):
2525
+ """Maximum number of pulled entries. Maximum value: 100.
2526
+ :rtype: int
2527
+ """
2114
2528
  return self._Limit
2115
2529
 
2116
2530
  @Limit.setter
@@ -2119,6 +2533,9 @@ class PullSmsReplyStatusRequest(AbstractModel):
2119
2533
 
2120
2534
  @property
2121
2535
  def SmsSdkAppId(self):
2536
+ """The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
2537
+ :rtype: str
2538
+ """
2122
2539
  return self._SmsSdkAppId
2123
2540
 
2124
2541
  @SmsSdkAppId.setter
@@ -2156,6 +2573,9 @@ class PullSmsReplyStatusResponse(AbstractModel):
2156
2573
 
2157
2574
  @property
2158
2575
  def PullSmsReplyStatusSet(self):
2576
+ """Reply status response set.
2577
+ :rtype: list of PullSmsReplyStatus
2578
+ """
2159
2579
  return self._PullSmsReplyStatusSet
2160
2580
 
2161
2581
  @PullSmsReplyStatusSet.setter
@@ -2164,6 +2584,9 @@ class PullSmsReplyStatusResponse(AbstractModel):
2164
2584
 
2165
2585
  @property
2166
2586
  def RequestId(self):
2587
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2588
+ :rtype: str
2589
+ """
2167
2590
  return self._RequestId
2168
2591
 
2169
2592
  @RequestId.setter
@@ -2217,6 +2640,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2217
2640
 
2218
2641
  @property
2219
2642
  def UserReceiveTime(self):
2643
+ """Actual time of SMS receipt by user in seconds in the format of UNIX timestamp.
2644
+ :rtype: int
2645
+ """
2220
2646
  return self._UserReceiveTime
2221
2647
 
2222
2648
  @UserReceiveTime.setter
@@ -2225,6 +2651,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2225
2651
 
2226
2652
  @property
2227
2653
  def CountryCode(self):
2654
+ """Country (or region) code.
2655
+ :rtype: str
2656
+ """
2228
2657
  return self._CountryCode
2229
2658
 
2230
2659
  @CountryCode.setter
@@ -2233,6 +2662,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2233
2662
 
2234
2663
  @property
2235
2664
  def SubscriberNumber(self):
2665
+ """User's mobile number in a common format such as 13711112222.
2666
+ :rtype: str
2667
+ """
2236
2668
  return self._SubscriberNumber
2237
2669
 
2238
2670
  @SubscriberNumber.setter
@@ -2241,6 +2673,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2241
2673
 
2242
2674
  @property
2243
2675
  def PhoneNumber(self):
2676
+ """Mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
2677
+ :rtype: str
2678
+ """
2244
2679
  return self._PhoneNumber
2245
2680
 
2246
2681
  @PhoneNumber.setter
@@ -2249,6 +2684,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2249
2684
 
2250
2685
  @property
2251
2686
  def SerialNo(self):
2687
+ """ID of the current delivery.
2688
+ :rtype: str
2689
+ """
2252
2690
  return self._SerialNo
2253
2691
 
2254
2692
  @SerialNo.setter
@@ -2257,6 +2695,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2257
2695
 
2258
2696
  @property
2259
2697
  def ReportStatus(self):
2698
+ """Whether the SMS message is actually received. Valid values: SUCCESS (success), FAIL (failure).
2699
+ :rtype: str
2700
+ """
2260
2701
  return self._ReportStatus
2261
2702
 
2262
2703
  @ReportStatus.setter
@@ -2265,6 +2706,9 @@ Note: This field may return null, indicating that no valid values can be obtaine
2265
2706
 
2266
2707
  @property
2267
2708
  def Description(self):
2709
+ """Description of SMS receipt by user.
2710
+ :rtype: str
2711
+ """
2268
2712
  return self._Description
2269
2713
 
2270
2714
  @Description.setter
@@ -2273,6 +2717,10 @@ Note: This field may return null, indicating that no valid values can be obtaine
2273
2717
 
2274
2718
  @property
2275
2719
  def SessionContext(self):
2720
+ """User session content, which is the same as the `SessionContext` in the request and is empty by default. If you need to activate it, contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).
2721
+ Note: This field may return null, indicating that no valid values can be obtained.
2722
+ :rtype: str
2723
+ """
2276
2724
  return self._SessionContext
2277
2725
 
2278
2726
  @SessionContext.setter
@@ -2330,6 +2778,10 @@ Note: this parameter is currently fixed at 0.
2330
2778
 
2331
2779
  @property
2332
2780
  def BeginTime(self):
2781
+ """Pull start time in seconds in the format of UNIX timestamp.
2782
+ Note: the data for the last 7 days can be pulled at most.
2783
+ :rtype: int
2784
+ """
2333
2785
  return self._BeginTime
2334
2786
 
2335
2787
  @BeginTime.setter
@@ -2338,6 +2790,10 @@ Note: this parameter is currently fixed at 0.
2338
2790
 
2339
2791
  @property
2340
2792
  def Offset(self):
2793
+ """Offset.
2794
+ Note: this parameter is currently fixed at 0.
2795
+ :rtype: int
2796
+ """
2341
2797
  return self._Offset
2342
2798
 
2343
2799
  @Offset.setter
@@ -2346,6 +2802,9 @@ Note: this parameter is currently fixed at 0.
2346
2802
 
2347
2803
  @property
2348
2804
  def Limit(self):
2805
+ """Maximum number of pulled entries. Maximum value: 100.
2806
+ :rtype: int
2807
+ """
2349
2808
  return self._Limit
2350
2809
 
2351
2810
  @Limit.setter
@@ -2354,6 +2813,9 @@ Note: this parameter is currently fixed at 0.
2354
2813
 
2355
2814
  @property
2356
2815
  def PhoneNumber(self):
2816
+ """Target mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
2817
+ :rtype: str
2818
+ """
2357
2819
  return self._PhoneNumber
2358
2820
 
2359
2821
  @PhoneNumber.setter
@@ -2362,6 +2824,9 @@ Note: this parameter is currently fixed at 0.
2362
2824
 
2363
2825
  @property
2364
2826
  def SmsSdkAppId(self):
2827
+ """The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
2828
+ :rtype: str
2829
+ """
2365
2830
  return self._SmsSdkAppId
2366
2831
 
2367
2832
  @SmsSdkAppId.setter
@@ -2370,6 +2835,9 @@ Note: this parameter is currently fixed at 0.
2370
2835
 
2371
2836
  @property
2372
2837
  def EndTime(self):
2838
+ """Pull end time in seconds in the format of UNIX timestamp.
2839
+ :rtype: int
2840
+ """
2373
2841
  return self._EndTime
2374
2842
 
2375
2843
  @EndTime.setter
@@ -2411,6 +2879,9 @@ class PullSmsSendStatusByPhoneNumberResponse(AbstractModel):
2411
2879
 
2412
2880
  @property
2413
2881
  def PullSmsSendStatusSet(self):
2882
+ """Delivery status response set.
2883
+ :rtype: list of PullSmsSendStatus
2884
+ """
2414
2885
  return self._PullSmsSendStatusSet
2415
2886
 
2416
2887
  @PullSmsSendStatusSet.setter
@@ -2419,6 +2890,9 @@ class PullSmsSendStatusByPhoneNumberResponse(AbstractModel):
2419
2890
 
2420
2891
  @property
2421
2892
  def RequestId(self):
2893
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2894
+ :rtype: str
2895
+ """
2422
2896
  return self._RequestId
2423
2897
 
2424
2898
  @RequestId.setter
@@ -2453,6 +2927,9 @@ class PullSmsSendStatusRequest(AbstractModel):
2453
2927
 
2454
2928
  @property
2455
2929
  def Limit(self):
2930
+ """Maximum number of pulled entries. Maximum value: 100.
2931
+ :rtype: int
2932
+ """
2456
2933
  return self._Limit
2457
2934
 
2458
2935
  @Limit.setter
@@ -2461,6 +2938,9 @@ class PullSmsSendStatusRequest(AbstractModel):
2461
2938
 
2462
2939
  @property
2463
2940
  def SmsSdkAppId(self):
2941
+ """The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
2942
+ :rtype: str
2943
+ """
2464
2944
  return self._SmsSdkAppId
2465
2945
 
2466
2946
  @SmsSdkAppId.setter
@@ -2498,6 +2978,9 @@ class PullSmsSendStatusResponse(AbstractModel):
2498
2978
 
2499
2979
  @property
2500
2980
  def PullSmsSendStatusSet(self):
2981
+ """Delivery status response set.
2982
+ :rtype: list of PullSmsSendStatus
2983
+ """
2501
2984
  return self._PullSmsSendStatusSet
2502
2985
 
2503
2986
  @PullSmsSendStatusSet.setter
@@ -2506,6 +2989,9 @@ class PullSmsSendStatusResponse(AbstractModel):
2506
2989
 
2507
2990
  @property
2508
2991
  def RequestId(self):
2992
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
2993
+ :rtype: str
2994
+ """
2509
2995
  return self._RequestId
2510
2996
 
2511
2997
  @RequestId.setter
@@ -2543,6 +3029,9 @@ class ReportConversionRequest(AbstractModel):
2543
3029
 
2544
3030
  @property
2545
3031
  def SmsSdkAppId(self):
3032
+ """The SMS SdkAppId generated after an application is created in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as “1400006666”.
3033
+ :rtype: str
3034
+ """
2546
3035
  return self._SmsSdkAppId
2547
3036
 
2548
3037
  @SmsSdkAppId.setter
@@ -2551,6 +3040,9 @@ class ReportConversionRequest(AbstractModel):
2551
3040
 
2552
3041
  @property
2553
3042
  def SerialNo(self):
3043
+ """The serial number returned for a message sent.
3044
+ :rtype: str
3045
+ """
2554
3046
  return self._SerialNo
2555
3047
 
2556
3048
  @SerialNo.setter
@@ -2559,6 +3051,9 @@ class ReportConversionRequest(AbstractModel):
2559
3051
 
2560
3052
  @property
2561
3053
  def ConversionTime(self):
3054
+ """The recipient’s reply time in seconds in the format of UNIX timestamp.
3055
+ :rtype: int
3056
+ """
2562
3057
  return self._ConversionTime
2563
3058
 
2564
3059
  @ConversionTime.setter
@@ -2597,6 +3092,9 @@ class ReportConversionResponse(AbstractModel):
2597
3092
 
2598
3093
  @property
2599
3094
  def ReportConversionStatus(self):
3095
+ """Response packet for conversion rate reporting.
3096
+ :rtype: :class:`tencentcloud.sms.v20210111.models.ReportConversionStatus`
3097
+ """
2600
3098
  return self._ReportConversionStatus
2601
3099
 
2602
3100
  @ReportConversionStatus.setter
@@ -2605,6 +3103,9 @@ class ReportConversionResponse(AbstractModel):
2605
3103
 
2606
3104
  @property
2607
3105
  def RequestId(self):
3106
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3107
+ :rtype: str
3108
+ """
2608
3109
  return self._RequestId
2609
3110
 
2610
3111
  @RequestId.setter
@@ -2636,6 +3137,9 @@ class ReportConversionStatus(AbstractModel):
2636
3137
 
2637
3138
  @property
2638
3139
  def Code(self):
3140
+ """Error code. `ok` is returned if the conversion rate is successfully reported.
3141
+ :rtype: str
3142
+ """
2639
3143
  return self._Code
2640
3144
 
2641
3145
  @Code.setter
@@ -2644,6 +3148,9 @@ class ReportConversionStatus(AbstractModel):
2644
3148
 
2645
3149
  @property
2646
3150
  def Message(self):
3151
+ """Error code description.
3152
+ :rtype: str
3153
+ """
2647
3154
  return self._Message
2648
3155
 
2649
3156
  @Message.setter
@@ -2701,6 +3208,9 @@ Note: If your monthly usage reaches the specified threshold, you can apply for a
2701
3208
 
2702
3209
  @property
2703
3210
  def PhoneNumberSet(self):
3211
+ """Target mobile number in the E.164 standard in the format of +[country/region code][mobile number]. Up to 200 mobile numbers are supported in one request (which should be all Chinese mainland mobile numbers or all global mobile numbers). For example, +60198890000, which has a + sign followed by 60 (country/region code) and then by 198890000 (mobile number).
3212
+ :rtype: list of str
3213
+ """
2704
3214
  return self._PhoneNumberSet
2705
3215
 
2706
3216
  @PhoneNumberSet.setter
@@ -2709,6 +3219,9 @@ Note: If your monthly usage reaches the specified threshold, you can apply for a
2709
3219
 
2710
3220
  @property
2711
3221
  def SmsSdkAppId(self):
3222
+ """The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 2400006666.
3223
+ :rtype: str
3224
+ """
2712
3225
  return self._SmsSdkAppId
2713
3226
 
2714
3227
  @SmsSdkAppId.setter
@@ -2717,6 +3230,9 @@ Note: If your monthly usage reaches the specified threshold, you can apply for a
2717
3230
 
2718
3231
  @property
2719
3232
  def TemplateId(self):
3233
+ """Template ID, which can be viewed on the **Body Templates** page in [Global SMS](https://console.cloud.tencent.com/smsv2/isms-template). You must enter the ID of an approved template.
3234
+ :rtype: str
3235
+ """
2720
3236
  return self._TemplateId
2721
3237
 
2722
3238
  @TemplateId.setter
@@ -2725,6 +3241,9 @@ Note: If your monthly usage reaches the specified threshold, you can apply for a
2725
3241
 
2726
3242
  @property
2727
3243
  def SignName(self):
3244
+ """SMS signature information which is encoded in UTF-8. You must enter an approved signature (such as Tencent Cloud). The signing information can be viewed on the **Signatures** page in [Global SMS](https://console.cloud.tencent.com/smsv2/isms-sign).
3245
+ :rtype: str
3246
+ """
2728
3247
  return self._SignName
2729
3248
 
2730
3249
  @SignName.setter
@@ -2733,6 +3252,10 @@ Note: If your monthly usage reaches the specified threshold, you can apply for a
2733
3252
 
2734
3253
  @property
2735
3254
  def TemplateParamSet(self):
3255
+ """Template parameter. If there is no template parameter, leave this field empty.
3256
+ <dx-alert infotype="notice" title="Note">The number of template parameters should be consistent with that of the template variables of `TemplateId`.</dx-alert>
3257
+ :rtype: list of str
3258
+ """
2736
3259
  return self._TemplateParamSet
2737
3260
 
2738
3261
  @TemplateParamSet.setter
@@ -2741,6 +3264,9 @@ Note: If your monthly usage reaches the specified threshold, you can apply for a
2741
3264
 
2742
3265
  @property
2743
3266
  def ExtendCode(self):
3267
+ """SMS code number extension, which is not activated by default. If you need to activate it, you can contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).
3268
+ :rtype: str
3269
+ """
2744
3270
  return self._ExtendCode
2745
3271
 
2746
3272
  @ExtendCode.setter
@@ -2749,6 +3275,9 @@ Note: If your monthly usage reaches the specified threshold, you can apply for a
2749
3275
 
2750
3276
  @property
2751
3277
  def SessionContext(self):
3278
+ """User session content, which can carry context information such as user-side ID and will be returned as-is by the server. Note that the length must be less than 512 bytes.
3279
+ :rtype: str
3280
+ """
2752
3281
  return self._SessionContext
2753
3282
 
2754
3283
  @SessionContext.setter
@@ -2757,6 +3286,10 @@ Note: If your monthly usage reaches the specified threshold, you can apply for a
2757
3286
 
2758
3287
  @property
2759
3288
  def SenderId(self):
3289
+ """For Global SMS, if you have applied for a separate `SenderId`, this parameter is required. By default, the public `SenderId` is used, in which case you don't need to enter this parameter.
3290
+ Note: If your monthly usage reaches the specified threshold, you can apply for an independent `SenderId`. For more information, contact [SMS Helper](https://intl.cloud.tencent.com/document/product/382/3773?from_cn_redirect=1#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81).
3291
+ :rtype: str
3292
+ """
2760
3293
  return self._SenderId
2761
3294
 
2762
3295
  @SenderId.setter
@@ -2800,6 +3333,9 @@ class SendSmsResponse(AbstractModel):
2800
3333
 
2801
3334
  @property
2802
3335
  def SendStatusSet(self):
3336
+ """SMS delivery status.
3337
+ :rtype: list of SendStatus
3338
+ """
2803
3339
  return self._SendStatusSet
2804
3340
 
2805
3341
  @SendStatusSet.setter
@@ -2808,6 +3344,9 @@ class SendSmsResponse(AbstractModel):
2808
3344
 
2809
3345
  @property
2810
3346
  def RequestId(self):
3347
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3348
+ :rtype: str
3349
+ """
2811
3350
  return self._RequestId
2812
3351
 
2813
3352
  @RequestId.setter
@@ -2857,6 +3396,9 @@ class SendStatus(AbstractModel):
2857
3396
 
2858
3397
  @property
2859
3398
  def SerialNo(self):
3399
+ """Delivery serial number.
3400
+ :rtype: str
3401
+ """
2860
3402
  return self._SerialNo
2861
3403
 
2862
3404
  @SerialNo.setter
@@ -2865,6 +3407,9 @@ class SendStatus(AbstractModel):
2865
3407
 
2866
3408
  @property
2867
3409
  def PhoneNumber(self):
3410
+ """Mobile number in the E.164 standard (+[country/region code][mobile number]), such as +8613711112222, which has a + sign followed by 86 (country/region code) and then by 13711112222 (mobile number).
3411
+ :rtype: str
3412
+ """
2868
3413
  return self._PhoneNumber
2869
3414
 
2870
3415
  @PhoneNumber.setter
@@ -2873,6 +3418,9 @@ class SendStatus(AbstractModel):
2873
3418
 
2874
3419
  @property
2875
3420
  def Fee(self):
3421
+ """Number of billable SMS messages. For billing rules, see Billing Policy.
3422
+ :rtype: int
3423
+ """
2876
3424
  return self._Fee
2877
3425
 
2878
3426
  @Fee.setter
@@ -2881,6 +3429,9 @@ class SendStatus(AbstractModel):
2881
3429
 
2882
3430
  @property
2883
3431
  def SessionContext(self):
3432
+ """User session content.
3433
+ :rtype: str
3434
+ """
2884
3435
  return self._SessionContext
2885
3436
 
2886
3437
  @SessionContext.setter
@@ -2889,6 +3440,9 @@ class SendStatus(AbstractModel):
2889
3440
 
2890
3441
  @property
2891
3442
  def Code(self):
3443
+ """SMS request error code. For specific meanings, see [Error Codes](https://intl.cloud.tencent.com/zh/document/product/382/40536#6.-error-code). `Ok` will be returned for successful delivery.
3444
+ :rtype: str
3445
+ """
2892
3446
  return self._Code
2893
3447
 
2894
3448
  @Code.setter
@@ -2897,6 +3451,9 @@ class SendStatus(AbstractModel):
2897
3451
 
2898
3452
  @property
2899
3453
  def Message(self):
3454
+ """SMS request error message.
3455
+ :rtype: str
3456
+ """
2900
3457
  return self._Message
2901
3458
 
2902
3459
  @Message.setter
@@ -2905,6 +3462,9 @@ class SendStatus(AbstractModel):
2905
3462
 
2906
3463
  @property
2907
3464
  def IsoCode(self):
3465
+ """Country/Region code, such as CN and US. For unrecognized country/region codes, `DEF` is returned by default. For the specific list of supported values, please see [Global SMS Price Overview](https://intl.cloud.tencent.com/document/product/382/18051?from_cn_redirect=1).
3466
+ :rtype: str
3467
+ """
2908
3468
  return self._IsoCode
2909
3469
 
2910
3470
  @IsoCode.setter
@@ -2950,6 +3510,9 @@ class SendStatusStatistics(AbstractModel):
2950
3510
 
2951
3511
  @property
2952
3512
  def FeeCount(self):
3513
+ """Billable SMS message quantity; for example, in 100 successfully submitted SMS messages, if 20 ones are long messages (over 80 characters) and split into two messages each, then the billable quantity will be 80 * 1 + 20 * 2 = 120.
3514
+ :rtype: int
3515
+ """
2953
3516
  return self._FeeCount
2954
3517
 
2955
3518
  @FeeCount.setter
@@ -2958,6 +3521,9 @@ class SendStatusStatistics(AbstractModel):
2958
3521
 
2959
3522
  @property
2960
3523
  def RequestCount(self):
3524
+ """Submitted SMS messages.
3525
+ :rtype: int
3526
+ """
2961
3527
  return self._RequestCount
2962
3528
 
2963
3529
  @RequestCount.setter
@@ -2966,6 +3532,9 @@ class SendStatusStatistics(AbstractModel):
2966
3532
 
2967
3533
  @property
2968
3534
  def RequestSuccessCount(self):
3535
+ """Successfully submitted SMS messages.
3536
+ :rtype: int
3537
+ """
2969
3538
  return self._RequestSuccessCount
2970
3539
 
2971
3540
  @RequestSuccessCount.setter
@@ -3016,6 +3585,9 @@ Note: this parameter is currently fixed at 0.
3016
3585
 
3017
3586
  @property
3018
3587
  def BeginTime(self):
3588
+ """Start time in the format of `yyyymmddhh` accurate to the hour, such as 2021050113 (13:00 on May 1, 2021).
3589
+ :rtype: str
3590
+ """
3019
3591
  return self._BeginTime
3020
3592
 
3021
3593
  @BeginTime.setter
@@ -3024,6 +3596,10 @@ Note: this parameter is currently fixed at 0.
3024
3596
 
3025
3597
  @property
3026
3598
  def EndTime(self):
3599
+ """End time in the format of `yyyymmddhh` accurate to the hour, such as 2021050118 (18:00 on May 1, 2021).
3600
+ Note: `EndTime` must be after `BeginTime`.
3601
+ :rtype: str
3602
+ """
3027
3603
  return self._EndTime
3028
3604
 
3029
3605
  @EndTime.setter
@@ -3032,6 +3608,9 @@ Note: this parameter is currently fixed at 0.
3032
3608
 
3033
3609
  @property
3034
3610
  def SmsSdkAppId(self):
3611
+ """The SMS `SdkAppId` generated after an application is added in the [SMS console](https://console.cloud.tencent.com/smsv2/app-manage), such as 1400006666.
3612
+ :rtype: str
3613
+ """
3035
3614
  return self._SmsSdkAppId
3036
3615
 
3037
3616
  @SmsSdkAppId.setter
@@ -3040,6 +3619,10 @@ Note: this parameter is currently fixed at 0.
3040
3619
 
3041
3620
  @property
3042
3621
  def Limit(self):
3622
+ """Upper limit.
3623
+ Note: this parameter is currently fixed at 0.
3624
+ :rtype: int
3625
+ """
3043
3626
  return self._Limit
3044
3627
 
3045
3628
  @Limit.setter
@@ -3048,6 +3631,10 @@ Note: this parameter is currently fixed at 0.
3048
3631
 
3049
3632
  @property
3050
3633
  def Offset(self):
3634
+ """Offset.
3635
+ Note: this parameter is currently fixed at 0.
3636
+ :rtype: int
3637
+ """
3051
3638
  return self._Offset
3052
3639
 
3053
3640
  @Offset.setter
@@ -3088,6 +3675,9 @@ class SendStatusStatisticsResponse(AbstractModel):
3088
3675
 
3089
3676
  @property
3090
3677
  def SendStatusStatistics(self):
3678
+ """Delivery statistics response body.
3679
+ :rtype: :class:`tencentcloud.sms.v20210111.models.SendStatusStatistics`
3680
+ """
3091
3681
  return self._SendStatusStatistics
3092
3682
 
3093
3683
  @SendStatusStatistics.setter
@@ -3096,6 +3686,9 @@ class SendStatusStatisticsResponse(AbstractModel):
3096
3686
 
3097
3687
  @property
3098
3688
  def RequestId(self):
3689
+ """The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem.
3690
+ :rtype: str
3691
+ """
3099
3692
  return self._RequestId
3100
3693
 
3101
3694
  @RequestId.setter