登录 注册

飞鸽API文档

API:主动获取报告

采用 HTTP POST 调用模式，飞鸽API 该接口主要用于准确定位短信是否送达，如关机、空号等情况可以准确定位出 限定5S一次

请求URL

https://data.4321.sh/sms/report

请求参数

  • 参数 类型 是否可空 默认 描述
  • apikey
    string
    N
    无
    通知/营销短信产品Api接口账号
  • secret
    string
    N
    无
    通知/营销短信产品Api接口秘钥
  • count
    int
    Y
    10
    获取报告条数 默认10条 [10,100]

协议

HTTP POST

编码格式

UTF-8

Content-Type

application/json

是否与要授权

是

参阅 API 授权和验证机制

错误代码

参阅 API 错误代码

返回值格式

json默认

{
 "data": [{
 "msg_no": "20210618180036992291",
 "mobile": "18221292401",
 "status": "FG:0001",
 "status_desc": "飞鸽黑名单",
 "time": 1624039239
 }],
 "code": 0,
 "msg": "OK"
}

返回值参数说明

  • 参数 描述 示例
  • data
    报告集合
    报告集合
  • msg_no
    短信回执编号，为唯一识别码
    默认格式如：20210618180036992291
  • status
    短信状态
    成功接收为DELIVRD
  • status_desc
    短信状态描述
    成功
  • time
    1477366109(2016-10-25 11:28:29)
    短信接收时间(时间戳)
  • mobile
    接收对应的手机号码
    接收对应的手机号码
  • code
    接口回执状态码，判断成功失败的标志
  • msg
    接口回执状态描述