API基本情報
機能名 | SMS送信情報ファイルアップロードURL取得(BULK) |
リクエスト元 | ユーザー |
リクエスト先 | 『Karaden SMS API』 |
リクエスト方式 | POST |
リクエストContent-Type | - |
レスポンスContent-Type | application/json |
URL | /api/{tenant_id}/messages/bulks/files |
概要 |
一括送信したいメッセージ(一覧)を記述したファイル情報のアップロード先URLを取得します。 ※本APIは、エンタープライズプランにて請求書払いの請求先が紐づくプロジェクトのみご利用可能です。 |
AUTHORIZATIONS | Bearer(必須) | トークン |
PATH PARAMETERS | tenant_id(必須) | テナントID |
HEADER PARAMETERS | Karaden-Version(必須) | APIバージョン。 例)2024-03-01 |
リクエスト
・パラメーターなし
レスポンス
HTTPステータスコード(200 OK)
# | 物理名 | 論理名 | 形式 | 必須 (値が無ければnull) |
デフォルト | 値 | 説明 |
1 | id | ファイルID | string <uuid> | 〇 | - | - | - |
2 | object | オブジェクトの型 | string | 〇 | "bulk_file" | "bulk_file" | - |
3 | url | 署名付きURL(アップロード) | string | 〇 | - | - | - |
4 | created_at | 受付日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 『Karaden SMS API』へ要求を受付した日時。 |
5 | expires_at | 有効期限日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 有効期限はURL作成後から15分。 |
HTTPステータスコード(200 OK以外)
・パラメータは SMS送信 と同じ。