获取短信状态报告
GET
/client-sms/v2/sms/get-rpt:::caution
接口调用前提:获取鉴权秘钥:获取鉴权秘钥
:::
请求参数
Header 参数
Finovy-Access-Token
string
令牌-口令
示例值:
zabAehE5uHaAAGBiPIac3j
Body 参数application/json
msgId
string
短信回执流水号
短信平台返回的回执流水号,可在发送短信时保存接口返回值
示例
{
"msgId": "93915998096253022"
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
result
integer
获取状态报告请求处理结果
0:成功,非0:失败,详见错误码
desc
string
必需
rpts
array [object {8}]
必需
msgId
integer
平台流水号
短信回执流水号
custId
string
用户自定义流水号
用户自定义流水号,状态返回值内将包含用户自定义流水号
costNum
integer
长短信拆分的总条数
mobile
string
收信手机号
sendTime
string
状态报告返回时间
YYYY-MM-DD HH:MM:SS
status
integer
接收状态
状态(pending等待回执,success成功,fail失败)
errDesc
string
状态报告错误代码
exData
string
必需
下行时填写的exdata
示例
成功示例
{
"code": 0,
"success": true,
"data": {
"msgId": "uEWOjcXVaasszMe0pkr3Ud",
"custId": "885245663",
"exData": "zxcvbbnnd",
"costNum": 1,
"mobile": "18563969992",
"sendTime": "2024-02-06 19:04:00",
"status": "success",
"errDesc": null
},
"msg": "success",
"traceId": "f3f13645c8df4b02a70713e2b39f652f.2360.17083496334650029"
}
最后修改时间: 8 个月前