短信攔截
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
此代碼塊在浮窗中顯示
HTTP 請求方法
GET
GET
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | Basic base64(sms_user:sms_key) |
查詢參數說明
| 參數 | 類型 | 是否必需 | 描述 |
|---|---|---|---|
| offset | int | 否 | 偏移位置，[0-]，默認為0 |
| limit | int | 否 | 查詢個數，[0-100]，默認為100 |
| phone | string | 否 | 手機號 |
| start_date | string | 是 | 開始日期，格式為 yyyy-MM-dd |
| end_date | string | 是 | 結束日期，格式為 yyyy-MM-dd |
提示：
查詢間隔的天數在 start_date 和 end_date 之間不能超過 90 天。
請求示例
curl -X GET "https://sms.api.engagelab.cc/v1/bounces"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X GET "https://sms.api.engagelab.cc/v1/bounces"
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代碼塊在浮窗中顯示
返回值說明
| 參數 | 描述 |
|---|---|
| phone | 手機號 |
| bounce_type | 短信攔截的狀態 |
| msg_type | 短信類型，2 表示國際短信 |
| bounce_time | 短信攔截時間 |
| expire_time | 短信攔截失效時間 |
| reason | 短信攔截原因 |
bounce_type 對應的類型代碼及其描述
| 退信類型 | 描述 |
|---|---|
| 500 | 發送失敗，號碼不存在 |
| 510 | 發送失敗，號碼停機 |
| 520 | 發送失敗，號碼在黑名單中 |
| 530 | 發送失敗，號碼忙線 |
| 540 | 發送失敗，號碼無應答 |
| 550 | 發送失敗，模板內容被攔截 |
| 560 | 發送失敗，移動終端錯誤 |
| 570 | 發送失敗，號碼不在服務區 |
| 580 | 發送失敗，移動終端關機 |
| 590 | 發送失敗，其他原因 |
| 410 | 全局攔截列表 |
| 411 | 自定義全局攔截列表 |
| 420 | 本地攔截列表 |
| 421 | 自定義本地攔截列表 |
| 430 | 取消訂閱 |
| 440 | 關鍵詞過濾 |
| 450 | 變量替換錯誤 |
| 460 | 變量長度超過限制 |
| 470 | 編碼異常（注意：編碼異常與460合併，現在470表示頻率超限） |
| 480 | 不支持的發送類型 |
返回值示例
響應成功
HTTP 狀態碼: 200
{
"result": [
{
"phone": "008613681312917",
"bounce_type": 421,
"bounce_time": "2023-08-04T16:47:02+0800",
"expire_time": "2023-08-08T00:00:00+0800",
"msg_type": 2,
"reason": "自定義本地攔截列表"
}
],
"total": 1,
"count": 1
}
{
"result": [
{
"phone": "008613681312917",
"bounce_type": 421,
"bounce_time": "2023-08-04T16:47:02+0800",
"expire_time": "2023-08-08T00:00:00+0800",
"msg_type": 2,
"reason": "自定義本地攔截列表"
}
],
"total": 1,
"count": 1
}
此代碼塊在浮窗中顯示
刪除
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
此代碼塊在浮窗中顯示
HTTP 請求方法
DELETE
DELETE
此代碼塊在浮窗中顯示
Content-type
application/json
application/json
此代碼塊在浮窗中顯示
Header
| Header | 類型 | 是否必需 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | Basic base64(sms_user:sms_key) |
請求體參數說明
| 參數 | 類型 | 是否必需 | 描述 |
|---|---|---|---|
| phone | string | 是 | 電話號碼 |
| start_date | string | 是 | 開始日期，格式為 yyyy-MM-dd |
| end_date | string | 是 | 結束日期，格式為 yyyy-MM-dd |
提示：
查詢間隔的天數在 start_date 和 end_date 之間不能超過 90 天。
請求示例
curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces"
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
curl -X DELETE "https://sms.api.engagelab.cc/v1/bounces"
--data '{"start_date": "2021-03-01","end_date":"2021-03-02","phone":"008613681312917"}'
--header "Authorization: Basic <<YOUR_API_KEY_HERE>>"
此代碼塊在浮窗中顯示
返回值說明
| 參數 | 描述 |
|---|---|
| count | 刪除的攔截數量 |
返回值示例
響應成功
HTTP 狀態碼: 200
{
"count": 1
}
{
"count": 1
}
此代碼塊在浮窗中顯示
響應錯誤
HTTP 狀態碼: 401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
此代碼塊在浮窗中顯示
