接口描述
功能描述
短信下发给用户后,腾讯云短信服务可以通过回调业务 URL 的方式,通知业务方短信下发的状态。
URL 示例
POST http://example.com/sms/callback
请求参数
请求参数如下表所示。
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
user_receive_time | 是 | string | 用户实际接收到短信的时间 |
nationcode | 是 | string | 国家(或地区)码 |
mobile | 是 | string | 手机号码 |
report_status | 是 | string | 实际是否收到短信接收状态,SUCCESS(成功)、FAIL(失败) |
errmsg | 是 | string | 用户接收短信状态码错误信息,参考 回执状态错误码 |
description | 是 | string | 用户接收短信状态描述 |
sid | 是 | string | 本次发送标识 ID(与发送接口返回的SerialNo对应) |
ext | 否 | string | 用户的 session 内容(与发送接口的请求参数SessionContext一致),如需开通请联系 腾讯云短信小助手 评估 |
说明:一次回调请求里可能有多次的短信请求结果,以 json 数组的形式。
请求示例:
[
{
"user_receive_time": "2015-10-17 08:03:04",
"nationcode": "86",
"mobile": "13xxxxxxxxx",
"report_status": "SUCCESS",
"errmsg": "DELIVRD",
"description": "用户短信送达成功",
"sid": "xxxxxxx"
}
]
响应参数
响应参数如下表所示。
参数 | 必选 | 类型 | 描述 |
---|---|---|---|
result | 是 | number | 错误码,0表示成功,非0表示失败 |
errmsg | 是 | string | 错误消息,result 非0时的具体错误信息 |
响应示例:
{
"result": 0,
"errmsg": "OK"
}
常见问题
- 回调请求推送失败后会重试几次?
回调请求推送失败后会再重试2次。 - 批量下发短信会回调几次?
短信下发状态会根据实际送达客户的时间,以一条或多条的形式推送到客户配置的回调地址。 - 如何测试配置的回调地址能够成功接收?
请您实际下发一条测试短信,请求成功后会将实际的下发状态推送到配置的回调地址。 - 基于安全等考虑,如何获取回调的 IP 列表?
- 国内站国内短信可参考获取服务器 IP 地址,通过调用 https://console.tim.qq.com/v4/ConfigSvc/GetIPList?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json 获取。推荐配置回调双向认证,具体可咨询 腾讯云短信小助手。
- 国际短信 IP 列表可咨询腾讯云短信小助手获取。