云短信 > API 文档 > 查询发送记录

查询发送记录

最近更新时间: 2020-08-25 10:35:28

查询短信发送记录

请求定义

GET /v1/messages HTTP/1.1
Host: sms.qiniuapi.com
Authorization: <QiniuToken>
Content-Type: application/x-www-form-urlencoded

请求头

请参考请求认证

请求参数

该接口定义以下请求参数:

名称	必填	描述
job_id	否	发送任务返回的 id
message_id	否	单条短信发送接口返回的 id
mobile	否	接收短信的手机号码
status	否	短信的状态，sending: 发送中，success: 发送成功，failed: 发送失败，waiting: 等待发送
template_id	否	模版 id
type	否	短信类型，marketing: 营销短信，notification: 通知短信，verification: 验证码类短信，voice: 语音短信
start	否	开始时间，timestamp，例如: 1563280448
end	否	结束时间，timestamp，例如: 1563280471
page	否	页码，默认为 1
page_size	否	每页返回的数据条数，默认20，最大200

响应定义

该接口正确处理请求时返回如下 JSON 数据

{
    "page": int,
    "page_size": int,
    "items":[{
        "message_id": string,
        "job_id": string,
        "mobile": string,
        "content": string,
        "status": string,
        "type": string,
        "error": string, // 短信发送失败详细状态信息
        "count": int, // 发送的短信条数
        "created_at": timestamp,  // 短信发送时间
        "delivrd_at": timestamp // 如果短信发送失败，那么不会返回这个字段
    }...]
}

以上内容是否对您有帮助？