本文为您介绍Node.js调用短信查询API的操作流程。

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

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

注意 使用短信服务新版SDK调用API接口,请查看新版SDK参考和API参考。
参数名称 参数类型 必填与否 样例取值 参数说明
PhoneNumber String 必须 15000000000 短信接收号码,如果需要查询国际短信,号码前需要带上对应国家的区号,区号的获取详见国际短信支持国家信息查询API接口。
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 发送总条数。
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工具包

 $ npm install @alicloud/sms-sdk --save
			

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'

//初始化sms_client
let smsClient = new SMSClient({accessKeyId, secretAccessKey})

//查询短信发送详情
smsClient.queryDetail({
    PhoneNumber: '1500000000',
    SendDate: '20170731',
    PageSize: '10',
    CurrentPage: "1"
}).then(function (res) {
    let {Code, SmsSendDetailDTOs}=res
    if (Code === 'OK') {
        //处理发送详情内容
        console.log(SmsSendDetailDTOs)
    }
}, function (err) {
    //处理错误
    console.log(err)
})