API文档拉取短信状态接口_拉取短信状态 - 帮助中心

描述

获取用户发送的短信状态信息。

接口地址

/sms/querySendStatus

HTTP METHOD

POST

HTTP BODY编码格式

application/x-www-form-urlencoded

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表见公共请求参数。

名称	类型	是否必填	说明
phone	string	否	手机号码
startDate	string	否	开始日期, 格式为yyyy-MM-dd
endDate	string	否	结束日期, 格式为yyyy-MM-dd
pageIndex	string	否	查询起始位置, 默认为 1
pageSize	string	否	查询个数, 取值区间 [0-100], 默认为 100

返回结果

名称	类型	说明
code	int	错误码
RequestId	string	唯一请求 ID，每次请求都会返回。
message	string	结果描述
data	Array	短信发送结果数据

data字段详情

名称	类型	说明
serialno	string	短信发送记录唯一标识
phone	string	手机号码
content	string	短信内容
description	string	短信发送结果描述
sendstatus	string	发送状态
requesttime	string	发送时间

请求示例

    curl -X POST \
    "https://api.yisu.com/sms/querySendStatus" \
    -H "content-type: application/x-www-form-urlencoded" \
    -d "accessId=abcdefghijklmnop&endDate=2019-12-23&nonce=27212&pageIndex=1&phone=15766050514&startDate=2019-12-23×tamp=1577955495&signature=H9kgkwceTJJ1CXYYnXj01Hhx2iM%3D"

返回示例

{
  "code": 0,
  "message": "成功",
  "data": [
    {
      "serialno": "157776004286312634551380000000074804",
      "phone": "13800000000",
      "content": "【***】您的验证码为111111，请在10分钟内输入!",
      "sendstatus": "发送成功",
      "description": "请求成功",
      "requesttime": "2019-12-31 10:40:42"
    },
    {
      "serialno": "157775763495912634551380000000045589",
      "phone": "13800000000",
      "content": "【***】您的验证码为111111，请在10分钟内输入!",
      "sendstatus": "发送成功",
      "description": "请求成功",
      "requesttime": "2019-12-31 10:00:34"
    }
  ],
  "requestId": "c1c9dc4fe90cabafc0eea8b792d79349"
}