短信回执 API

概述

短信回执 API 提供了获取短信发送状态接口、获取上行短信消息接口。

注意:短信发送状态、上行短信消息已提供回调的获取方式,若开发者已使用了回调的获取方式,则不支持使用短信回执 API 获取。


HTTP 验证

使用 HTTP Basic Authentication 的方式做访问授权。这样整个 API 请求可以使用常见的 HTTP 工具来完成,比如:curl,浏览器插件等;

HTTP Header(头)里加一个字段(Key/Value对):

Authorization: Basic base64_auth_string

其中 base64_auth_string 的生成算法为:base64(appKey:masterSecret),即:对 appKey 加上冒号,加上 masterSecret 拼装起来的字符串,再做 base64 转换。appKey、masterSecret 可以在控制台应用设置中查看。


获取短信发送状态

功能说明

  • 获取 appKey 下短信的发送状态报告;
  • API 调用频率为 5 秒/次,每次调用最多可获取 500 条数据;
  • 每条短信发送状态报告数据最多保留七天,即极光收到运营商返回状态报告后的七天。

调用地址

  • GET https://api.sms.jpush.cn/v1/report

请求示例

curl --insecure -X GET -v https://api.sms.jpush.cn/v1/report -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d2"

参数

返回示例

请求成功


[{"msgId":"88235123435","phone":"18612345577","receiveTime":1575015093000,"status":4001},{"msgId":"88235123436","phone":"18612345578","receiveTime":1575015093000,"status":4001}]

发送状态说明

CODE DESCRIPTION
4001 发送成功
4002 被叫手机号码为运营商黑名单,需联系运营商处理
4003 手机终端问题,手机关机、停机等,请确认手机状态是否正常
4004 被叫手机号码为空号,请核实手机号码是否合规
4005 可发送短信余量不足
4006 发送超频,发送频率超过运营商限制
4007 未应答,语音短信状态,语音短信呼叫成功,用户未接听或拒绝接听
4008 用户正忙,语音短信状态,被叫用户正忙
4009 无法接通,语音短信状态,不在服务区、手机无信号或电话被转入来电提醒等
4010 敏感词拦截,因短信内容存在敏感词导致运营商拦截
4100 其他错误

请求失败

{
    "error": {
        "code": *****,
        "message": "*****"
    }
}


获取上行短信消息

功能说明

  • 获取 appKey 下的上行短信消息;
  • API 调用频率为 5 秒/次,每次调用最多可获取 500 条数据;
  • 每条上行短信消息数据最多保留七天,即极光收到运营商返回上行消息后的七天。

调用地址

  • GET https://api.sms.jpush.cn/v1/reply

请求示例

curl --insecure -X GET -v https://api.sms.jpush.cn/v1/reply -H "Content-Type: application/json" -u "7d431e42dfa6a6d693ac2d04:5e987ac6d2e04d95a9d8f0d2"

参数

返回示例

请求成功

[{"content":"谢谢!","phone":"18612345577","replyTime":1575200268000},{"content":"谢谢!","phone":"18612345578","replyTime":1572581532000}]

请求失败

{
    "error": {
        "code": *****,
        "message": "*****"
    }
}


返回码

点击查看返回码说明


Copyright 2011-2019, jiguang.cn, All Rights Reserved.
粤ICP备12056275号-13 深圳市和讯华谷信息技术有限公司

Documentation built with MkDocs.