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}/messages |
| 概要 |
SMS送信結果情報（BULK）を一括で取得します。
202：BULK送信状態「完了」かつファイル作成中、又はBULK送信状態「処理待ち」「処理中」「処理エラー」のいずれか 302：ファイル作成完了
※本APIは、エンタープライズプランにて請求書払いの請求先が紐づくプロジェクトのみご利用可能です。 |
| AUTHORIZATIONS | Bearer（必須） | トークン |
| PATH PARAMETERS | tenant_id（必須） | テナントID |
| bulk_message_id（必須） | BULK MESSAGE ID | |
| HEADER PARAMETERS | Karaden-Version（必須） | APIバージョン。 例）2024-03-01 |
リクエスト
・パラメーターなし
レスポンス
HTTPステータスコード（202、302）
・パラメーターなし
※csvを返却する為、レスポンスパラメータは存在しない。
202 : BULK送信状態「完了」かつファイル作成中、又はBULK送信状態「処理待ち」「処理中」「処理エラー」のいずれか
302 : LocationヘッダにダウンロードURLを設定
HTTPステータスコード（202、302以外）
・パラメータは SMS送信 と同じ。
送信結果ファイル
| 出力条件 | BULK MESSAGE IDに紐づくSMS送信結果（BULK）情報を出力（JSON形式） 件数上限は10000件 |
|---|---|
| 出力単位 | メッセージ単位でレコードを出力 |
| ソート | なし（送信情報csvで受け取ったメッセージ順） |
| ファイル名 |
messages_bulk-YmdHis.json （ex: messages_bulk-20220102010203.json） ※生成時の日時 |
| 改行コード | CR+LF |
| 文字コード | UTF-8 |
出力情報
※下記項目をオブジェクトの配列で返却
| # | 物理名 | 論理名 | 形式 | 必須 （値が無ければnull） |
デフォルト | 値 | 説明 |
| 1 | id | メッセージID | string <uuid> | - | - | - | SMS送信要求を受付できた場合のみ採番。 |
| 2 | object | オブジェクトの型 | string | 〇 | "message" | "message" | - |
| 3 | project_id | プロジェクトID | integer | 〇 | - | - | - |
| 4 | service_id | サービス設定ID | integer | 〇 | - | - | - |
| 5 | billing_address_id | 請求先ID | integer | 〇 | - | - | - |
| 6 | to | 送信先番号 | string^[0-9]{11}$ | 〇 | - | - | - |
| 7 | body | 本文 | string | 〇 | - | - | - |
| 8 | tags | タグ | Array of strings | 〇 | - | - | - |
| 9 | is_shorten | 短縮URL | boolean | 〇 | - | - | - |
| 10 | result | 結果 | string | 〇 | - | SMS API共通仕様＞ステータス参照 | - |
| 11 | status | 状態 | string | 〇 | - | SMS API共通仕様＞ステータス参照 | - |
| 12 | sent_result | 送達結果 | string | 〇 | - | SMS API共通仕様＞ステータス参照 | - |
| 13 | carrier | キャリア | string | 〇 | - | SMS API共通仕様＞ステータス参照 | - |
| 14 | charged_count_per_sent | 課金対象通数 | integer | 〇 | - | - | 本文を請求単位で分割した通数。 |
| 15 | limited_at | 送信限度日時 | string <date-time> ISO 8601形式 |
〇 | - | - | - |
| 16 | sent_at | 送信日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 『Karaden SMS API』がSMSを送信した日時。 |
| 17 | received_at | 着信日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 端末に着信した日時。 |
| 18 | charged_at | 課金確定日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 送信したメッセージに対する課金が確定した日時。 |
| 19 | created_at | 受付日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 『Karaden SMS API』へのSMS送信要求を受付した日時。 |
| 20 | updated_at | 更新日時 | string <date-time> ISO 8601形式 |
〇 | - | - | - |
| 21 | error | エラー情報 | Array of objects | - | - | エラーコード参照 | - |
| 22 | is_shorten_clicked | 短縮URLのクリック有無 | boolean | 〇 | - | - | 詳細については「短縮URL仕様について」を参照。 |