SMSステータス
クエリ
ユーザーによって送信されたSMSステータスのリスト。
このリストに対してクエリ操作を実行できます。
URL
https://sms.api.engagelab.cc/v1/status
https://sms.api.engagelab.cc/v1/status
このコードブロックはフローティングウィンドウ内に表示されます
HTTPリクエストメソッド
GET
GET
このコードブロックはフローティングウィンドウ内に表示されます
リクエストヘッダー
| ヘッダー | タイプ | 必須 | 説明 |
|---|---|---|---|
| Authorization | string | true | Basic base64(sms_user:sms_key) |
パラメーターの説明
| パラメーター | タイプ | 必須 | 説明 |
|---|---|---|---|
| offset | string | No | クエリの開始位置、範囲[0-]、デフォルトは0 |
| limit | string | No | クエリ数、範囲[0-100]、デフォルトは100 |
| time_zone | string | No | タイムゾーン。デフォルトのタイムゾーン: +8 |
| send_date | string | Yes | 送信日、形式: yyyy-mm-dd |
| phone | string | No | 電話番号 |
| sms_ids | string | No | SMSが正常に配信された際に返されるSMS ID、複数のsms_idsは「;」で区切り、最大10件まで対応 |
| msg_type | string | No | SMSタイプ、2は国際SMSを表します |
| sms_user | string | No | 顧客の特定のSMS_USER |
| template_id | string | No | テンプレートID |
| label_id | string | No | ラベルID |
| status | string | No | 1 送信済み, 2 配信済み, 3 受信待ち, 4 処理失敗, 5 送信失敗 |
| sub_status | string | No | サブステータス |
注意:
- 過去6か月以内の特定の日の詳細データのクエリをサポートします。
- 各クエリで取得された対応する記録は、ユーザーが提供したパラメーターに基づいて10分間キャッシュされます。
- このAPIは、各sms_userが1分間にインターフェースを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_API_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_API_KEY_HERE>>"
このコードブロックはフローティングウィンドウ内に表示されます
レスポンスの説明
| パラメーター | 説明 |
|---|---|
| phone | 電話番号 |
| sms_id | SMS ID |
| msg_type | SMSタイプ |
| sms_user | SMS_USER |
| template_id | テンプレートID |
| template_name | テンプレート名 |
| status | 1 送信済み, 2 配信済み, 3 受信待ち, 4 処理失敗, 5 送信失敗 |
| status_desc | SMS配信ステータスの説明、5つのステータスに分かれます: リクエスト, 配信済み, 処理失敗, 送信失敗, 受信待ち |
| sub_status | サブステータス |
| sub_status_desc | サブステータスの説明、以下の表を参照 |
| request_time | リクエスト時間 |
| update_time | 更新時間 |
| response_message | 送信ログ |
処理失敗ステータスコードと説明:
| sub_status | サブステータスの説明 |
|---|---|
| 410 | 処理失敗 - グローバルブロックリスト |
| 420 | 処理失敗 - ローカルブロックリスト |
| 430 | 処理失敗 - 購読解除 |
| 440 | 処理失敗 - キーワードフィルター |
| 450 | 処理失敗 - 変数置換エラー |
| 460 | 処理失敗 - コンテンツの不適合 |
| 470 | 処理失敗 - 頻度制限超過 |
| 480 | 処理失敗 - その他 |
送信失敗ステータスコードと説明:
| sub_status | サブステータスの説明 |
|---|---|
| 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": "success",
"sms_user": "*****",
"status_desc": "delivery",
"status":2,
"template_id": "10",
"template_name": "engagelab code",
"update_time": "2017-02-19 00:21:21"
}
],
"total": 1
}
{
"result": [{
"sms_id":"***_**_**_**_**$**",
"msg_type": 2,
"phone": "+16235217",
"request_time": "2017-02-19 00:21:20",
"response_message": "success",
"sms_user": "*****",
"status_desc": "delivery",
"status":2,
"template_id": "10",
"template_name": "engagelab code",
"update_time": "2017-02-19 00:21:21"
}
],
"total": 1
}
このコードブロックはフローティングウィンドウ内に表示されます
