概述
为了更好地满足您对短信发送状态的查询需求,我们对原有的短信记录查询接口进行了升级。此前,接口仅能反馈 “发送成功” 或 “发送失败” 的信息。现在,在 BOSS 系统的短信记录查询中,您将能够获取到更为详细的 5 种状态,具体如下:
未发送:表示该短信尚未被系统发出,可能由于各种原因处于等待发送队列中。
发送成功:说明短信已成功发送至目标手机,运营商已确认送达。
发送失败:意味着短信在发送过程中出现问题,未能成功抵达目标手机。
提交成功:即短信已成功提交至运营商网络,等待进一步发送处理。
提交失败:指短信提交至运营商网络时出现故障,未能成功提交。
特别说明
1、短信报告重复返回:在您发送短信后,若部分短信未即时收到回执,我们的系统会先行将这些短信报告反馈给您,以便您知晓其待确认状态。后续,当这些短信获得最终回执结果时,您再次查询短信报告,系统会再次完整呈现这些短信数据,此时数据包含了最终确定的状态。简言之,针对起初无回执而后有回执的短信,您查询报告时会收到两次相关信息,第二次信息带有完整准确的状态。
2、跨月拉取报告:若您在上个月末发送的短信,在本月才收到回执,当您查询上个月的短信报告时,这些上月末发送且本月有回执的短信信息,将会一并出现在上个月的短信报告中返回给您。即只要上月发送的短信在本月产生回执,您查询上月报告时便能看到其最终状态。
调用形式
https://xtapi.uincall.com/api/call/querySmsReportV2.action
调用方式
POST
传入参数
序号 | 参数名称 | 是否必填 | 参数说明 |
---|---|---|---|
1 | appver | 是 | 应用版本值:1 |
2 | user | 是 | 登录用户名 |
3 | secret | 是 | 计算sercert请阅读1 2 3(不能直接拿3获取到的token直接赋值给当前接口的secret进行调用) |
4 | timestamp | 是 | 当前时间,服务端会验证时间有效性,如果与服务端时间差大于 10 分钟则请求无效。 |
5 | account | 是 | 企业号码 |
6 | serviceSn | 否 | 短信流水号,如果不填,则返回有运营商报告的短信记录,上限500条。 |
回应参数
序号 | 名称 | 是否必填 | 说明 |
---|---|---|---|
1 | errcode | 是 | 0为成功,其它为失败。 |
2 | errmsg | 是 | 结果解释。 |
3 | total | 是 | 短信数量。 |
4 | data | 是 | 参考以下字段 |
5 | uuid | 是 | 短信详细表uuid |
6 | serviceSn | 是 | 短信的流水号 |
7 | sendStatus | 是 | 发送状态:0:未发送,1:发送成功,2:发送失败,3:提交成功,4:提交失败 |
8 | sendTime | 是 | 发送时间 |
9 | msg | 是 | 短信内容 |
10 | mobile | 是 | 手机号码 |
11 | description | 否 | 发送结果描述 |
使用样例
调用:
http://xtapi.uincall.com/api/call/querySmsReportV2.action
post 数据:
appver=1&user=4006090002_dev&account=4006333227×tamp=2016090710 0100&dn=1001%2c1002&secret=b553c1d4430d2825ac93d1f51d6c658c
响应:
{
"data": [
{
"uuid":"8875f8f5-a69d-44f5-929e-6a87e79f7aea",
"serviceSn": "e9950ed0-bdd3-4c88-99e8-126abf258de8",
"sendTime": "2016-09-23 17:18:52.0",
"account": "4006333227",
"sendStatus": 0, // 未发送
"msg": "您的登录名:10841507 密码:RfXbE9【1xbet】",
"mobile": "13810995098",
"description": "未配置短信数据"
},
{
"uuid":"57f74081196b482796effc91b1ccc15b",
"serviceSn": "046aed5a-0bd9-418b-bd0a-4ff927dbee0a",
"sendTime": "2024-09-23 17:18:52.0",
"account": "4006333227",
"sendStatus": 1, // 发送成功
"msg": "照片上传总是失败状态",
"mobile": "16604111234",
"description": "发送成功"
}
],
"errmsg": "成功",
"errcode": 0,
"total":2
}
文档更新时间: 2025-03-05 09:31 作者:admin