短信狀態

最新更新:2023-04-10

查詢

用戶發送的短信狀態列表 你可以對此列表進行查詢操作

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 子狀態
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 子狀態

注意:

  1. 支持查詢6個月以內某天明細數據
  2. 每次查詢得到的對應的記錄會根據用戶所傳參數緩存10分鐘
  3. 此接口限制每個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
    }
}

        
此代碼塊在浮窗中顯示
在文档中心打开
icon
聯繫銷售