SMSインターセプション
URL
https://sms.api.engagelab.cc/v1/bounces
https://sms.api.engagelab.cc/v1/bounces
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| 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 | SMSインターセプションステータス |
| msg_type | SMSタイプ、2は国際SMSを示します |
| bounce_time | SMSインターセプション時間 |
| expire_time | SMSインターセプション有効期限 |
| reason | SMSインターセプションの理由 |
bounce_type 対応するタイプコードと説明
| バウンスタイプ | 説明 |
|---|---|
| 500 | 送信失敗、番号が存在しない |
| 510 | 送信失敗、番号が停止中 |
| 520 | 送信失敗、番号がブラックリストに登録されている |
| 530 | 送信失敗、番号がビジー状態 |
| 540 | 送信失敗、番号から応答がない |
| 550 | 送信失敗、テンプレート内容がインターセプトされた |
| 560 | 送信失敗、モバイル端末エラー |
| 570 | 送信失敗、番号がサービスエリア外 |
| 580 | 送信失敗、モバイル端末が電源オフ |
| 590 | 送信失敗、その他の理由 |
| 410 | グローバルインターセプションリスト |
| 411 | カスタムグローバルインターセプションリスト |
| 420 | ローカルインターセプションリスト |
| 421 | カスタムローカルインターセプションリスト |
| 430 | 購読解除 |
| 440 | キーワードフィルタリング |
| 450 | 変数置換エラー |
| 460 | 変数の長さが制限を超えている |
| 470 | エンコーディング例外（注：エンコーディング例外は460に統合され、現在470は頻度制限超過を示します） |
| 480 | サポートされていない送信タイプ |
レスポンス例
Response-success
HTTP Status: 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": "Customize local interception list"
}
],
"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": "Customize local interception list"
}
],
"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
このコードブロックはフローティングウィンドウ内に表示されます
ヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| 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 | 削除されたインターセプションの数 |
レスポンス例
Response-success
HTTP Status: 200
{
"count": 1
}
{
"count": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
Response-error
HTTP Status :401
{
"code": 30000,
"message": "Unauthorized."
}
{
"code": 30000,
"message": "Unauthorized."
}
このコードブロックはフローティングウィンドウ内に表示されます
