全部产品
短信服务

短信查询API(QuerySendDetails)---Node.js

更新时间:2017-09-13 13:21:45   分享:   

短信发送记录查询接口(QuerySendDetails)

用于查询短信发送的状态,是否成功到达终端用户手机

入参列表

参数名称 参数类型 必填与否 样例取值 参数说明
PhoneNumber String 必须 15000000000 短信接收号码
BizId String 可选 1234^1234 发送流水号,从调用发送接口返回值中获取
SendDate String 必须 20170525 短信发送日期格式yyyyMMdd,支持最近30天记录查询
PageSize Number 必须 10 页大小Max=50
CurrentPage Number 必须 1 当前页码

出参列表

出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID
Code String OK 状态码-返回OK代表请求成功,其他错误码详见错误码列表
Message String 请求成功 状态码的描述
TotalCount Number 100 发送总条数
TotalPage Number 10 总页数
smsSendDetailDTOs Object - 发送明细结构体,详见Demo样例

Demo样例

出参名称 出参类型 样例取值 参数说明
phoneNum String 13000000000 手机号码
sendStatus Number 1 发送状态 1:等待回执,2:发送失败,3:发送成功
errCode String DELIVERED 运营商短信错误码
templateCode String SMS_000 模板ID
content String 【阿里云】你好! 短信内容
sendDate Object 2017-05-25 00:00:00 发送时间
receiveDate String 2017-05-25 00:00:00 接收时间
outId String 123 外部流水扩展字段

技术对接步骤

1:下载SDK工具包
  1. $ npm install @alicloud/sms-sdk --save

SDK&DEMO[下载地址]

2: 编写样例程序
  1. /**
  2. * 云通信基础能力业务短信发送、查询详情以及消费消息示例,供参考。
  3. * Created on 2017-07-31
  4. */
  5. const SMSClient = require('@alicloud/sms-sdk')
  6. // ACCESS_KEY_ID/ACCESS_KEY_SECRET 根据实际申请的账号信息进行替换
  7. const accessKeyId = 'yourAccessKeyId'
  8. const secretAccessKey = 'yourAccessKeySecret'
  9. //初始化sms_client
  10. let smsClient = new SMSClient({accessKeyId, secretAccessKey})
  11. //查询短信发送详情
  12. smsClient.queryDetail({
  13. PhoneNumber: '1500000000',
  14. SendDate: '20170731',
  15. PageSize: '10',
  16. CurrentPage: "1"
  17. }).then(function (res) {
  18. let {Code, SmsSendDetailDTOs}=res
  19. if (Code === 'OK') {
  20. //处理发送详情内容
  21. console.log(SmsSendDetailDTOs)
  22. }
  23. }, function (err) {
  24. //处理错误
  25. console.log(err)
  26. })
本文导读目录
本文导读目录
以上内容是否对您有帮助?