获取上行回复短信

更新时间：2020-07-09 16:02:58

1. 功能说明

开通此接口功能后，您可以通过接口主动请求获取手机终端回复的上行短信。

1.1 功能要点

1.1.1 本功能默认不开启，如需开启请前往“系统设置→开发管理→接口设置→消息接收”页设置；
1.1.2 数据默认保存时间为72小时，且已成功获取的数据将会删除，请妥善处理接口返回的数据；
1.1.3 平台每次返回最大100组内容，考虑到获取效率及性能，建议使用单线程获取，接收数据后再做异步处理；
1.1.4 建议采用POST方法提交请求。时间间隔最好定为1分钟左右；
1.1.5 同一条上行回复短信，只能被一种方式接收。如：已通过“推送上行回复短信”接口接收，则“获取上行回复短信”接口将不会接收；
1.1.6 提取地址：http(s)://api.guoyangyun.com/api/sms/smsReply.htm

1.2 协议说明

参数	说明
协议	HTTP + JSON
编码	UTF-8

2. 开启HTTP批量获取

2.1 打开并登录国阳云平台：http://www.guoyangyun.com/webx/user/auth/sign.htm。
2.2 在“接口设置”中，点击“消息接收” 标签页，进行开启/关闭HTTP批量获取。如下图：

3. 请求说明

3.1 HTTP头信息

Accept:application/json;charset=utf-8;
Content-Type:application/x-www-form-urlencoded;charset=utf-8;

3.2 请求参数

参数	名称	类型	必须	描述
公共参数	公共参数	—	是	详见《公共参数和配置》文档

3.3 请求示例

http(s)://api.guoyangyun.com/api/sms/smsReply.htm?appkey=123456&appsecret=20a1eb330d41d0d4d

4. 响应说明

4.1 JSON返回参数

参数	名称	类型	描述
code	错误码	Int	提交返回结果。0：表示成功，其他：失败。（状态码详见：《公共错误代码定义》）
msg	返回信息	String	返回信息。
num	记录数	Int	若code值为0即成功时，才有该参数。表示本次取出上行记录总数。例num=3表示有3个上行记录信息。若num=0表示没有上行记录信息。
list	回复信息	List	回复详细信息
smsid	消息ID	String	发送短信时，系统返回（或者自己指定）的消息ID
mobile	手机号码	String	回复的手机号码
content	回复内容	String	回复的完整内容
receiveTime	回复时间	String	收到回复（上行）时间
subPort	端口号	String	接收回复（上行）的端口号

4.2.调用成功样例

{
    "msg":"成功",
    "code":"0",
    "num":2,
    "list":[
        {
            "smsid":"161909418460016390865964411",
            "subPort":null,
            "mobile":"18911111111",
            "content":"收到了",
            "receiveTime":"2021-04-23 15:48:37"
        },
        {
            "smsid":"1629446104768163908659626140",
            "subPort":null,
            "mobile":"18900000000",
            "content":"回复测试",
            "receiveTime":"2021-08-21 09:20:47"
        }
    ]
}

4.3.调用失败样例

{
    "code":"XXXX",
    "msg":"错误提示内容”
}

results matching ""

No results matching ""