短信
有奖捉虫：办公协同&微信生态&物联网文档专题 HOT
文档中心 > 短信

Node.js SDK 2.0

最近更新时间：2020-09-23 17:15:17

我的收藏

本页目录：

SDK 功能简介

目前腾讯云短信为客户提供国内短信和国际/港澳台短信**服务，腾讯云短信 SDK 支持以下操作：
国内短信
国际/港澳台短信
指定模板单发短信
指定模板群发短信
拉取短信回执和短信回复状态
指定模板单发短信
指定模板群发短信
拉取短信回执
说明
群发短信 一次群发请求最多支持200个号码，如对号码数量有特殊需求请联系腾讯云短信技术支持（QQ：3012203387）。
拉取短信回执 该功能默认关闭。您可以根据实际需求联系腾讯云短信技术支持（QQ：3012203387）开通，实现批量拉取短信回执。

SDK 使用指南

相关资料

各个接口及其参数的详情介绍请参见 API 指南 、SDK 文档 和 错误码。

前提条件

在使用 SDK 前，您需要准备以下信息：
获取 SDKAppID 和 AppKey 云短信应用 SDKAppID 和 AppKey 可在 短信控制台 的应用信息里获取。如您尚未添加应用，请登录 短信控制台 添加应用。
申请签名并确认审核通过 一个完整的短信由短信签名和短信正文内容两部分组成，短信签名需申请和审核，签名可在 短信控制台 的相应服务模块内容配置中进行申请，详细申请操作请参见 创建签名。发送国际/港澳台短信时，允许不携带签名。
申请模板并确认审核通过 短信正文内容模板需申请和审核，模板可在 短信控制台 的相应服务模块内容配置中进行申请，详细申请操作请参见 创建正文模板。

配置 SDK

npm 配置： qcloudsms_js 采用 npm 进行安装，要使用 qcloudsms 功能，只需要执行：
npm install qcloudsms_js
手动配置： 1.手动下载或 clone 最新版本 qcloudsms_js 代码。 2.把 qcloudsms_js 把代码放入项目目录。 3.在项目里 require qcloudsms_js， 如： var moduleName = require("path/to/qcloudsms_js")。

示例代码

说明
所有示例代码仅作参考，无法直接编译和运行，需根据实际情况进行修改。
准备必要参数和实例化 QcloudSms
var QcloudSms = require("qcloudsms_js");
// 短信应用 SDK AppID
var appid = 1400009099;  // SDK AppID 以1400开头
// 短信应用 SDK AppKey
var appkey = "9ff91d87c2cd7cd0ea762f141975d1df37481d48700d70ac37470aefc60f9bad";
// 需要发送短信的手机号码
var phoneNumbers = ["21212313123", "12345678902", "12345678903"];
// 短信模板 ID，需要在短信控制台中申请
var templateId = 7839;  // NOTE: 这里的模板ID`7839`只是示例，真实的模板 ID 需要在短信控制台中申请
// 签名
var smsSign = "腾讯云";  // NOTE: 签名参数使用的是`签名内容`，而不是`签名ID`。这里的签名"腾讯云"只是示例，真实的签名需要在短信控制台申请
// 实例化 QcloudSms
var qcloudsms = QcloudSms(appid, appkey);
// 设置请求回调处理, 这里只是演示，用户需要自定义相应处理回调
function callback(err, res, resData) {
  if (err) {
      console.log("err: ", err);
  } else {
      console.log("request data: ", res.req);
      console.log("response data: ", resData);
  }
}

指定模板 ID 单发短信

var ssender = qcloudsms.SmsSingleSender();
var params = ["5678"];
ssender.sendWithParam("86", phoneNumbers[0], templateId,
params, smsSign, "", "", callback);

指定模板 ID 群发短信

var msender = qcloudsms.SmsMultiSender();
var params = ["5678"];
msender.sendWithParam("86", phoneNumbers, templateId,
params, smsSign, "", "", callback);

拉取短信回执以及回复

var maxNum = 10;  // 单次拉取最大量
var spuller = qcloudsms.SmsStatusPuller();
// 拉取短信回执
spuller.pullCallback(maxNum, callback);
// 拉取回复（国际/港澳台短信不支持回复功能）
spuller.pullReply(maxNum, callback);
拉取单个手机短信状态
var beginTime = 1511125600;  // 开始时间（UNIX timestamp）
var endTime = 1511841600;    // 结束时间（UNIX timestamp）
var maxNum = 10;             // 单次拉取最大量
var mspuller = qcloudsms.SmsMobileStatusPuller();
// 拉取短信回执
mspuller.pullCallback("86", phoneNumbers[0], beginTime, endTime, maxNum, callback);
// 拉取回复，国际/港澳台短信不支持回复功能
mspuller.pullReply("86", phoneNumbers[0], beginTime, endTime, maxNum, callback);
发送国际/港澳台短信 发送国际/港澳台短信与发送国内短信类似，只需替换相应的国家码或地区码。详细示例请参考：
指定模板单发短信
指定模板群发短信
拉取短信回执
中国站