短信服务 API
状态回执与上行推送 (WebHook)
当您成功调用发送接口后,仅代表 Luosimao 成功接收了请求。短信实际是否送达,需要等待运营商的最终回执。建议配置状态回执推送,以便系统实时感知下发状态。
1. 开启推送
2
找到推送设置
导航至 短信 -> 推送设置 菜单
3
配置接收地址
分别填写「接收状态」和「上行回复」的接收接口 URL (必须是公网地址) 并开启开关
2. 短信状态推送
当短信发送完成后,Luosimao 会将短信接收状态信息以 GET 请求的方式主动推送到您填写的地址上。
状态回执 WebHook GET 请求示例
GET https://yourdomain.com/sms/callback?batch_id=09-B0966...&mobile=13761428267&status=DELIVRD
2.1 推送参数说明
| 参数名 | 参数解释 | 示例 / 说明 |
|---|---|---|
batch_id |
发送批次号 | 09-B0966DD4-FD28-43C3-94A8-F762B2269B72(此 ID 与您调用发送接口时平台返回的 batch_id 一一对应,请在发送时做好关联记录) |
mobile |
目标手机号 | 13761428267 |
status |
最终接收状态 |
DELIVRD 接收成功 UNDELIV 接收失败(由于信号不良、关停机,空号、黑名单等异常情况) |
memo |
退回原因 | 仅当 status 为 REJECTED(被平台拦截或退回)时,会附带此参数用于说明具体原因 |
3. 上行短信推送
当用户回复短信(上行)时,Luosimao 会将内容以 GET 请求的方式主动推送到您填写的地址上。
上行推送 WebHook GET 请求示例
GET https://yourdomain.com/sms/mo?mobile=13761428267&message=T%E5%8F%8D%E9%A6%88%E5%86%85%E5%AE%B9
3.1 推送参数说明
| 参数名 | 参数解释 | 示例 / 说明 |
|---|---|---|
mobile |
回复手机号 | 13761428267 用户回复短信的手机号码 |
message |
回复内容 | 用户回复的短信内容(URL 编码) |
4. 响应要求
当您的服务器收到推送请求时,请务必返回 HTTP 状态码 200 OK。如果您响应了其他状态码或请求超时,系统将会启动重试机制(默认最多重试 3 次)。