短信状态

查询

用户发送的短信状态列表你可以对此列表进行查询操作

URL

https://sms.api.engagelab.cc/v1/status

          https://sms.api.engagelab.cc/v1/status

此代码块在浮窗中显示

HTTP请求方式

GET

GET

此代码块在浮窗中显示

Request-Headers

Header	类型	必须	说明
Authorization	string	true	Basic base64(sms_user:sms_key)

参数说明

参数	类型	必须	说明
offset	string	否	查询起始位置，取值区间 [0-]，默认为 0
limit	string	否	查询个数，取值区间 [0-100]，默认为 100
time_zone	string	否	时区。默认时区：+8
send_date	string	是	发送日期，格式为 yyyy-mm-dd
phone	string	否	手机号码
sms_ids	string	否	短信投递成功时候返回的 sms_ids，多个sms_ids用 ;分开，最大支持10个
msg_type	string	否	短信类型，2表示国际短信
sms_user	string	否	客户的某个 SMS_USER
template_id	string	否	模板ID
label_id	string	否	标签ID
status	string	否	1发送，2送达，3待回执，4处理失败，5发送失败
sub_status	string	否	子状态

注意：

支持查询6个月以内某天明细数据

每次查询得到的对应的记录会根据用户所传参数缓存10分钟

此接口限制每个sms_user，每分钟调用接口60次

请求示例

curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2" --header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"

          curl -X GET "sms.api.engagelab.cc/v1/status?start_date=2011-11-20&end_date=2011-11-20?msg_types=2" 
--header "Authorization: Basic <<YOUR_SMS_KEY_HERE>>"

此代码块在浮窗中显示

响应说明

参数	说明
phone	电话号码
sms_id	短信ID
msg_type	短信类型
sms_user	SMS_USER
template_id	模板ID
template_name	模板名称
status	1发送，2送达，3待回执，4处理失败，5发送失败
status_desc	短信投递状态描述，分为请求、送达、处理失败、发送失败、待回执五种状态
sub_status	子状态
sub_status_desc	子状态描叙，见下表
request_time	请求时间
update_time	更新时间
response_message	发送日志

处理失败状态码及描述：

sub_status	sub_status description
410	处理失败-全局拦截列表
420	处理失败-局部拦截列表
430	处理失败-取消订阅
440	处理失败-关键词过滤
450	处理失败-替换变量错误
460	处理失败-内容不符合规范
470	处理失败-频率超限
480	处理失败-其他

发送失败状态码及描述：

sub_status	sub_status description
500	发送失败-空号
510	发送失败-停机
520	发送失败-黑名单
530	发送失败-占线
540	发送失败-无人接听
550	发送失败-拦截
560	发送失败-手机故障
570	发送失败-不在服务区
580	发送失败-关机
590	发送失败-其他

响应示例

{ "result": [{ "sms_id":"***_**_**_**_**$**", "msg_type": 2, "phone": "+16235217", "request_time": "2017-02-19 00:21:20", "response_message": "Delivery", "sms_user": "*****", "status_desc": "Delivery", "status":2, "template_id": "10", "template_name": "engagelab code", "update_time": "2017-02-19 00:21:21" } ], "count": 1, "total": 1 } }

          {
    "result":  [{
                "sms_id":"***_**_**_**_**$**",
                "msg_type": 2,
                "phone": "+16235217",
                "request_time": "2017-02-19 00:21:20",
                "response_message": "Delivery",
                "sms_user": "*****",
                "status_desc": "Delivery",
                "status":2,
                "template_id": "10",
                "template_name": "engagelab code",
                "update_time": "2017-02-19 00:21:21"
            }
        ],
        "count": 1,
        "total": 1
    }
}

此代码块在浮窗中显示