本文为您介绍PHP调用短信查询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样例。

技术对接步骤

1:下载SDK工具包

请下载PHP SDK,并将完整的PHP SDK引用到您的工程中,调用示例存放于api_demo、msg_demo目录中,请您参考或修改示例正确调用api,api及依赖项放置在api_sdk、msg_sdk目录中。

SDK&DEMO[下载地址]

2: 编写样例程序

// 代码节选,详见aliyun-dysms-php-sdk/api_demo/SmsDemo.php

...

class SmsDemo
{
    ...

    /**
     * 短信发送记录查询
     *
     * @param string $phoneNumbers 必填, 短信接收号码 (e.g. 12345678901)
     * @param string $sendDate 必填,短信发送日期,格式Ymd,支持近30天记录查询 (e.g. 20170710)
     * @param int $pageSize 必填,分页大小
     * @param int $currentPage 必填,当前页码
     * @param string $bizId 选填,短信发送流水号 (e.g. abc123)
     * @return stdClass
     */
   public static function queryDetails($phoneNumbers, $sendDate, $pageSize = 10, $currentPage = 1, $bizId=null) {

        // 初始化QuerySendDetailsRequest实例用于设置短信查询的参数
        $request = new QuerySendDetailsRequest();

        // 必填,短信接收号码
        $request->setPhoneNumber($phoneNumbers);

        // 选填,短信发送流水号
        $request->setBizId($bizId);

        // 必填,短信发送日期,支持近30天记录查询,格式Ymd
        $request->setSendDate($sendDate);

        // 必填,分页大小
        $request->setPageSize($pageSize);

        // 必填,当前页码
        $request->setCurrentPage($currentPage);

        // 发起访问请求
        $acsResponse = static::getAcsClient()->getAcsResponse($request);

        // 打印请求结果
        // var_dump($acsResponse);

        return $acsResponse;
    }
}

// 调用示例:
$response = SmsDemo::queryDetails(
    "12345678901",  // phoneNumbers 电话号码
    "20170718", // sendDate 发送时间
    10, // pageSize 分页大小
    1 // currentPage 当前页码
    // "abcd" // bizId 短信发送流水号,选填
);
echo "查询短信发送情况(queryDetails)接口返回的结果:\n";
print_r($response);