tencentcloud-sdk-nodejs 4.0.877 → 4.0.879

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.
Files changed (100) hide show
  1. package/CHANGELOG.md +407 -0
  2. package/SERVICE_CHANGELOG.md +530 -66
  3. package/package.json +1 -1
  4. package/products.md +33 -33
  5. package/src/common/sdk_version.ts +1 -1
  6. package/src/services/cdwch/v20200915/cdwch_models.ts +8 -8
  7. package/src/services/cdwdoris/v20211228/cdwdoris_models.ts +8 -0
  8. package/src/services/cfw/v20190904/cfw_models.ts +4 -4
  9. package/src/services/ckafka/v20190819/ckafka_client.ts +2 -3
  10. package/src/services/ckafka/v20190819/ckafka_models.ts +71 -46
  11. package/src/services/csip/v20221121/csip_client.ts +31 -3
  12. package/src/services/csip/v20221121/csip_models.ts +385 -31
  13. package/src/services/cynosdb/v20190107/cynosdb_client.ts +7 -2
  14. package/src/services/cynosdb/v20190107/cynosdb_models.ts +215 -29
  15. package/src/services/dlc/v20210125/dlc_client.ts +12 -0
  16. package/src/services/dlc/v20210125/dlc_models.ts +19 -0
  17. package/src/services/dsgc/v20190723/dsgc_models.ts +5 -5
  18. package/src/services/emr/v20190103/emr_models.ts +1 -1
  19. package/src/services/ess/v20201111/ess_client.ts +2 -2
  20. package/src/services/ess/v20201111/ess_models.ts +3 -2
  21. package/src/services/essbasic/v20210526/essbasic_client.ts +13 -2
  22. package/src/services/essbasic/v20210526/essbasic_models.ts +3 -2
  23. package/src/services/gaap/v20180529/gaap_models.ts +11 -1
  24. package/src/services/iecp/v20210914/iecp_client.ts +80 -40
  25. package/src/services/ims/v20201229/ims_client.ts +4 -3
  26. package/src/services/lke/v20231130/lke_client.ts +61 -18
  27. package/src/services/lke/v20231130/lke_models.ts +370 -83
  28. package/src/services/monitor/v20180724/monitor_models.ts +4 -0
  29. package/src/services/ocr/v20181119/ocr_models.ts +22 -16
  30. package/src/services/pts/v20210728/pts_models.ts +1 -1
  31. package/src/services/redis/v20180412/redis_client.ts +2 -2
  32. package/src/services/redis/v20180412/redis_models.ts +37 -16
  33. package/src/services/sms/v20210111/sms_client.ts +36 -68
  34. package/src/services/tcr/v20190924/tcr_models.ts +1 -1
  35. package/src/services/tke/v20180525/tke_client.ts +13 -0
  36. package/src/services/tke/v20180525/tke_models.ts +117 -28
  37. package/src/services/tse/v20201207/tse_models.ts +7 -1
  38. package/src/services/tsf/v20180326/tsf_client.ts +4 -2
  39. package/src/services/tsf/v20180326/tsf_models.ts +1 -1
  40. package/src/services/waf/v20180125/waf_client.ts +6 -5
  41. package/src/services/waf/v20180125/waf_models.ts +112 -84
  42. package/src/services/wedata/v20210820/wedata_client.ts +13 -1
  43. package/src/services/wedata/v20210820/wedata_models.ts +55 -9
  44. package/tencentcloud/common/sdk_version.d.ts +1 -1
  45. package/tencentcloud/common/sdk_version.js +1 -1
  46. package/tencentcloud/services/cdwch/v20200915/cdwch_models.d.ts +8 -8
  47. package/tencentcloud/services/cdwdoris/v20211228/cdwdoris_models.d.ts +8 -0
  48. package/tencentcloud/services/cfw/v20190904/cfw_models.d.ts +4 -4
  49. package/tencentcloud/services/ckafka/v20190819/ckafka_client.d.ts +0 -1
  50. package/tencentcloud/services/ckafka/v20190819/ckafka_client.js +0 -1
  51. package/tencentcloud/services/ckafka/v20190819/ckafka_models.d.ts +71 -46
  52. package/tencentcloud/services/csip/v20221121/csip_client.d.ts +9 -1
  53. package/tencentcloud/services/csip/v20221121/csip_client.js +12 -0
  54. package/tencentcloud/services/csip/v20221121/csip_models.d.ts +377 -31
  55. package/tencentcloud/services/cynosdb/v20190107/cynosdb_models.d.ts +210 -29
  56. package/tencentcloud/services/dlc/v20210125/dlc_client.d.ts +5 -1
  57. package/tencentcloud/services/dlc/v20210125/dlc_client.js +6 -0
  58. package/tencentcloud/services/dlc/v20210125/dlc_models.d.ts +17 -0
  59. package/tencentcloud/services/dsgc/v20190723/dsgc_models.d.ts +5 -5
  60. package/tencentcloud/services/emr/v20190103/emr_models.d.ts +1 -1
  61. package/tencentcloud/services/ess/v20201111/ess_client.d.ts +2 -2
  62. package/tencentcloud/services/ess/v20201111/ess_client.js +2 -2
  63. package/tencentcloud/services/ess/v20201111/ess_models.d.ts +3 -2
  64. package/tencentcloud/services/essbasic/v20210526/essbasic_client.d.ts +13 -2
  65. package/tencentcloud/services/essbasic/v20210526/essbasic_client.js +13 -2
  66. package/tencentcloud/services/essbasic/v20210526/essbasic_models.d.ts +3 -2
  67. package/tencentcloud/services/gaap/v20180529/gaap_models.d.ts +11 -1
  68. package/tencentcloud/services/iecp/v20210914/iecp_client.d.ts +60 -20
  69. package/tencentcloud/services/iecp/v20210914/iecp_client.js +60 -20
  70. package/tencentcloud/services/ims/v20201229/ims_client.d.ts +4 -3
  71. package/tencentcloud/services/ims/v20201229/ims_client.js +4 -3
  72. package/tencentcloud/services/lke/v20231130/lke_client.d.ts +17 -5
  73. package/tencentcloud/services/lke/v20231130/lke_client.js +24 -6
  74. package/tencentcloud/services/lke/v20231130/lke_models.d.ts +358 -84
  75. package/tencentcloud/services/monitor/v20180724/monitor_models.d.ts +4 -0
  76. package/tencentcloud/services/ocr/v20181119/ocr_models.d.ts +22 -16
  77. package/tencentcloud/services/pts/v20210728/pts_models.d.ts +1 -1
  78. package/tencentcloud/services/redis/v20180412/redis_client.d.ts +2 -2
  79. package/tencentcloud/services/redis/v20180412/redis_client.js +2 -2
  80. package/tencentcloud/services/redis/v20180412/redis_models.d.ts +37 -16
  81. package/tencentcloud/services/sms/v20210111/sms_client.d.ts +33 -65
  82. package/tencentcloud/services/sms/v20210111/sms_client.js +33 -65
  83. package/tencentcloud/services/tcr/v20190924/tcr_models.d.ts +1 -1
  84. package/tencentcloud/services/tke/v20180525/tke_client.d.ts +5 -1
  85. package/tencentcloud/services/tke/v20180525/tke_client.js +6 -0
  86. package/tencentcloud/services/tke/v20180525/tke_models.d.ts +114 -28
  87. package/tencentcloud/services/tse/v20201207/tse_models.d.ts +7 -1
  88. package/tencentcloud/services/tsf/v20180326/tsf_client.d.ts +3 -1
  89. package/tencentcloud/services/tsf/v20180326/tsf_client.js +3 -1
  90. package/tencentcloud/services/tsf/v20180326/tsf_models.d.ts +1 -1
  91. package/tencentcloud/services/waf/v20180125/waf_client.d.ts +1 -1
  92. package/tencentcloud/services/waf/v20180125/waf_models.d.ts +110 -83
  93. package/tencentcloud/services/wedata/v20210820/wedata_client.d.ts +6 -2
  94. package/tencentcloud/services/wedata/v20210820/wedata_client.js +7 -1
  95. package/tencentcloud/services/wedata/v20210820/wedata_models.d.ts +53 -9
  96. package/test/csip.v20221121.test.js +20 -0
  97. package/test/dlc.v20210125.test.js +10 -0
  98. package/test/lke.v20231130.test.js +34 -4
  99. package/test/tke.v20180525.test.js +10 -0
  100. package/test/wedata.v20210820.test.js +10 -0
