拉取短信状态接口
请求说明
- 接口请求域名 : api.ffrcs.cn
- RequestURI : /rest/sms/v3/pull/sendStatus
- Method : POST
- Content-Type : application/json; charset=utf-8;
默认接口请求频率限制:1次/秒。
输入参数
参数 | 类型 | 描述 | 示例 | 必填 |
---|---|---|---|---|
limit | Integer | 单次拉取最大条数,最多1000条。 | 100 | 是 |
响应内容
参数 | 类型 | 描述 |
---|---|---|
code | Integer | 响应状态 |
message | String | 响应状态描述 |
data | Object | 数据节点 |
data.statusSet | PullSendStatusPacket[] | 短信发送状态信息 |
PullSendStatusPacket
参数 | 类型 | 描述 |
---|---|---|
smsId | String | 消息ID。 |
phoneNumber | String | 手机号码。 |
stat | Integer | 状态码。0:代表发送成功。 |
statDes | String | 发送失败的错误码。 |
revTime | Int64 | 接收时间。时间戳类型。 |
示例
请求示例
curl 'https://api.ffrcs.cn/rest/sms/v3/pull/sendStatus' \
--header 'Content-Type: application/json' \
--header 'X-FZ-Timstamp: 1713152159772 ' \
--header 'Authorization: HmacSHA256 credential=1kl***,signature=1264b693*******be05bef' \
--data '{
"limit": 100
}'
响应示例
{
"msg": "成功",
"code": "ok",
"data": {
"statusSet": [
{
"smsId": "16715171674bb56c7f6a15d222d",
"phoneNumber": "130****",
"revTime": 1713150159772,
"stat": 0,
"statDes": "DELIVRD"
}
]
}
}
错误码参考- 错误码