全部产品
Search
文档中心

Node.js

更新时间: 2019-11-26

入参列表

参数名称 参数类型 必填与否 样例取值 参数说明
To String 必填 452220121 接收方的手机号码;说明:号码格式为 国家码+号码
From String 选填 XXCompany 发送方标识;说明:发往中国时,该参数为短信签名
TemplateCode String 必填 SMS_0000 短信模板ID。请在控制台中查看
TemplateParam String 选填 {“code”:”1234”,”product”:”ytx”} 短信模板变量对应的实际值,JSON格式;说明:如果JSON中需要带换行符,请参照标准的JSON协议处理。
SmsUpExtendCode String 选填 90999 上行短信扩展码,无特殊需要此字段的用户请忽略此字段。

出参列表

出参名称 出参类型 样例取值 参数说明
To String 452220121 接收方的手机号码;说明:号码格式为 国家码+号码
MessageId String 10080303003003 短信发送ID,可根据该ID在接口QueryMessage中查询具体的发送状态。
ResponseCode String OK 请求状态码,返回OK代表请求成功,其他错误码详见错误码列表。
ResponseDescription String 短信接收成功 状态码的描述。
Segments String 1 短信计费条数

技术对接步骤

1.Core-sdk引用

方法1,通过npm/yarn安装

  1. npm install @alicloud/pop-core

方法2,core-sdk下载地址:Node.js API SDK

2.编写样例程序

调用接口时,请注意:

  1. const Core = require('@alicloud/pop-core');
  2. var client = new Core({
  3. accessKeyId: '<accessKeyId>',
  4. accessKeySecret: '<accessSecret>',
  5. endpoint: 'https://sms-intl.ap-southeast-1.aliyuncs.com',
  6. apiVersion: '2018-05-01'
  7. });
  8. var params = {
  9. "RegionId": "ap-southeast-1",
  10. "To": "8615200000000",
  11. "From": "云通信签名",
  12. "TemplateCode": "SMS_225001",
  13. "TemplateParam": "{\"code\":\"1234\"}",
  14. "SmsUpExtendCode": "12345"
  15. }
  16. var requestOption = {
  17. method: 'POST'
  18. };
  19. client.request('SendMessageWithTemplate', params, requestOption).then((result) => {
  20. console.log(result);
  21. }, (ex) => {
  22. console.log(ex);
  23. })