メインコンテンツまでスキップ

クエリレポート

説明​

CPaaSプラットフォーム経由で送信されたモバイル宛（MT）のSMSについて、トランザクション履歴および配信レポートを取得します。

本番エンドポイントURL: https://api.cpaas.symphony.rakuten.net/cdr/v1/report/query/sms/transaction-history/mt

メソッド: GET

HTTPヘッダー

パラメータ必須値
AuthenticationYType: Bearer
Token: JWT Token
AcceptYapplication/json
Content-TypeYapplication/json; charset=UTF-8

リクエストボディスキーマ: application/json

パラメータ必須説明/値
date-fromはい開始日時（形式: YYYY-MM-DD HH:MM:SS）
date-toはい終了日時（形式: YYYY-MM-DD HH:MM:SS）
page-sizeいいえ1ページあたりの取得件数（推奨: 25〜100件）
pageいいえページ番号（最小: 1、最大: 1000）
api-keyいいえ特定のAPIキーでフィルタリング
networkいいえネットワークコードでフィルタリング
client-referenceいいえクライアント参照でフィルタリング
daいいえ宛先アドレス（宛先番号）でフィルタリング
oaいいえ送信者ID（Sender ID）でフィルタリング
statusいいえメッセージステータスでフィルタリング（例: DELIVRD, REJECTD など）。ステータス値を参照
tzいいえUTC または JST を指定して、UTCまたはJSTでデータを表示
sort-orderいいえ結果の並び順。値: asc または desc

サンプルリクエスト

curl --location 'https://api.cpaas.symphony.rakuten.net/cdr/v1/report/query/sms/transaction-history/mt?enterprise-id=<enterprise-id>&date-from=2025-10-01+00%3A00%3A00&date-to=2025-10-08+23%3A59%3A59&page-size=25&tz=UTC' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer <Bearer_Token>'

レスポンス:

成功時、HTTP 200 OK として、ページングおよびナビゲーション用のHATEOASリンクを備えたJSONドキュメントを返します。失敗レスポンスの説明は「Error Codes」セクションを参照してください。

パラメータ説明
page_size1ページあたりの件数
page現在のページ番号
_linksHATEOASナビゲーションリンク
_links.self現在ページへのリンク
_links.next次ページへのリンク
_links.first最初のページへのリンク
_links.last最後のページへのリンク
_embeddedレスポンスデータのコンテナ
_embedded.total_foundヒットしたレコード総数
_embedded.cdrsCDR（Call Detail Record）オブジェクトの配列
message_bodySMSで送信されたメッセージ本文（明示的に要求した場合のみ表示）
msg_encryptedメッセージが暗号化されているか（true / false）
unencrypted_message_bodymsg_encrypted が true の場合、暗号化されていないメッセージを表示
_links.self個別のCDR詳細へのリンク
typeメッセージ種別（例: モバイル宛は MT）
trx_id一意のトランザクションID
date_receivedメッセージ受信時刻（ISO 8601形式）
date_submitted_to_mnoモバイルネットワーク事業者（MNO）へ送信した時刻
api_key取引で使用されたAPIキー
api_key_nameAPIキー名
enterprise_idエンタープライズID
entity_idエンティティID
submitted_by_user_idメッセージ送信者のユーザーID
submitted_by_user_nameメッセージ送信者のユーザー名
submitted_by_user_emailメッセージ送信者のメール
submitted_by_admin_user_id管理者ユーザーID（該当する場合）
executed_by実行者の詳細情報
bulk_campaign_idキャンペーンID（キャンペーン経由の場合）
refクライアント参照
from_address送信者IDまたは送信元アドレス
to_address受信者の電話番号
network_codeモバイルネットワーク事業者コード
network_nameモバイルネットワーク事業者名
message_lengthメッセージの文字数
delivery_status配信ステータス（例: 配信済みは DELIVRD）
date_delivered配信完了時刻
dlr_error_code配信レシートのエラーコード
dlr_reason配信レシート理由の説明
delivery_method送信方法（例: Dashboard, Campaign, API）
priceメッセージの費用
price_currency価格の通貨
dcsデータコーディングスキーム
how_many_message_parts分割メッセージのパート数

サンプルレスポンス