@@ -514,7 +514,7 @@ class Client extends abstract_client_1.AbstractClient {
514
514
  return this.request("DescribeReplicationGroup", req, cb);
515
515
  }
516
516
  /**
517
- * 查询实例续费价格(包年包月)
517
+ * 本接口(InquiryPriceRenewInstance)用于查询包年包月计费实例的续费价格。
518
518
  */
519
519
  async InquiryPriceRenewInstance(req, cb) {
520
520
  return this.request("InquiryPriceRenewInstance", req, cb);
@@ -616,7 +616,7 @@ class Client extends abstract_client_1.AbstractClient {
616
616
  return this.request("ApplyParamsTemplate", req, cb);
617
617
  }
618
618
  /**
619
- * 查询实例维护时间窗,在实例需要进行版本升级或者架构升级的时候,会在维护时间窗时间内进行切换
619
+ * 本接口(DescribeMaintenanceWindow)用于查询实例维护时间窗。在实例需要进行版本升级或者架构升级的时候,会在维护时间窗时间内进行切换
620
620
  */
621
621
  async DescribeMaintenanceWindow(req, cb) {
622
622
  return this.request("DescribeMaintenanceWindow", req, cb);
@@ -1763,7 +1763,7 @@ export interface AddReplicationInstanceResponse {
1763
1763
  /**
1764
1764
  * 异步流程ID。
1765
1765
  */
1766
- TaskId: number;
1766
+ TaskId?: number;
1767
1767
  /**
1768
1768
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
1769
1769
  */
@@ -2030,7 +2030,7 @@ export interface DescribeProductInfoResponse {
2030
2030
  /**
2031
2031
  * 地域售卖信息。
2032
2032
  */
2033
- RegionSet: Array<RegionConf>;
2033
+ RegionSet?: Array<RegionConf>;
2034
2034
  /**
2035
2035
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2036
2036
  */
@@ -2127,7 +2127,7 @@ export interface DescribeBackupUrlResponse {
2127
2127
  */
2128
2128
  export interface InquiryPriceRenewInstanceResponse {
2129
2129
  /**
2130
- * 价格,单位:分
2130
+ * 价格,单位:分。
2131
2131
  注意:此字段可能返回 null,表示取不到有效值。
2132
2132
  */
2133
2133
  Price?: number;
@@ -2162,7 +2162,7 @@ export interface InquiryPriceCreateInstanceResponse {
2162
2162
  * 价格,单位:分
2163
2163
  注意:此字段可能返回 null,表示取不到有效值。
2164
2164
  */
2165
- Price: number;
2165
+ Price?: number;
2166
2166
  /**
2167
2167
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2168
2168
  */
@@ -3499,11 +3499,14 @@ export interface EnableReplicaReadonlyResponse {
3499
3499
  */
3500
3500
  export interface DescribeMaintenanceWindowResponse {
3501
3501
  /**
3502
- * 维护时间窗起始时间,如:17:00
3502
+ * 维护时间窗开始时间。取值范围为"00:00-23:00"的任意时间点,如03:24。
3503
3503
  */
3504
3504
  StartTime?: string;
3505
3505
  /**
3506
- * 维护时间窗结束时间,如:19:00
3506
+ * 维护时间窗结束时间。
3507
+ - 取值范围为"00:00-23:00"的任意时间点,如:04:24。
3508
+ - 维护时间持续时长最小为30分钟,最大为3小时。
3509
+ - 结束时间务必是基于开始时间向后的时间。
3507
3510
  */
3508
3511
  EndTime?: string;
3509
3512
  /**
@@ -3904,7 +3907,7 @@ export interface DeleteReplicationInstanceResponse {
3904
3907
  /**
3905
3908
  * 异步任务ID
3906
3909
  */
3907
- TaskId: number;
3910
+ TaskId?: number;
3908
3911
  /**
3909
3912
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
3910
3913
  */
@@ -4760,11 +4763,11 @@ export interface ReleaseWanAddressRequest {
4760
4763
  */
4761
4764
  export interface InquiryPriceRenewInstanceRequest {
4762
4765
  /**
4763
- * 购买时长,单位:月
4766
+ * 包年包月实例的购买时长,单位:月。
4764
4767
  */
4765
4768
  Period: number;
4766
4769
  /**
4767
- * 实例ID
4770
+ * 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
4768
4771
  */
4769
4772
  InstanceId: string;
4770
4773
  }
@@ -4872,7 +4875,16 @@ export interface DescribeCommonDBInstancesResponse {
4872
4875
  */
4873
4876
  export interface InquiryPriceCreateInstanceRequest {
4874
4877
  /**
4875
- * 实例类型:2 – Redis2.8内存版(标准架构),3 – CKV 3.2内存版(标准架构),4 – CKV 3.2内存版(集群架构),6 – Redis4.0内存版(标准架构),7 – Redis4.0内存版(集群架构),8 – Redis5.0内存版(标准架构),9 – Redis5.0内存版(集群架构)。
4878
+ * 实例类型。
4879
+ - 2:Redis 2.8 内存版(标准架构)。
4880
+ - 6:Redis 4.0 内存版(标准架构)。
4881
+ - 7:Redis 4.0 内存版(集群架构)。
4882
+ - 8:Redis 5.0 内存版(标准架构)。
4883
+ - 9:Redis 5.0 内存版(集群架构)。
4884
+ - 15:Redis 6.2 内存版(标准架构)。
4885
+ - 16:Redis 6.2 内存版(集群架构)。
4886
+ - 17:Redis 7.0 内存版(标准架构)。
4887
+ - 18:Redis 7.0 内存版(集群架构)。
4876
4888
  */
4877
4889
  TypeId: number;
4878
4890
  /**
@@ -4889,7 +4901,9 @@ export interface InquiryPriceCreateInstanceRequest {
4889
4901
  */
4890
4902
  Period: number;
4891
4903
  /**
4892
- * 付费方式:0-按量计费,1-包年包月。
4904
+ * 付费方式。
4905
+ - 0:按量计费。
4906
+ - 1:包年包月。
4893
4907
  */
4894
4908
  BillingMode: number;
4895
4909
  /**
@@ -4897,15 +4911,19 @@ export interface InquiryPriceCreateInstanceRequest {
4897
4911
  */
4898
4912
  ZoneId?: number;
4899
4913
  /**
4900
- * 实例分片数量,Redis2.8标准架构、CKV标准架构和Redis2.8单机版、Redis4.0标准架构不需要填写。
4914
+ * 实例分片数量。
4915
+ Redis2.8标准架构、CKV标准架构、Redis4.0标准架构无需填写。
4901
4916
  */
4902
4917
  RedisShardNum?: number;
4903
4918
  /**
4904
- * 实例副本数量,Redis2.8标准架构、CKV标准架构和Redis2.8单机版不需要填写。
4919
+ * 实例副本数量。
4920
+ Redis2.8标准架构、CKV标准架构无需填写。
4905
4921
  */
4906
4922
  RedisReplicasNum?: number;
4907
4923
  /**
4908
- * 是否支持副本只读,Redis2.8标准架构、CKV标准架构和Redis2.8单机版不需要填写。
4924
+ * 是否支持副本只读。Redis2.8标准架构、CKV标准架构无需填写。
4925
+ - true:无需支持副本只读。
4926
+ - false:需支持。
4909
4927
  */
4910
4928
  ReplicasReadonly?: boolean;
4911
4929
  /**
@@ -4913,7 +4931,10 @@ export interface InquiryPriceCreateInstanceRequest {
4913
4931
  */
4914
4932
  ZoneName?: string;
4915
4933
  /**
4916
- * "local"本地盘版,"cloud"云盘版,"cdc"独享集群版,如果不传默认询价为本地盘版本
4934
+ * 部署方式。
4935
+ - local:本地盘版,默认为 local。
4936
+ - cloud:云盘版。
4937
+ - cdc:独享集群版。
4917
4938
  */
4918
4939
  ProductVersion?: string;
4919
4940
  }
@@ -5025,7 +5046,7 @@ export interface DescribeInstanceNodeInfoRequest {
5025
5046
  */
5026
5047
  export interface DescribeMaintenanceWindowRequest {
5027
5048
  /**
5028
- * 实例ID
5049
+ * 指定实例 ID。例如:crs-xjhsdj****。请登录[Redis控制台](https://console.cloud.tencent.com/redis)在实例列表复制实例 ID。
5029
5050
  */
5030
5051
  InstanceId: string;
5031
5052
  }
@@ -8,122 +8,90 @@ import { PullSmsReplyStatusRequest, DeleteSmsTemplateResponse, ModifySmsTemplate
8
8
  export declare class Client extends AbstractClient {
9
9
  constructor(clientConfig: ClientConfig);
10
10
  /**
11
- * 1. 修改短信签名,修改之前请先认真参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)
12
- 2. ⚠️注意:个人认证用户不支持使用 API 修改短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 修改短信签名。
13
- 3. 修改短信签名,仅当签名为**待审核**或**已拒绝**状态时,才能进行修改,**已审核通过**的签名不支持修改。
14
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
15
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
11
+ * 本接口 (ModifySmsSign) 用于修改短信签名。
12
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>修改短信签名前,请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信签名,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信签名。</li><li>修改短信签名,仅当签名为<b>待审核</b>或<b>已拒绝</b>状态时,才能进行修改,<b>已审核通过</b>的签名不支持修改。</li></ul></blockquote>
16
13
  */
17
14
  ModifySmsSign(req: ModifySmsSignRequest, cb?: (error: string, rep: ModifySmsSignResponse) => void): Promise<ModifySmsSignResponse>;
18
15
  /**
19
- * 1. 添加短信签名,申请之前请先认真参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)
20
- 2. ⚠️注意:个人认证用户不支持使用 API 申请短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录控制台申请短信签名。
21
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
22
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
16
+ * 本接口 (AddSmsSign) 用于添加短信签名。
17
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>添加短信签名前,请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信签名,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信签名。</li></ul></blockquote>
23
18
  */
24
19
  AddSmsSign(req: AddSmsSignRequest, cb?: (error: string, rep: AddSmsSignResponse) => void): Promise<AddSmsSignResponse>;
25
20
  /**
26
- * 拉取短信下发状态。
27
- 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。
28
- >- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
29
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
30
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
21
+ * 本接口 (PullSmsSendStatus) 用于拉取短信下发状态。
22
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。</li><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#.E7.9F.AD.E4.BF.A1.E7.8A.B6.E6.80.81.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE">配置回调</a> 的方式获取。</li></ul></blockquote>
31
23
  */
32
24
  PullSmsSendStatus(req: PullSmsSendStatusRequest, cb?: (error: string, rep: PullSmsSendStatusResponse) => void): Promise<PullSmsSendStatusResponse>;
33
25
  /**
34
- * 短信发送接口,用于给用户发短信验证码、通知类短信或营销短信。
35
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。
36
- >- 注:您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
37
- >- 注:当前接口属于 2021-01-11 版本,如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778),建议您使用当前最新版本的接口,版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。
26
+ * 本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。
27
+ - 当前接口属于 2021-01-11 版本,如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778),建议您使用当前最新版本的接口,版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。
38
28
  */
39
29
  SendSms(req: SendSmsRequest, cb?: (error: string, rep: SendSmsResponse) => void): Promise<SendSmsResponse>;
40
30
  /**
41
- * ⚠️注意:个人认证用户不支持使用 API 删除短信正文模板,请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信正文模板,如需了解请参阅 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
42
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
43
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
31
+ * 本接口 (DeleteSmsTemplate) 用于删除短信模板。
32
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信正文模板,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信正文模板。</li></ul></blockquote>
44
33
  */
45
34
  DeleteSmsTemplate(req: DeleteSmsTemplateRequest, cb?: (error: string, rep: DeleteSmsTemplateResponse) => void): Promise<DeleteSmsTemplateResponse>;
46
35
  /**
47
- * 用户套餐包信息统计。
48
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
49
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
36
+ * 本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。
50
37
  */
51
38
  SmsPackagesStatistics(req: SmsPackagesStatisticsRequest, cb?: (error: string, rep: SmsPackagesStatisticsResponse) => void): Promise<SmsPackagesStatisticsResponse>;
52
39
  /**
53
- * 统计用户发送短信的数据。
54
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
55
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
40
+ * 本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
56
41
  */
57
42
  SendStatusStatistics(req: SendStatusStatisticsRequest, cb?: (error: string, rep: SendStatusStatisticsResponse) => void): Promise<SendStatusStatisticsResponse>;
58
43
  /**
59
- * 统计用户回执的数据。
60
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
61
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
44
+ * 本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
62
45
  */
63
46
  CallbackStatusStatistics(req: CallbackStatusStatisticsRequest, cb?: (error: string, rep: CallbackStatusStatisticsResponse) => void): Promise<CallbackStatusStatisticsResponse>;
64
47
  /**
65
- * ⚠️注意:个人认证用户不支持使用 API 查询短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)
66
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
67
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
48
+ * 本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。
49
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信正文模板,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信正文模板。</li></ul></blockquote>
68
50
  */
69
51
  DescribeSmsTemplateList(req: DescribeSmsTemplateListRequest, cb?: (error: string, rep: DescribeSmsTemplateListResponse) => void): Promise<DescribeSmsTemplateListResponse>;
70
52
  /**
71
- * 拉取短信回复状态。
72
- 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。
73
- >- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
74
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
75
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
53
+ * 本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。
54
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。</li><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
76
55
  */
77
56
  PullSmsReplyStatus(req: PullSmsReplyStatusRequest, cb?: (error: string, rep: PullSmsReplyStatusResponse) => void): Promise<PullSmsReplyStatusResponse>;
78
57
  /**
79
- * ⚠️注意:个人认证用户不支持使用 API 查询短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 查询短信签名。
80
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
81
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
58
+ * 本接口 (DescribeSmsSignList) 用于查询短信签名状态。
59
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信签名,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信签名。</li></ul></blockquote>
82
60
  */
83
61
  DescribeSmsSignList(req: DescribeSmsSignListRequest, cb?: (error: string, rep: DescribeSmsSignListResponse) => void): Promise<DescribeSmsSignListResponse>;
84
62
  /**
85
- * 拉取单个号码短信下发状态。
86
- 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。
87
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
88
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
63
+ * 本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。
64
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#.E7.9F.AD.E4.BF.A1.E7.8A.B6.E6.80.81.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE">配置回调</a> 的方式获取。</li></ul></blockquote>
89
65
  */
90
66
  PullSmsSendStatusByPhoneNumber(req: PullSmsSendStatusByPhoneNumberRequest, cb?: (error: string, rep: PullSmsSendStatusByPhoneNumberResponse) => void): Promise<PullSmsSendStatusByPhoneNumberResponse>;
91
67
  /**
92
- * 短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
93
- >- 注:当前接口以白名单方式对外开放,如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
68
+ * 本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
69
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>该接口当前以白名单方式对外开放,如有需要请联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。</li></ul></blockquote>
94
70
  */
95
71
  ReportConversion(req: ReportConversionRequest, cb?: (error: string, rep: ReportConversionResponse) => void): Promise<ReportConversionResponse>;
96
72
  /**
97
- * 1. 修改短信正文模板,修改之前请先认真参阅 [腾讯云短信正文模板审核标准](https://cloud.tencent.com/document/product/382/39023)
98
- 2. ⚠️注意:个人认证用户不支持使用 API 修改短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 修改短信正文模板。
99
- 3. 修改短信模板,仅当正文模板为**待审核**或**已拒绝**状态时,才能进行修改,**已审核通过**的正文模板不支持修改。
100
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
101
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
73
+ * 本接口 (ModifySmsTemplate) 用于修改短信模板。
74
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>修改短信正文模板前,请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信正文模板,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信正文模板。</li><li>修改短信模板,仅当正文模板为<b>待审核</b>或<b>已拒绝</b>状态时,才能进行修改,<b>已审核通过</b>的正文模板不支持修改。</li></ul></blockquote>
102
75
  */
103
76
  ModifySmsTemplate(req: ModifySmsTemplateRequest, cb?: (error: string, rep: ModifySmsTemplateResponse) => void): Promise<ModifySmsTemplateResponse>;
104
77
  /**
105
- * 拉取单个号码短信回复状态。
106
- 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。
107
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
108
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
78
+ * 本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。
79
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
109
80
  */
110
81
  PullSmsReplyStatusByPhoneNumber(req: PullSmsReplyStatusByPhoneNumberRequest, cb?: (error: string, rep: PullSmsReplyStatusByPhoneNumberResponse) => void): Promise<PullSmsReplyStatusByPhoneNumberResponse>;
111
82
  /**
112
- * 提供电话号码的信息查询,包括国家(或地区)码、规范的 E.164 格式号码等。
113
- >- 例如:查询号码 +86018845720123,可以得到国家码 86、规范的 E.164 号码 +8618845720123 等信息。
83
+ * 本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询,包括国家(或地区)码、规范的 E.164 格式号码等。
84
+ - 例如:查询号码 +86018845720123,可以得到国家码 86、规范的 E.164 号码 +8618845720123 等信息。
114
85
  */
115
86
  DescribePhoneNumberInfo(req: DescribePhoneNumberInfoRequest, cb?: (error: string, rep: DescribePhoneNumberInfoResponse) => void): Promise<DescribePhoneNumberInfoResponse>;
116
87
  /**
117
- * ⚠️注意:个人认证用户不支持使用 API 删除短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信签名。
118
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
119
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
88
+ * 本接口 (DeleteSmsSign) 用于删除短信签名。
89
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信签名,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信签名。</li></ul></blockquote>
120
90
  */
121
91
  DeleteSmsSign(req: DeleteSmsSignRequest, cb?: (error: string, rep: DeleteSmsSignResponse) => void): Promise<DeleteSmsSignResponse>;
122
92
  /**
123
- * 1. 添加短信模板,申请之前请先认真参阅 [腾讯云短信正文模板审核标准](https://cloud.tencent.com/document/product/382/39023)
124
- 2. ⚠️注意:个人认证用户不支持使用 API 申请短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 申请短信正文模板。
125
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
126
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
93
+ * 本接口 (AddSmsTemplate) 用于创建短信模板。
94
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>申请短信模板前,请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信正文模板,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信正文模板。</li></ul></blockquote>
127
95
  */
128
96
  AddSmsTemplate(req: AddSmsTemplateRequest, cb?: (error: string, rep: AddSmsTemplateResponse) => void): Promise<AddSmsTemplateResponse>;
129
97
  }
@@ -28,156 +28,124 @@ class Client extends abstract_client_1.AbstractClient {
28
28
  super("sms.tencentcloudapi.com", "2021-01-11", clientConfig);
29
29
  }
30
30
  /**
31
- * 1. 修改短信签名,修改之前请先认真参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)
32
- 2. ⚠️注意:个人认证用户不支持使用 API 修改短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 修改短信签名。
33
- 3. 修改短信签名,仅当签名为**待审核**或**已拒绝**状态时,才能进行修改,**已审核通过**的签名不支持修改。
34
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
35
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
31
+ * 本接口 (ModifySmsSign) 用于修改短信签名。
32
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>修改短信签名前,请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信签名,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信签名。</li><li>修改短信签名,仅当签名为<b>待审核</b>或<b>已拒绝</b>状态时,才能进行修改,<b>已审核通过</b>的签名不支持修改。</li></ul></blockquote>
36
33
  */
37
34
  async ModifySmsSign(req, cb) {
38
35
  return this.request("ModifySmsSign", req, cb);
39
36
  }
40
37
  /**
41
- * 1. 添加短信签名,申请之前请先认真参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)
42
- 2. ⚠️注意:个人认证用户不支持使用 API 申请短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录控制台申请短信签名。
43
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
44
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
38
+ * 本接口 (AddSmsSign) 用于添加短信签名。
39
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>添加短信签名前,请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39022">腾讯云短信签名审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信签名,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信签名。</li></ul></blockquote>
45
40
  */
46
41
  async AddSmsSign(req, cb) {
47
42
  return this.request("AddSmsSign", req, cb);
48
43
  }
49
44
  /**
50
- * 拉取短信下发状态。
51
- 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。
52
- >- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
53
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
54
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
45
+ * 本接口 (PullSmsSendStatus) 用于拉取短信下发状态。
46
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。</li><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#.E7.9F.AD.E4.BF.A1.E7.8A.B6.E6.80.81.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE">配置回调</a> 的方式获取。</li></ul></blockquote>
55
47
  */
56
48
  async PullSmsSendStatus(req, cb) {
57
49
  return this.request("PullSmsSendStatus", req, cb);
58
50
  }
59
51
  /**
60
- * 短信发送接口,用于给用户发短信验证码、通知类短信或营销短信。
61
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。
62
- >- 注:您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
63
- >- 注:当前接口属于 2021-01-11 版本,如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778),建议您使用当前最新版本的接口,版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。
52
+ * 本接口 (SendSms) 用于发送验证码、通知类短信和营销短信。支持国内短信与国际/港澳台短信。
53
+ - 当前接口属于 2021-01-11 版本,如果您仍在使用 [2019-07-11 版本](https://cloud.tencent.com/document/product/382/38778),建议您使用当前最新版本的接口,版本差异可参考[版本描述](https://cloud.tencent.com/document/product/382/63195#.E7.89.88.E6.9C.AC.E6.8F.8F.E8.BF.B0)。
64
54
  */
65
55
  async SendSms(req, cb) {
66
56
  return this.request("SendSms", req, cb);
67
57
  }
68
58
  /**
69
- * ⚠️注意:个人认证用户不支持使用 API 删除短信正文模板,请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信正文模板,如需了解请参阅 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
70
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
71
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
59
+ * 本接口 (DeleteSmsTemplate) 用于删除短信模板。
60
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信正文模板,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信正文模板。</li></ul></blockquote>
72
61
  */
73
62
  async DeleteSmsTemplate(req, cb) {
74
63
  return this.request("DeleteSmsTemplate", req, cb);
75
64
  }
76
65
  /**
77
- * 用户套餐包信息统计。
78
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
79
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
66
+ * 本接口 (SmsPackagesStatistics) 用于统计用户套餐包数据。
80
67
  */
81
68
  async SmsPackagesStatistics(req, cb) {
82
69
  return this.request("SmsPackagesStatistics", req, cb);
83
70
  }
84
71
  /**
85
- * 统计用户发送短信的数据。
86
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
87
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
72
+ * 本接口 (SendStatusStatistics) 用于统计用户发送短信的数据。
88
73
  */
89
74
  async SendStatusStatistics(req, cb) {
90
75
  return this.request("SendStatusStatistics", req, cb);
91
76
  }
92
77
  /**
93
- * 统计用户回执的数据。
94
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
95
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
78
+ * 本接口 (CallbackStatusStatistics) 用于统计用户回执的数据。
96
79
  */
97
80
  async CallbackStatusStatistics(req, cb) {
98
81
  return this.request("CallbackStatusStatistics", req, cb);
99
82
  }
100
83
  /**
101
- * ⚠️注意:个人认证用户不支持使用 API 查询短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)
102
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
103
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
84
+ * 本接口 (DescribeSmsTemplateList) 用于查询短信模板状态。
85
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信正文模板,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信正文模板。</li></ul></blockquote>
104
86
  */
105
87
  async DescribeSmsTemplateList(req, cb) {
106
88
  return this.request("DescribeSmsTemplateList", req, cb);
107
89
  }
108
90
  /**
109
- * 拉取短信回复状态。
110
- 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。
111
- >- 注:此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
112
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
113
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
91
+ * 本接口 (PullSmsReplyStatus) 用于拉取短信回复状态。
92
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>此接口需要联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。</li><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
114
93
  */
115
94
  async PullSmsReplyStatus(req, cb) {
116
95
  return this.request("PullSmsReplyStatus", req, cb);
117
96
  }
118
97
  /**
119
- * ⚠️注意:个人认证用户不支持使用 API 查询短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 查询短信签名。
120
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
121
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
98
+ * 本接口 (DescribeSmsSignList) 用于查询短信签名状态。
99
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>个人认证用户不支持使用 API 查询短信签名,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 查询短信签名。</li></ul></blockquote>
122
100
  */
123
101
  async DescribeSmsSignList(req, cb) {
124
102
  return this.request("DescribeSmsSignList", req, cb);
125
103
  }
126
104
  /**
127
- * 拉取单个号码短信下发状态。
128
- 目前也支持 [配置回调](https://cloud.tencent.com/document/product/382/37809#.E8.AE.BE.E7.BD.AE.E4.BA.8B.E4.BB.B6.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE) 的方式来获取下发状态。
129
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
130
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
105
+ * 本接口 (PullSmsSendStatusByPhoneNumber) 用于拉取单个号码短信下发状态。
106
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>下发状态也支持 <a href="https://cloud.tencent.com/document/product/382/37809#.E7.9F.AD.E4.BF.A1.E7.8A.B6.E6.80.81.E5.9B.9E.E8.B0.83.E9.85.8D.E7.BD.AE">配置回调</a> 的方式获取。</li></ul></blockquote>
131
107
  */
132
108
  async PullSmsSendStatusByPhoneNumber(req, cb) {
133
109
  return this.request("PullSmsSendStatusByPhoneNumber", req, cb);
134
110
  }
135
111
  /**
136
- * 短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
137
- >- 注:当前接口以白名单方式对外开放,如有需要请联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
112
+ * 本接口 (ReportConversion) 用于短信转化率上报。将已接收到短信的流水号上报到腾讯云短信服务。
113
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>该接口当前以白名单方式对外开放,如有需要请联系 <a href="https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81">腾讯云短信小助手</a> 开通。</li></ul></blockquote>
138
114
  */
139
115
  async ReportConversion(req, cb) {
140
116
  return this.request("ReportConversion", req, cb);
141
117
  }
142
118
  /**
143
- * 1. 修改短信正文模板,修改之前请先认真参阅 [腾讯云短信正文模板审核标准](https://cloud.tencent.com/document/product/382/39023)
144
- 2. ⚠️注意:个人认证用户不支持使用 API 修改短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 修改短信正文模板。
145
- 3. 修改短信模板,仅当正文模板为**待审核**或**已拒绝**状态时,才能进行修改,**已审核通过**的正文模板不支持修改。
146
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
147
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
119
+ * 本接口 (ModifySmsTemplate) 用于修改短信模板。
120
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>修改短信正文模板前,请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 修改短信正文模板,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 修改短信正文模板。</li><li>修改短信模板,仅当正文模板为<b>待审核</b>或<b>已拒绝</b>状态时,才能进行修改,<b>已审核通过</b>的正文模板不支持修改。</li></ul></blockquote>
148
121
  */
149
122
  async ModifySmsTemplate(req, cb) {
150
123
  return this.request("ModifySmsTemplate", req, cb);
151
124
  }
152
125
  /**
153
- * 拉取单个号码短信回复状态。
154
- 目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。
155
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
156
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
126
+ * 本接口 (PullSmsReplyStatusByPhoneNumber) 用于拉取单个号码短信回复状态。
127
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>上行回复也支持 <a href="https://cloud.tencent.com/document/product/382/42907">配置回复回调</a> 的方式获取。</li></ul></blockquote>
157
128
  */
158
129
  async PullSmsReplyStatusByPhoneNumber(req, cb) {
159
130
  return this.request("PullSmsReplyStatusByPhoneNumber", req, cb);
160
131
  }
161
132
  /**
162
- * 提供电话号码的信息查询,包括国家(或地区)码、规范的 E.164 格式号码等。
163
- >- 例如:查询号码 +86018845720123,可以得到国家码 86、规范的 E.164 号码 +8618845720123 等信息。
133
+ * 本接口 (DescribePhoneNumberInfo) 用于提供电话号码的信息查询,包括国家(或地区)码、规范的 E.164 格式号码等。
134
+ - 例如:查询号码 +86018845720123,可以得到国家码 86、规范的 E.164 号码 +8618845720123 等信息。
164
135
  */
165
136
  async DescribePhoneNumberInfo(req, cb) {
166
137
  return this.request("DescribePhoneNumberInfo", req, cb);
167
138
  }
168
139
  /**
169
- * ⚠️注意:个人认证用户不支持使用 API 删除短信签名,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信签名。
170
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
171
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
140
+ * 本接口 (DeleteSmsSign) 用于删除短信签名。
141
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>个人认证用户不支持使用 API 删除短信签名,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 删除短信签名。</li></ul></blockquote>
172
142
  */
173
143
  async DeleteSmsSign(req, cb) {
174
144
  return this.request("DeleteSmsSign", req, cb);
175
145
  }
176
146
  /**
177
- * 1. 添加短信模板,申请之前请先认真参阅 [腾讯云短信正文模板审核标准](https://cloud.tencent.com/document/product/382/39023)
178
- 2. ⚠️注意:个人认证用户不支持使用 API 申请短信正文模板,请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 申请短信正文模板。
179
- >- 注:由于云 **API3.0 安全性**有所提升,所以**接口鉴权**较为复杂,建议使用 SDK 来使用云短信服务。
180
- >- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口,可以先免去签名计算步骤。运行成功后,API Explorer可以**自动生成**SDK代码示例。
147
+ * 本接口 (AddSmsTemplate) 用于创建短信模板。
148
+ <blockquote class="d-mod-explain"><div class="d-mod-title d-explain-title" style="line-height: normal;"><i class="d-icon-explain"></i>说明:</div><p></p><ul><li>申请短信模板前,请先认真参阅 <a href="https://cloud.tencent.com/document/product/382/39023">腾讯云短信正文模板审核标准。</a></li><li>个人认证用户不支持使用 API 申请短信正文模板,请参阅了解 <a href="https://cloud.tencent.com/document/product/378/3629">实名认证基本介绍</a>,如果为个人认证请登录 <a href="https://console.cloud.tencent.com/smsv2">控制台</a> 申请短信正文模板。</li></ul></blockquote>
181
149
  */
182
150
  async AddSmsTemplate(req, cb) {
183
151
  return this.request("AddSmsTemplate", req, cb);
@@ -2541,7 +2541,7 @@ export interface DescribeImageFilterPersonalResponse {
2541
2541
  /**
2542
2542
  * 返回tag镜像内容相同的tag列表
2543
2543
  */
2544
- Data: SameImagesResp;
2544
+ Data?: SameImagesResp;
2545
2545
  /**
2546
2546
  * 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。
2547
2547
  */