tencentcloud-sdk-nodejs 3.0.267 → 3.0.270

package/tencentcloud/sms/v20210111/sms_client.js

@@ -0,0 +1,324 @@
+/*
+ * Copyright (c) 2018 THL A29 Limited, a Tencent company. All Rights Reserved.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+const models = require("./models");
+const AbstractClient = require('../../common/abstract_client')
+const PullSmsReplyStatusRequest = models.PullSmsReplyStatusRequest;
+const DeleteSmsTemplateResponse = models.DeleteSmsTemplateResponse;
+const ModifySmsTemplateResponse = models.ModifySmsTemplateResponse;
+const ModifySmsSignRequest = models.ModifySmsSignRequest;
+const SmsPackagesStatisticsRequest = models.SmsPackagesStatisticsRequest;
+const AddSmsSignRequest = models.AddSmsSignRequest;
+const AddTemplateStatus = models.AddTemplateStatus;
+const DescribeSmsTemplateListResponse = models.DescribeSmsTemplateListResponse;
+const DescribePhoneNumberInfoRequest = models.DescribePhoneNumberInfoRequest;
+const PullSmsSendStatusByPhoneNumberRequest = models.PullSmsSendStatusByPhoneNumberRequest;
+const AddSmsTemplateRequest = models.AddSmsTemplateRequest;
+const ModifySmsTemplateRequest = models.ModifySmsTemplateRequest;
+const PullSmsReplyStatus = models.PullSmsReplyStatus;
+const CallbackStatusStatisticsResponse = models.CallbackStatusStatisticsResponse;
+const PullSmsSendStatusRequest = models.PullSmsSendStatusRequest;
+const SmsPackagesStatistics = models.SmsPackagesStatistics;
+const PullSmsSendStatusByPhoneNumberResponse = models.PullSmsSendStatusByPhoneNumberResponse;
+const ModifySignStatus = models.ModifySignStatus;
+const DescribeSignListStatus = models.DescribeSignListStatus;
+const SendSmsResponse = models.SendSmsResponse;
+const SendStatusStatisticsResponse = models.SendStatusStatisticsResponse;
+const SendSmsRequest = models.SendSmsRequest;
+const SendStatusStatistics = models.SendStatusStatistics;
+const CallbackStatusStatisticsRequest = models.CallbackStatusStatisticsRequest;
+const DeleteTemplateStatus = models.DeleteTemplateStatus;
+const DescribeSmsSignListRequest = models.DescribeSmsSignListRequest;
+const DescribePhoneNumberInfoResponse = models.DescribePhoneNumberInfoResponse;
+const DescribeTemplateListStatus = models.DescribeTemplateListStatus;
+const AddSmsTemplateResponse = models.AddSmsTemplateResponse;
+const PullSmsSendStatus = models.PullSmsSendStatus;
+const DescribeSmsSignListResponse = models.DescribeSmsSignListResponse;
+const DescribeSmsTemplateListRequest = models.DescribeSmsTemplateListRequest;
+const CallbackStatusStatistics = models.CallbackStatusStatistics;
+const PhoneNumberInfo = models.PhoneNumberInfo;
+const SendStatusStatisticsRequest = models.SendStatusStatisticsRequest;
+const DeleteSmsTemplateRequest = models.DeleteSmsTemplateRequest;
+const PullSmsReplyStatusByPhoneNumberResponse = models.PullSmsReplyStatusByPhoneNumberResponse;
+const SendStatus = models.SendStatus;
+const DeleteSmsSignResponse = models.DeleteSmsSignResponse;
+const AddSmsSignResponse = models.AddSmsSignResponse;
+const DeleteSmsSignRequest = models.DeleteSmsSignRequest;
+const PullSmsReplyStatusByPhoneNumberRequest = models.PullSmsReplyStatusByPhoneNumberRequest;
+const ModifySmsSignResponse = models.ModifySmsSignResponse;
+const AddSignStatus = models.AddSignStatus;
+const ModifyTemplateStatus = models.ModifyTemplateStatus;
+const PullSmsSendStatusResponse = models.PullSmsSendStatusResponse;
+const SmsPackagesStatisticsResponse = models.SmsPackagesStatisticsResponse;
+const DeleteSignStatus = models.DeleteSignStatus;
+const PullSmsReplyStatusResponse = models.PullSmsReplyStatusResponse;
+
+
+/**
+ * sms client
+ * @class
+ */
+class SmsClient extends AbstractClient {
+
+    constructor(credential, region, profile) {
+        super("sms.tencentcloudapi.com", "2021-01-11", credential, region, profile);
+    }
+    
+    /**
+     * 1. 修改短信签名，修改之前请先认证参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)。
+2. ⚠️注意：个人认证用户不支持使用 API 修改短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 修改短信签名。
+3. 修改短信签名，仅当签名为**待审核**或**已拒绝**状态时，才能进行修改，**已审核通过**的签名不支持修改。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+     * @param {ModifySmsSignRequest} req
+     * @param {function(string, ModifySmsSignResponse):void} cb
+     * @public
+     */
+    ModifySmsSign(req, cb) {
+        let resp = new ModifySmsSignResponse();
+        this.request("ModifySmsSign", req, resp, cb);
+    }
+
+    /**
+     * 1. 添加短信签名，申请之前请先认真参阅 [腾讯云短信签名审核标准](https://cloud.tencent.com/document/product/382/39022)。
+2. ⚠️注意：个人认证用户不支持使用 API 申请短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录控制台申请短信签名。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+     * @param {AddSmsSignRequest} req
+     * @param {function(string, AddSmsSignResponse):void} cb
+     * @public
+     */
+    AddSmsSign(req, cb) {
+        let resp = new AddSmsSignResponse();
+        this.request("AddSmsSign", req, resp, cb);
+    }
+
+    /**
+     * 拉取短信下发状态。
+目前也支持 [配置回调](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) 的方式来获取下发状态。
+>- 注：此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {PullSmsSendStatusRequest} req
+     * @param {function(string, PullSmsSendStatusResponse):void} cb
+     * @public
+     */
+    PullSmsSendStatus(req, cb) {
+        let resp = new PullSmsSendStatusResponse();
+        this.request("PullSmsSendStatus", req, resp, cb);
+    }
+
+    /**
+     * 短信发送接口，用于给用户发短信验证码、通知类短信或营销短信。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 [SDK](https://cloud.tencent.com/document/product/382/43193) 来使用云短信服务。
+>- 注：您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+>- 注：当前接口属于 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)。
+     * @param {SendSmsRequest} req
+     * @param {function(string, SendSmsResponse):void} cb
+     * @public
+     */
+    SendSms(req, cb) {
+        let resp = new SendSmsResponse();
+        this.request("SendSms", req, resp, cb);
+    }
+
+    /**
+     * ⚠️注意：个人认证用户不支持使用 API 删除短信正文模板，请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信正文模板，如需了解请参阅 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+     * @param {DeleteSmsTemplateRequest} req
+     * @param {function(string, DeleteSmsTemplateResponse):void} cb
+     * @public
+     */
+    DeleteSmsTemplate(req, cb) {
+        let resp = new DeleteSmsTemplateResponse();
+        this.request("DeleteSmsTemplate", req, resp, cb);
+    }
+
+    /**
+     * 用户套餐包信息统计。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {SmsPackagesStatisticsRequest} req
+     * @param {function(string, SmsPackagesStatisticsResponse):void} cb
+     * @public
+     */
+    SmsPackagesStatistics(req, cb) {
+        let resp = new SmsPackagesStatisticsResponse();
+        this.request("SmsPackagesStatistics", req, resp, cb);
+    }
+
+    /**
+     * 统计用户发送短信的数据。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {SendStatusStatisticsRequest} req
+     * @param {function(string, SendStatusStatisticsResponse):void} cb
+     * @public
+     */
+    SendStatusStatistics(req, cb) {
+        let resp = new SendStatusStatisticsResponse();
+        this.request("SendStatusStatistics", req, resp, cb);
+    }
+
+    /**
+     * 统计用户回执的数据。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+     * @param {CallbackStatusStatisticsRequest} req
+     * @param {function(string, CallbackStatusStatisticsResponse):void} cb
+     * @public
+     */
+    CallbackStatusStatistics(req, cb) {
+        let resp = new CallbackStatusStatisticsResponse();
+        this.request("CallbackStatusStatistics", req, resp, cb);
+    }
+
+    /**
+     * ⚠️注意：个人认证用户不支持使用 API 查询短信正文模板，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {DescribeSmsTemplateListRequest} req
+     * @param {function(string, DescribeSmsTemplateListResponse):void} cb
+     * @public
+     */
+    DescribeSmsTemplateList(req, cb) {
+        let resp = new DescribeSmsTemplateListResponse();
+        this.request("DescribeSmsTemplateList", req, resp, cb);
+    }
+
+    /**
+     * 拉取短信回复状态。
+目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。
+>- 注：此接口需要联系 [腾讯云短信小助手](https://cloud.tencent.com/document/product/382/3773#.E6.8A.80.E6.9C.AF.E4.BA.A4.E6.B5.81) 开通。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {PullSmsReplyStatusRequest} req
+     * @param {function(string, PullSmsReplyStatusResponse):void} cb
+     * @public
+     */
+    PullSmsReplyStatus(req, cb) {
+        let resp = new PullSmsReplyStatusResponse();
+        this.request("PullSmsReplyStatus", req, resp, cb);
+    }
+
+    /**
+     * ⚠️注意：个人认证用户不支持使用 API 查询短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629),如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 查询短信签名。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {DescribeSmsSignListRequest} req
+     * @param {function(string, DescribeSmsSignListResponse):void} cb
+     * @public
+     */
+    DescribeSmsSignList(req, cb) {
+        let resp = new DescribeSmsSignListResponse();
+        this.request("DescribeSmsSignList", req, resp, cb);
+    }
+
+    /**
+     * 拉取单个号码短信下发状态。
+目前也支持 [配置回调](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) 的方式来获取下发状态。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {PullSmsSendStatusByPhoneNumberRequest} req
+     * @param {function(string, PullSmsSendStatusByPhoneNumberResponse):void} cb
+     * @public
+     */
+    PullSmsSendStatusByPhoneNumber(req, cb) {
+        let resp = new PullSmsSendStatusByPhoneNumberResponse();
+        this.request("PullSmsSendStatusByPhoneNumber", req, resp, cb);
+    }
+
+    /**
+     * 1. 修改短信正文模板，修改之前请先认真参阅 [腾讯云短信正文模板审核标准](https://cloud.tencent.com/document/product/382/39023)。
+2. ⚠️注意：个人认证用户不支持使用 API 修改短信正文模板，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 修改短信正文模板。
+3. 修改短信模板，仅当正文模板为**待审核**或**已拒绝**状态时，才能进行修改，**已审核通过**的正文模板不支持修改。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2019-07-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {ModifySmsTemplateRequest} req
+     * @param {function(string, ModifySmsTemplateResponse):void} cb
+     * @public
+     */
+    ModifySmsTemplate(req, cb) {
+        let resp = new ModifySmsTemplateResponse();
+        this.request("ModifySmsTemplate", req, resp, cb);
+    }
+
+    /**
+     * 拉取单个号码短信回复状态。
+目前也支持 [配置回复回调](https://cloud.tencent.com/document/product/382/42907) 的方式来获取上行回复。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+
+     * @param {PullSmsReplyStatusByPhoneNumberRequest} req
+     * @param {function(string, PullSmsReplyStatusByPhoneNumberResponse):void} cb
+     * @public
+     */
+    PullSmsReplyStatusByPhoneNumber(req, cb) {
+        let resp = new PullSmsReplyStatusByPhoneNumberResponse();
+        this.request("PullSmsReplyStatusByPhoneNumber", req, resp, cb);
+    }
+
+    /**
+     * 提供电话号码的信息查询，包括国家（或地区）码、规范的 E.164 格式号码等。
+>- 例如：查询号码 +86018845720123，可以得到国家码 86、规范的 E.164 号码 +8618845720123 等信息。
+     * @param {DescribePhoneNumberInfoRequest} req
+     * @param {function(string, DescribePhoneNumberInfoResponse):void} cb
+     * @public
+     */
+    DescribePhoneNumberInfo(req, cb) {
+        let resp = new DescribePhoneNumberInfoResponse();
+        this.request("DescribePhoneNumberInfo", req, resp, cb);
+    }
+
+    /**
+     * ⚠️注意：个人认证用户不支持使用 API 删除短信签名，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，请登录 [控制台](https://console.cloud.tencent.com/smsv2) 删除短信签名。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+     * @param {DeleteSmsSignRequest} req
+     * @param {function(string, DeleteSmsSignResponse):void} cb
+     * @public
+     */
+    DeleteSmsSign(req, cb) {
+        let resp = new DeleteSmsSignResponse();
+        this.request("DeleteSmsSign", req, resp, cb);
+    }
+
+    /**
+     * 1. 添加短信模板，申请之前请先认真参阅 [腾讯云短信正文模板审核标准](https://cloud.tencent.com/document/product/382/39023)。
+2. ⚠️注意：个人认证用户不支持使用 API 申请短信正文模板，请参阅了解 [实名认证基本介绍](https://cloud.tencent.com/document/product/378/3629)，如果为个人认证请登录 [控制台](https://console.cloud.tencent.com/smsv2) 申请短信正文模板。
+>- 注：由于云 **API3.0 安全性**有所提升，所以**接口鉴权**较为复杂，建议使用 SDK 来使用云短信服务。
+>- 您可以在 [API 3.0 Explorer](https://console.cloud.tencent.com/api/explorer?Product=sms&Version=2021-01-11&Action=SendSms) 中直接运行该接口，可以先免去签名计算步骤。运行成功后，API Explorer可以**自动生成**SDK代码示例。
+     * @param {AddSmsTemplateRequest} req
+     * @param {function(string, AddSmsTemplateResponse):void} cb
+     * @public
+     */
+    AddSmsTemplate(req, cb) {
+        let resp = new AddSmsTemplateResponse();
+        this.request("AddSmsTemplate", req, resp, cb);
+    }
+
+
+}
+module.exports = SmsClient;