{
    "page_size": 5,
    "page": 1,
    "_links": {
        "self": {
            "href": "/cdr/v1/report/query/sms/transaction-history/mt?page=1&page-size=5&enterprise-id=d07ece79-c034-462c-9205-a52ab9948991&sort-order=none&date-from=2025-10-01 00:00:00&tz="
        },
        "next": {
            "href": "/cdr/v1/report/query/sms/transaction-history/mt?page=2&page-size=5&enterprise-id=d07ece79-c034-462c-9205-a52ab9948991&sort-order=none&date-from=2025-10-01 00:00:00&tz="
        },
        "first": {
            "href": "/cdr/v1/report/query/sms/transaction-history/mt?page=1&page-size=5&enterprise-id=d07ece79-c034-462c-9205-a52ab9948991&sort-order=none&date-from=2025-10-01 00:00:00&tz="
        },
        "last": {
            "href": "/cdr/v1/report/query/sms/transaction-history/mt?page=2000&page-size=5&enterprise-id=d07ece79-c034-462c-9205-a52ab9948991&sort-order=none&date-from=2025-10-01 00:00:00&tz="
        }
    },
    "_embedded": {
        "total_found": 10000,
        "cdrs": [
            {
                "message_body": "Test Message 1",
                "msg_encrypted": "false",
                "unencrypted_message_body": "Test Message 1",
                "_links": {
                    "self": {
                        "href": "/cdr/v1/report/cdr/sms/transaction-history/mt/2ca23d7167e74a75b0ff56308f600e88"
                    }
                },
                "type": "MT",
                "trx_id": "2ca23d7167e74a75b0ff56308f600e88",
                "date_received": "2025-10-01T07:23:59.207+0000",
                "date_submitted_to_mno": "2025-10-01T07:23:59.652+0000",
                "api_key": "...API Key...",
                "api_key_name": "...API Key Name...",
                "enterprise_id": "...Enterprise ID...",
                "entity_id": "",
                "submitted_by_user_id": "...User ID...",
                "submitted_by_user_name": "...User Name...",
                "submitted_by_user_email": "...User Email ID...",
                "submitted_by_admin_user_id": "",
                "executed_by": "...Executed By...",
                "ref": "",
                "from_address": "...Sender ID...",
                "to_address": "...Destination Address...",
                "network_code": "44051",
                "network_name": "KDDI",
                "message_length": "21",
                "delivery_status": "DELIVRD",
                "date_delivered": "2025-10-01T07:24:01.971+0000",
                "dlr_error_code": "0",
                "dlr_reason": "Delivered",
                "delivery_method": "Dashboard",
                "price": "0.01000000",
                "price_currency": "JPY",
                "dcs": "0",
                "how_many_message_parts": 1
            },
            {
                "message_body": "Test Message 2",
                "msg_encrypted": "false",
                "unencrypted_message_body": "Test Message 2",
                "_links": {
                    "self": {
                        "href": "/cdr/v1/report/cdr/sms/transaction-history/mt/76452703159247a49740c38537558bb6"
                    }
                },
                "type": "MT",
                "trx_id": "76452703159247a49740c38537558bb6",
                "date_received": "2025-10-01T07:25:04.812+0000",
                "date_submitted_to_mno": "2025-10-01T07:25:05.470+0000",
                "api_key": "...API Key...",
                "api_key_name": "...API Key Name...",
                "enterprise_id": "...Enterprise ID...",
                "entity_id": "",
                "submitted_by_user_id": "...User ID...",
                "submitted_by_user_name": "...User Name...",
                "submitted_by_user_email": "...User Email ID...",
                "submitted_by_admin_user_id": "",
                "executed_by": "...Executed By...",
                "ref": "",
                "from_address": "...Sender ID...",
                "to_address": "...Destination Address...",
                "network_code": "44020",
                "network_name": "Softbank Mobile Corp",
                "message_length": "49",
                "delivery_status": "DELIVRD",
                "date_delivered": "2025-10-01T07:25:07.329+0000",
                "dlr_error_code": "0",
                "dlr_reason": "Delivered",
                "delivery_method": "Campaign",
                "price": "0.14000000",
                "price_currency": "JPY",
                "dcs": "0",
                "how_many_message_parts": 1
            }
        ]
    }
}

ページネーション

このAPIはHATEOASリンクによるカーソルベースのページネーションを使用します:

  • 次ページを取得するには _links.next.href を使用
  • 最初のページに戻るには _links.first.href を使用
  • 最後のページへ移動するには _links.last.href を使用
  • total_found フィールドは利用可能なレコードの総数を示します

注意事項

  • すべてのタイムスタンプはUTCタイムゾーンオフセット付きのISO 8601形式（YYYY-MM-DD HH:MM:SS）で返されます
  • 空文字列は、そのトランザクションに該当しない、または提供されていないことを示します
  • 各CDR内の _links.self オブジェクトは、当該トランザクションの詳細情報を取得するための直接リンクを提供します
  • 最大日付範囲: クエリ性能向上のため日付範囲を制限してください。最大範囲は31日です
  • レート制限: ユーザーまたはIPごとの同時API呼び出し数は1に制限されています
  • 1分/1時間/1日あたりのリクエスト数: 不正使用防止と公平な利用のため、以下の制限が適用されます
期間上限
分3
時間10
日100
  • ページサイズ: 適切なページサイズ（推奨: 25〜100件）を使用して、API呼び出し回数とレスポンスサイズのバランスを取ってください
  • ページ: ページネーションのページ番号（最小: 1、最大: 1000）
  • フィルタリング: enterprise-id、api-key、network などのフィルタを適用して、結果を絞り込み、性能を向上させてください