API基本情報
| 機能名 | SMS送信状態取得（BULK） |
| リクエスト元 | ユーザー |
| リクエスト先 | 『Karaden SMS API』 |
| リクエスト方式 | GET |
| リクエストContent-Type | application/x-www-form-urlencoded |
| レスポンスContent-Type | application/json |
| URL | /api/{tenant_id}/messages/bulks/{bulk_message_id} |
| 概要 |
SMS送信（BULK）の送信状態を取得します。 ※本APIは、エンタープライズプランにて請求書払いの請求先が紐づくプロジェクトのみご利用可能です。 |
| AUTHORIZATIONS | Bearer（必須） | トークン |
| PATH PARAMETERS | tenant_id（必須） | テナントID |
| bulk_message_id（必須） | BULK MESSAGE ID | |
| HEADER PARAMETERS | Karaden-Version（必須） | APIバージョン。 例）2024-03-01 |
リクエスト
・パラメーターなし
レスポンス
HTTPステータスコード（200 OK）
| # | 物理名 | 論理名 | 形式 | 必須 (値が無ければnull) |
デフォルト | 値 | 説明 |
| 1 | id | BULK MESSAGE ID | string <uuid> | 〇 | - | - | - |
| 2 | object | オブジェクトの型 | string | 〇 | "bulk_message" | "bulk_message" | - |
| 3 | status | BULK送信状態 | string | 〇 | - | SMS API共通仕様＞ステータス参照 | - |
| 4 | error | エラー情報 | Array of objects | - | - | 下記エラー情報詳細参照 |
- |
| 5 | created_at | 受付日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 『Karaden SMS API』への要求を受付した日時。 |
| 6 | updated_at | 更新日時 | string <date-time> ISO 8601形式 |
〇 | - | - | - |
・エラー情報詳細
| # | 物理名 | 論理名 | 形式 | 必須 | デフォルト | 値 | 説明 |
| 1 | object | オブジェクトの型 | string | 〇 | "error" | "error" | - |
| 2 | code | エラーコード | string | 〇 | - | SMS API共通仕様＞エラーコード参照 | - |
| 3 | message | エラーメッセージ | string | 〇 | - | SMS API共通仕様＞エラーコード参照 | - |
| 4 | errors | エラー詳細 | object | - | - | - | エラーの詳細をエラーが発生したリスト要素、リソースのプロパティ毎に返却。 オブジェクトのプロパティ名は、エラーが発生したリソースのプロパティ名。 オブジェクトの値は、発生したすべてのエラーメッセージ。（配列） |
HTTPステータスコード（200 OK以外）
・パラメータは SMS送信 と同じ。