API基本情報
| 機能名 | SMS送達結果通知 | ||||||
| リクエスト元 | 『Karaden SMS API』 | ||||||
| リクエスト先 | ユーザー | ||||||
| リクエスト方式 | POST | ||||||
| リクエストContent-Type | application/json | ||||||
| レスポンスContent-Type | - | ||||||
| URL | - | ||||||
| 概要 | サービス設定で指定されているエンドポイントへSMS送達結果を通知。 | ||||||
| HEADER PARAMETERS | Karaden-Version（必須） | APIバージョン。 サービス設定に登録されたAPIバージョンを設定。 例）2023-01-01 |
|||||
リクエスト
| # | 物理名 | 論理名 | 形式 | 必須 | デフォルト | 値 | 説明 |
| 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 | tags | タグ | Array of strings | - | - | - | - |
| 7 | is_shorten | 短縮URL | boolean | - | - | - | - |
| 8 | result | 結果 | string | 〇 | - | API共通仕様＞ステータス参照 | - |
| 9 | status | 状態 | string | 〇 | - | API共通仕様＞ステータス参照 | - |
| 10 | sent_result | 送達結果 | string | 〇 | - | API共通仕様＞ステータス参照 | - |
| 11 | carrier | キャリア | string | 〇 | - | API共通仕様＞ステータス参照 | - |
| 12 |
charged_count _per_sent |
課金対象通数 | integer | 〇 | - | - | 本文を請求単位で分割した通数。 |
| 13 | scheduled_at | 送信予定日時 | string <date-time> ISO 8601形式 |
- | - | - | - |
| 14 | limited_at | 送信限度日時 | string <date-time> ISO 8601形式 |
- | - | - | - |
| 15 | sent_at | 送信日時 | string <date-time> ISO 8601形式 |
- | - | - | 『Karaden SMS API』がSMSを送信した日時。 |
| 16 | received_at | 着信日時 | string <date-time> ISO 8601形式 |
- | - | - | 端末に着信した日時。 |
| 17 | charged_at | 課金確定日時 | string <date-time> ISO 8601形式 |
- | - | - | 送信したメッセージに対する課金が確定した日時。 |
| 18 | created_at | 受付日時 | string <date-time> ISO 8601形式 |
〇 | - | - | 『Karaden SMS API』へのSMS送信要求を受付した日時。 |
| 19 | updated_at | 更新日時 | string <date-time> ISO 8601形式 |
〇 | - | - | - |