API基本情報
| 機能名 | SMS送信 | ||||||
| リクエスト元 | ユーザー | ||||||
| リクエスト先 | 『Karaden SMS API』 | ||||||
| リクエスト方式 | POST | ||||||
| リクエストContent-Type | application/x-www-form-urlencoded | ||||||
| レスポンスContent-Type | application/json | ||||||
| URL | /api/{tenant_id}/messages | ||||||
| 概要 | SMSのメッセージ送信リクエスト。 | ||||||
| AUTHORIZATIONS | Bearer（必須） | トークン | |||||
| PATH PARAMETERS | tenant_id（必須） | テナントID | |||||
| HEADER PARAMETERS | Karaden-Version（必須） | APIバージョン。 例）2023-01-01 |
|||||
リクエスト
| # | 物理名 | 論理名 | 形式 | 必須 | デフォルト | 値 | 説明 |
| 1 | service_id | サービス設定ID | integer | 〇 | - | - | SMS送信するサービス設定IDを指定。 |
| 2 | to | 送信先番号 | string^[0-9]{11}$ | 〇 | - | - | SMS送信する宛先携帯電話番号を指定。 バリデーションは※1参照。 |
| 3 | body | 本文 | string | 〇 | - | - | 送信するSMSのメッセージ本文を指定。最大660文字。 |
| 4 | tags | タグ | Array of strings | - | - | - | 送信要求毎に利用用途などを識別する内容を指定。 |
| 5 | is_shorten | 短縮URL | boolean | - | - | - |
短縮URLの使用有無を指定。 指定なしの場合、サービス設定に登録された設定を適用。 |
| 6 | scheduled_at | 送信予定日時 | string <date-time> ISO 8601形式 |
- | - | - | SMSを送信予約する日時を指定。30日後の日時まで指定可能。指定なしの場合、即時送信。 |
| 7 | limited_at | 送信限度日時 | string <date-time> ISO 8601形式 |
- | - | - | SMSを送信する限度日時を指定。 |
レスポンス
HTTPステータスコード（200 OK）
| # | 物理名 | 論理名 | 形式 | 必須 (値が無ければnull) |
デフォルト | 値 | 説明 |
| 1 | id | メッセージID | string <uuid> | 〇 | - | - | - |
| 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 | scheduled_at | 送信予定日時 | string <date-time> ISO 8601形式 |
〇 | - | - | - |
| 16 | limited_at | 送信限度日時 | string <date-time> ISO 8601形式 |
〇 | - | - | - |
| 17 | sent_at | 送信日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 『Karaden SMS API』がSMSを送信した日時。 |
| 18 | received_at | 着信日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 端末に着信した日時。 |
| 19 | charged_at | 課金確定日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 送信したメッセージに対する課金が確定した日時。 |
| 20 | created_at | 受付日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 『Karaden SMS API』へのSMS送信要求を受付した日時。 |
| 21 | updated_at | 更新日時 | string <date-time> ISO 8601形式 |
〇 | - | - | - |
| 22 | 【Ver.2023-12-01以降対応】 is_shorten_clicked |
短縮URLのクリック有無 | boolean | 〇 | - | - | Ver.2023-12-01以降レスポンスに含まれる。詳細については「短縮URL仕様について」を参照。 |
※1 送信先番号・ユーザーの携帯電話番号
・以下のみ利用可。
「020」で始まる11桁の数字
「070」で始まる11桁の数字
「080」で始まる11桁の数字
「090」で始まる11桁の数字
<例外>
・09044440010～09044440018はご利用できません。
・「0200」「0700」「0800」「0900」で始まる番号はご利用できません。
HTTPステータスコード（200 OK以外）
| # | 物理名 | 論理名 | 形式 | 必須 | デフォルト | 値 | 説明 |
| 1 | object | オブジェクトの型 | string | 〇 | "error" | "error" | - |
| 2 | code | エラーコード | string | 〇 | - | エラーコード参照 | - |
| 3 | message | エラーメッセージ | string | 〇 | - | SMS API共通仕様＞ステータス参照 | - |
| 4 | errors | エラー詳細 | object | - | - | - | エラーの詳細をエラーが発生したリソースのプロパティ毎に返却。 オブジェクトのプロパティ名は、エラーが発生したリソースのプロパティ名。 オブジェクトの値は、発生したすべてのエラーメッセージ。（配列） |
バリデーションエラーの例（エラーコードの詳細は エラーコード参照 ）
{ "object": "error",
"code": "validation_error",
"message": "バリデーションエラーが発生しました",
"errors":
{ "body": [
"本文は、660文字以下にしてください。"
]
}
}