logo
logo
请输入关键词搜索产品或者文档
中国

中国站

创蓝云智

国际站

Innopaas

上行报告

更新时间:2026-07-29 20:03:55

接口概述

  • 本API是获取终端用户回复短信中的内容,即上行报告。可以实现与终端用户交互的场景。例如:用户回复的退订信息、办理业务答复等等。

注意事项

  • 每条上行回复记录只能获取一次,当我们推送给您或者您拉取走这一条数据后,将不在重复获得。

前置条件

前置条件说明
配置获取方式
  • 新开账户默认为推送方式,如需改为拉取需要登录控制台修改
  • 推送地址只能登录控制台配置。
  • 单个API账号同一时间只能选择一种获取方式。
配置示例

上行报告消息体

1、推送的方式

1.1推送 GET 参数

名称类型描述示例
receiverString接收验证的用户名,配置时不填写则为空,如需配置请联系技术"receiver":""
pswdString接收验证的密码,配置时不填则为空,如需配置请联系技术"pswd":""
moTimeString终端回复短信的时间,格式 yyMMddHHmm,其中 yy=年份的最后两位(00-99)"moTime":"2411041614"
notifyTimeString创蓝平台收到运营商推送的时间,格式 yyMMDDhhmmss"notifyTime":"241104161450"
mobileString终端回复短信的手机号码"mobile":"13900000000"
msgString终端回复的内容,内容经过 URLEncode 编码(UTF-8) ,需要自行解码后得到明文"msg":"%E6%82%A8%E5%A5%BD"
extendString扩展码,这里为提交短信时所传的extend,纯数字"extend":"123"

1.2示例说明

  • 比如用户账户设置的短信回送地址为: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&notifyTime=241104161450
 

1.3推送重试机制

  • 推送失败后将自动重试,最多重试2次(共3次推送机会)
  • 每次重推间隔时间为1分钟
  • 第三次推送失败后,将不再继续推送

1.4客户端响应要求

{"clcode":"000000"} ---- 代表成功
{"clcode":"111111"} ---- 代表失败,需要重新推送(按照一定规则重新推送)

2、拉取的方式

  • 我方拉取方式的明细存储上限为100万,建议您在发送短信后设置定时拉取任务,避免因存储上限导致明细丢失。

请求地址:

  • 请求方式:json 格式封装的字符串,采用 post 方式提交请求
  • Content-Type:application/json
  • 编码格式:utf-8
  • 请求地址:https://smssh1.253.com/msg/pull/mo

参数说明

参数名类型是否必须描述示例
accountStringAPI 账号"account":"N9000001"
passwordStringAPI 密码(8-16 位)"password":"ABCdef15301"
countinteger拉取个数(上限 100,默认 20)"count":"20"

请求示例

{
  "account": "N6000001",
  "password": "123456",
  "count": "20"
}

参数响应说明

参数名类型描述示例
retint请求状态。0 成功,其他状态为失败"ret":0
resultString上行明细结果,没结果则返回空数组"result":[{XXX}]
mobileString终端回复短信的手机号码"mobile":"13900000000"
messageContentString终端回复的内容"messageContent":"您好"
moTimeString终端回复短信的时间,格式 yyMMddHHmm,其中 yy=年份的最后两位(00-99)"moTime":"2411041614"
extendString发短信接口传入的extend参数,常用于匹配终端回复的上行归属哪一条下发短信。"extend":"123"
destCode已废弃没有实际用处 通道码已废弃
spCode已废弃没有实际用处 通道码已废弃

响应示例

{
    "ret": 0,
    "result": [
        {
            "destCode": "106598054231708616",此值无实用
            "mobile": "13900000000",
            "moTime": "2411041614",
            "spCode": "106598054231708616",此值无实用
            "messageContent": "您好"
            "extend": "123",
        }
    ]
}
24小时热线 400-9669-253