接口概述
- 本API是获取终端用户回复短信中的内容，即上行报告。可以实现与终端用户交互的场景。例如：用户回复的退订信息、办理业务答复等等。
注意事项
- 上行报告的获得方式有推送和拉取这两种方式，同时只能选择一种，不可同时选择。
接入流程
- 获得的方式需要登录控制台，在对应"API账号"的"产品配置"目录下配置获得方式，详情操作指引请查看控制台操作指南。
推送的方式
此接口默认开通，回送地址服务器需要启动一个 http 服务用于接收上行短信。用户在收到上行短信后需要自己写个方法去做处理收到的参数。我们将为您实时推送回复的短信。
推送请求
URL：http://client_url
推送方式：GET
推送绑定上行接收地址
示例说明
比如用户账户设置的上行短信回送地址为：http://client_url，那么当 253 平台收到运营商回送的上行短信后便会以 get 请求访问以下 url：
http://client_url?receiver=&pswd=&moTime=2411041614&mobile=13900000000&msg=%E6%82%A8%E5%A5%BD&destcode=10690923&spCode=10690923&extend=123¬ifyTime=241104161450
注释：推送第一次不成功会推送第二次，第二次推送不成功推送第三次，第三次推送不成功就不会再推。间隔时间为 1 分钟。服务端推送：将推送地址配置在账号中，当服务端推送成功后需要客户端响应具体的 json 响应码
示例如下：
{"clcode":"000000"} ---- 代表成功
{"clcode":"111111"} ---- 代表失败，需要重新推送（按照一定规则重新推送）
推送 GET 参数
| 名称 | 类型 | 描述 | 示例 |
|---|
| receiver | string | 接收验证的用户名，配置时不填写则为空，如需配置请联系技术 | "receiver":"" |
| pswd | string | 接收验证的密码，配置时不填则为空，如需配置请联系技术 | "pswd":"" |
| moTime | string | 终端回复短信的时间，格式 yyMMddHHmm，其中 yy=年份的最后两位（00-99） | "moTime":"2411041614" |
| notifyTime | string | 创蓝平台收到运营商推送的时间，格式 yyMMDDhhmmss | "notifyTime":"241104161450" |
| mobile | string | 终端回复短信的手机号码 | "mobile":"13900000000" |
| msg | string | 终端回复的内容，内容经过 URLEncode 编码(UTF-8) ,需要自行解码后得到明文 | "msg":"%E6%82%A8%E5%A5%BD" |
| extend | string | 扩展码，这里为提交短信时所传的extend，纯数字 | "extend":"123" |
destcode | 已废弃 | 没有实际用处 通道码 | 已废弃 |
spCode | 已废弃 | 没有实际用处 通道码 | 已废弃 |
拉取的方式
开通此接口功能后，数据拉取成功后服务器会删除当前拉取成功的数据，不再保存！请妥善处理接口返回的数据。此状态报告保存上限存储 100 万条，请及时拉取走数据避免丢失。
注：该接口默认不开放，联系客服开启。
请求
URL：https://smssh1.253.com/msg/pull/mo
请求方式：json 格式封装的字符串，采用 post 方式提交请求
请求协议：http，https
编码格式：utf-8
Content-Type：application/json
参数说明
| 参数名 | 类型 | 是否必须 | 描述 | 示例 |
|---|
| account | string | 是 | API 账号 | "account":"N9000001" |
| password | string | 是 | API 密码（8-16 位） | "password":"ABCdef15301" |
| count | integer | 否 | 拉取个数（上限 100，默认 20） | "count":"20" |
请求示例
{
"account":"N6000001",
"password":"123456",
"count":"20"
}
响应
参数说明
| 参数名 | 类型 | 描述 | 示例 |
|---|
| ret | int | 请求状态。0 成功，其他状态为失败 | "ret":0 |
| result | string | 上行明细结果，没结果则返回空数组 | "result":[{XXX}] |
| mobile | string | 终端回复短信的手机号码 | "mobile":"13900000000" |
| messageContent | string | 终端回复的内容 | "messageContent":"您好" |
| moTime | string | 终端回复短信的时间，格式 yyMMddHHmm，其中 yy=年份的最后两位（00-99） | "moTime":"2411041614" |
| extend | string | 发短信接口传入的extend参数，常用于匹配终端回复的上行归属哪一条下发短信。 | "extend":"123" |
destCode | 已废弃 | 没有实际用处 通道码 | 已废弃 |
spCode | 已废弃 | 没有实际用处 通道码 | 已废弃 |
响应示例
{
"ret": 0,
"result": [
{
"destCode": "106598054231708616",此值无实用
"mobile": "13900000000",
"moTime": "2411041614",
"spCode": "106598054231708616",此值无实用
"messageContent": "您好"
"extend": "123",
}
]
}
没有更多了
