【阿里云】短信批量发送API(SendBatchSms)-Node.js

2018-08-18 552

发送批量短信接口(SendBatchSms)

步骤 1 创建阿里云账号

为了访问短信服务,您需要有一个阿里云账号。如果没有,可首先按照如下步骤创建阿里云账号:

  1. 访问阿里云 官方网站,单击页面上的 免费注册 按钮。

  2. 按照屏幕提示完成注册流程并进行实名认证,短信服务只支持实名认证用户使用。为了更好地使用阿里云服务,建议尽快完成实名认证,否则部分阿里云服务将无法使用。具体实名认证流程,请参考 这里。

步骤 2 获取阿里云访问密钥

为了使用短信发送API-JAVA SDK,您必须申请阿里云的访问密钥。

阿里云访问秘钥是阿里云为用户使用 API(非控制台)来访问其云资源设计的“安全口令”。您可以用它来签名 API 请求内容以通过服务端的安全验证。

该访问秘钥成对(AccessKeyId 与 AccessKeySecret)生成和使用。每个阿里云用户可以创建多对访问秘钥,且可随时启用(Active)、禁用(Inactive)或者删除已经生成的访问秘钥对。

您可以通过阿里云控制台的 秘钥管理页面 创建、管理所有的访问秘钥对,且保证它处于“启用”状态。由于访问秘钥是阿里云对 API 请求进行安全验证的关键因子,请妥善保管你的访问秘钥。如果某些秘钥对出现泄漏风险,建议及时删除该秘钥对并生成新的替代秘钥对。

步骤 3 在控制台完成模板与签名的申请,获得调用接口必备的参数

短信签名

根据用户属性来创建符合自身属性的签名信息。企业用户需要上传相关企业资质证明,个人用户需要上传证明个人身份的证明。

注意:短信签名需要审核通过后才可以使用。

短信模板

短信模板,即具体发送的短信内容。

短信模板可以支持验证码、短信通知、推广短信三种模式。验证码和短信通知,通过变量替换实现个性短信定制。推广短信不支持在模板中添加变量。

短信模板需要审核通过后才可以使用。

为了成功发送短信通知,您至少需要完成以下步骤

一、在控制台完成短信签名与短信模板的申请,获得调用接口必备的参数

在“短信签名”页面完成签名的申请,获得短信签名的字符串 签名申请手册

在“短信模板”页面完成模板的申请,获得模板ID。模板申请手册

参数

入参列表
参数名称参数类型必填与否样例取值参数说明
PhoneNumberJsonString必须[“15000000000”,”15000000001”]短信接收号码,JSON格式,批量上限为100个手机号码,批量调用相对于单条调用及时性稍有延迟,验证码类型的短信推荐使用单条调用的方式
SignNameJsonString必须[“云通信”,”云通信”]短信签名,JSON格式
TemplateCodeString必须SMS_0000短信模板ID
TemplateParamJsonString必须[{“code”:”1234”,”product”:”ytx1”},{“code”:”5678”,”product”:”ytx2”}]短信模板变量替换JSON串,友情提示:如果JSON中需要带换行符,请参照标准的JSON协议。
SmsUpExtendCodeJsonString可选[“90999”,”90998”]上行短信扩展码,JSON格式,无特殊需要此字段的用户请忽略此字段
出参列表
出参名称出参类型样例取值参数说明
RequestIdString8906582E-6722请求ID
CodeStringOK状态码-返回OK代表请求成功,其他错误码详见错误码列表
MessageString请求成功状态码的描述
BizIdString134523^4351232发送回执ID,可根据该ID查询具体的发送状态

技术对接步骤

1:下载SDK工具包

SDK&DEMO[下载地址]

2: 编写样例程序

注:有备注无需修改的位置请勿改动。

/** * 云通信基础能力业务短信发送、查询详情以及消费消息示例,供参考。 * Created on 2017-07-31 */const SMSClient = require('@alicloud/sms-sdk')// ACCESS_KEY_ID/ACCESS_KEY_SECRET 根据实际申请的账号信息进行替换const accessKeyId = 'yourAccessKeyId'const secretAccessKey = 'yourAccessKeySecret'//在云通信页面开通相应业务消息后,就能在页面上获得对应的queueName,不用填最后面一段const queueName = 'Alicom-Queue-1092397003988387-'//初始化sms_clientlet smsClient = new SMSClient({accessKeyId, secretAccessKey})smsClient.sendBatchSMS({PhoneNumberJson: JSON.stringify(['18040580000', '15088650000']),SignNameJson: JSON.stringify(['短信迁移测试签名','短信迁移测试签名']),TemplateCode: 'SMS_71175823',TemplateParamJson: JSON.stringify([{code: "1234", product: "ytx1"}, {code: "5678", product: "ytx2"}]),}).then(function (res) {let {Code}=resif (Code === 'OK') { //处理返回参数 console.log(res)}}, function (err) {console.log('err', err)})

错误码列表

Code描述
OK请求成功
isp.RAM_PERMISSION_DENYRAM权限DENY
isv.OUT_OF_SERVICE业务停机
isv.PRODUCT_UN_SUBSCRIPT未开通云通信产品的阿里云客户
isv.PRODUCT_UNSUBSCRIBE产品未开通
isv.ACCOUNT_NOT_EXISTS账户不存在
isv.ACCOUNT_ABNORMAL账户异常
isv.SMS_TEMPLATE_ILLEGAL短信模板不合法
isv.SMS_SIGNATURE_ILLEGAL短信签名不合法
isv.INVALID_PARAMETERS参数异常
isp.SYSTEM_ERROR系统错误
isv.MOBILE_NUMBER_ILLEGAL非法手机号
isv.MOBILE_COUNT_OVER_LIMIT手机号码数量超过限制
isv.TEMPLATE_MISSING_PARAMETERS模板缺少变量
isv.BUSINESS_LIMIT_CONTROL业务限流
isv.INVALID_JSON_PARAMJSON参数不合法,只接受字符串值
isv.BLACK_KEY_CONTROL_LIMIT黑名单管控
isv.PARAM_LENGTH_LIMIT参数超出长度限制
isv.PARAM_NOT_SUPPORT_URL不支持URL
isv.AMOUNT_NOT_ENOUGH账户余额不足