用于主动获取短信发送的状态报告,实时跟踪短信投递状态
本接口用于主动获取短信发送的状态报告。相同的状态报告,只能获取一次。
Content-Type: application/x-www-form-urlencoded
提示:建议每5-10分钟获取一次状态报告,避免频繁请求对系统造成压力
参数名称 | 含义 | 类型 | 必填 | 说明 |
---|---|---|---|---|
action | 请求动作 | string | 是 | 固定为:query |
userid | 企业ID | string | 是 | 企业ID(登陆后台-客户管理-我的信息) |
account | 帐号 | string | 是 | 短信帐号 |
password | 密码 | string | 是 | 登陆密码 |
statusNum | 获取数量 | number | 否 | 必须为数字,默认4000,可不填 |
rt | 返回格式 | string | 否 | 固定值:json,不填则为XML格式返回 |
JSON格式请求:
XML格式请求:
JSON格式响应:
XML格式响应:
状态码 | 含义 | 说明 |
---|---|---|
10 | 发送成功 | 短信已成功送达用户手机 |
20 | 发送失败 | 短信发送失败,具体原因见ErrorCode |
错误码 | 含义 | 建议处理方式 |
---|---|---|
UNDELIVERED | 未送达 | 可能用户关机或不在服务区,建议稍后重试 |
REJECTED | 被拒绝 | 可能被运营商或用户拦截 |
EXPIRED | 已过期 | 短信在网关中停留时间过长 |
UNKNOWN | 未知错误 | 需要联系技术支持排查 |
相同的状态报告,只能获取一次。建议定期获取状态报告以避免数据丢失。
建议每5-10分钟获取一次状态报告,避免频繁请求对系统造成压力。
Status字段的状态码:10=发送成功,20=发送失败。ErrorCode字段为上级网关返回值,仅供参考。
状态报告通常在短信发送后几分钟到几小时内生成,建议合理设置查询间隔。
建议将获取到的状态报告存储到本地数据库,便于后续查询和分析。
不建议在前端代码中直接使用密码参数,建议通过服务器端进行中转调用。