阿里云查看短信发送记录和发送状态 - App.Sms.AliyunQuerySendDetails - EagletAPI

接口地址：http://api.kittyhawks.cn/api/app.php?s=App.Sms.AliyunQuerySendDetails

接口描述：通过阿里云的QuerySendDetails接口查看短信发送记录和发送状态。使用前请修改./config/app.php配置文件中的aliYun配置。

HTTP/HTTPS

请求协议

GET/POST

请求方式

UTF-8

编码格式

JSON

返回格式

接口参数

参数名字	类型	是否必须	默认值	其他	说明
access_token	字符串	可选			访问令牌，仅当开启签名验证时需要传递，生成令牌可使用App.Auth.ApplyToken接口
CurrentPage	整型	可选	1	最小：1	分页查看发送记录，指定发送记录的的当前页码。
PageSize	整型	可选	10	最小：1；最大：50	分页查看发送记录，指定每页显示的短信记录数量。取值范围为1~50。
PhoneNumber	字符串	必须	-		接收短信的手机号码。格式：国内短信：11位手机号码，例如15900000000。国际/港澳台消息：国际区号+号码，例如85200000000。
SendDate	字符串	必须	-		短信发送日期，支持查询最近30天的记录。格式为yyyyMMdd，例如20181225。

返回字段

返回结果	类型	说明
ret	整型	状态码，200表示成功，4xx表示客户端非法请求，5xx表示服务器错误
data	对象或混合类型	业务数据，由各自接口指定，通常为对象
data.Code	字符串	请求状态码。返回OK代表请求成功。Config Error代表缺少配置。其他错误码详见错误码列表。
data.Message	字符串	状态码的描述。
data.RequestId	字符串	请求ID。
data.SmsSendDetailDTOs	对象	短信发送明细。
data.TotalCount	字符串	短信发送总条数。
msg	字符串	提示信息，失败时的错误提示

在线测试

参数	是否必须	值
service	必须
access_token	可选
CurrentPage	可选
PageSize	可选
PhoneNumber	必须
SendDate	必须

客户端请求示例

{
    "ret": 200,
    "data": {
        "TotalCount": 1,
        "Message": "OK",
        "RequestId": "FC95F662-4FC1-4692-ADEE-2B1AD4BBB90F",
        "SmsSendDetailDTOs": {
            "SmsSendDetailDTO": [
                {
                    "SendDate": "2020-02-24 14:59:41",
                    "SendStatus": 3,
                    "ReceiveDate": "2020-02-24 14:59:48",
                    "ErrCode": "DELIVERED",
                    "TemplateCode": "SMS_177253065",
                    "Content": "【YesApi】您的验证码1234，该验证码15分钟内有效，请勿泄漏于他人！",
                    "PhoneNum": "15914283683"
                }
            ]
        },
        "Code": "OK"
    },
    "msg": ""
}

错误列表

错误状态码	错误描述信息
400	表示客户端参数错误
404	表示接口服务不存在
500	表示服务端内部错误

本文档生成时间：2024-12-04 16:23:54