API基本情報
機能名 | SMS送信結果取得(一括) | ||||||
リクエスト元 | ユーザー | ||||||
リクエスト先 | 『Karaden SMS API』 | ||||||
リクエスト方式 | GET | ||||||
リクエストContent-Type | - | ||||||
レスポンスContent-Type | application/json | ||||||
URL | /api/{tenant_id}/messages | ||||||
概要 |
送信リクエストを行ったメッセージの状態(結果)を一括で取得。 |
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 | - | - | - | SMS送信結果を取得したい送信先番号を指定。 |
3 | status | 状態 | string | - | - | API共通仕様>ステータス参照 | SMS送信結果を取得したい状態を指定。 |
4 | result | 結果 | string | - | - | API共通仕様>ステータス参照 | SMS送信結果を取得したい結果を指定。 |
5 | sent_result | 送達結果 | string | - | - | API共通仕様>ステータス参照 | SMS送信結果を取得したい送達結果を指定。 |
6 | tag | タグ | strings | - | - | - | SMS送信結果を取得したいタグを指定。 |
7 | start_at | 受付日時(開始) | string <date-time> ISO 8601形式 |
- | - | - | SMS送信結果を取得したい受付日時の開始日時を指定。 |
8 | end_at | 受付日時(終了) | string <date-time> ISO 8601形式 |
- | - | - | SMS送信結果を取得したい受付日時の終了日時を指定。 |
9 | page | ページ | integer | - | - | - | SMS送信結果を取得したいページ数を指定。 |
10 | per_page | 1ページあたりの取得件数 | integer | - | 20 | - | 1ページあたりの取得件数をを指定。100件まで入力可能。指定なしの場合、20件を適用。 |
レスポンス
# | 物理名 | 論理名 | 形式 | 必須 | デフォルト | 値 | 説明 |
1 | object | オブジェクトの型 | string | 〇 | "list" | "list" | - |
2 | has_more | 次ページ有無 | boolean | 〇 | - | - | - |
3 | data | 取得したデータ | Array of objects | 〇 | - | - | SMS送信 200 OKのレスポンス配列。 |