全部产品
存储与CDN 数据库 安全 应用服务 数加·人工智能 数加·大数据基础服务 互联网中间件 视频服务 开发者工具 解决方案 物联网
短信服务

短信查询API(QuerySendDetails)---PHP

更新时间:2017-10-30 09:58:39

短信发送记录查询接口(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工具包

SDK工具包中一共包含了2个类库,一个aliyun-php-sdk-core包,另外一个是alicom-dysms-api包,将这两个包添加到工程类库中依赖。

SDK&DEMO[下载地址]

2: 编写样例程序
  1. // 代码节选,详见aliyun-dysms-php-sdk/api_demo/SmsDemo.php
  2. ...
  3. class SmsDemo
  4. {
  5. ...
  6. /**
  7. * 短信发送记录查询
  8. *
  9. * @param string $phoneNumbers 必填, 短信接收号码 (e.g. 12345678901)
  10. * @param string $sendDate 必填,短信发送日期,格式Ymd,支持近30天记录查询 (e.g. 20170710)
  11. * @param int $pageSize 必填,分页大小
  12. * @param int $currentPage 必填,当前页码
  13. * @param string $bizId 选填,短信发送流水号 (e.g. abc123)
  14. * @return stdClass
  15. */
  16. public function queryDetails($phoneNumbers, $sendDate, $pageSize = 10, $currentPage = 1, $bizId=null) {
  17. // 初始化QuerySendDetailsRequest实例用于设置短信查询的参数
  18. $request = new QuerySendDetailsRequest();
  19. // 必填,短信接收号码
  20. $request->setPhoneNumber($phoneNumbers);
  21. // 选填,短信发送流水号
  22. $request->setBizId($bizId);
  23. // 必填,短信发送日期,支持近30天记录查询,格式Ymd
  24. $request->setSendDate($sendDate);
  25. // 必填,分页大小
  26. $request->setPageSize($pageSize);
  27. // 必填,当前页码
  28. $request->setCurrentPage($currentPage);
  29. // 发起访问请求
  30. $acsResponse = static::getAcsClient()->getAcsResponse($request);
  31. // 打印请求结果
  32. // var_dump($acsResponse);
  33. return $acsResponse;
  34. }
  35. }
  36. // 调用示例:
  37. $response = SmsDemo::queryDetails(
  38. "12345678901", // phoneNumbers 电话号码
  39. "20170718", // sendDate 发送时间
  40. 10, // pageSize 分页大小
  41. 1 // currentPage 当前页码
  42. // "abcd" // bizId 短信发送流水号,选填
  43. );
  44. echo "查询短信发送情况(queryDetails)接口返回的结果:\n";
  45. print_r($response);
本文导读目录