Query Report

Description

Retrieve SMS transaction history and delivery reports for mobile-terminated (MT) messages sent through the CPaaS platform.

Production Endpoint URL: https://api.cpaas.symphony.rakuten.net/cdr/v1/report/query/sms/transaction-history/mt

Methods: GET

HTTP Headers

Parameter	Required	Value
Authentication	Y	Type: Bearer Token: JWT Token
Accept	Y	application/json
Content-Type	Y	application/json; charset=UTF-8

Request Body Schema: application/json

Parameter	Required	Description/Values
date-from	Yes	Start date and time in format:`YYYY-MM-DD HH:MM:SS`
date-to	Yes	End date and time in format:`YYYY-MM-DD HH:MM:SS`
page-size	No	Number of records to return per page (recommended: 25-100 records)
page	No	Page number for pagination (Min: 1 and Max: 1000)
api-key	No	Filter by specific API key
network	No	Filter by network code
client-reference	No	Filter by client reference
da	No	Filter by Destination Address
oa	No	Filter by Sender ID
status	No	Filter by message status e.g.,`DELIVRD`, `REJECTD` etc. Refer to the Status Values section
tz	No	View data in UTC or JST by passing values =`UTC` or `JST`
sort-order	No	Sort order for results. Values:`<ul><li>`asc `</li><li>`desc `</li></ul>`

Sample Request

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>'

Response:

If successful, the API call will return an HTTP 200 OK with a JSON document as a paginated response with HATEOAS links for navigation. Please see section "Error Codes" for a description of the failure responses.

Parameter	Description
page_size	Number of records per page
page	Current page number
_links	HATEOAS navigation links
_links.self	Link to current page
_links.next	Link to next page
_links.first	Link to first page
_links.last	Link to last page
_embedded	Container for response data
_embedded.total_found	Total number of records found
_embedded.cdrs	Array of CDR (Call Detail Record) objects
message_body	The message that was sent in the SMS and this is shown only if it has been explicitly requested for
msg_encrypted	Indicates if message is encrypted (`true` or `false`)
unencrypted_message_body	If `msg_encrypted` = `true`, then this will display the unencrypted message
_links.self	Link to individual CDR detail
type	Message type (e.g.,`MT` for Mobile Terminated)
trx_id	Unique transaction identifier
date_received	Timestamp when message was received (ISO 8601 format)
date_submitted_to_mno	Timestamp when message was submitted to mobile network operator
api_key	API key used for the transaction
api_key_name	Name of the API key
enterprise_id	Enterprise identifier
entity_id	Entity identifier
submitted_by_user_id	User ID who submitted the message
submitted_by_user_name	Name of user who submitted the message
submitted_by_user_email	Email of user who submitted the message
submitted_by_admin_user_id	Admin user ID (if applicable)
executed_by	Full details of who executed the message
bulk_campaign_id	Campaign ID (if sent via campaign)
ref	Client reference
from_address	Sender ID or originating address
to_address	Recipient phone number
network_code	Mobile network operator code
network_name	Mobile network operator name
message_length	Length of the message in characters
delivery_status	Delivery status (e.g., DELIVRD for delivered)
date_delivered	Timestamp when message was delivered
dlr_error_code	Delivery receipt error code
dlr_reason	Delivery receipt reason description
delivery_method	Method used to send message (e.g., Dashboard, Campaign, API)
price	Cost of the message
price_currency	Currency of the price
dcs	Data Coding Scheme
how_many_message_parts	Number of message parts (for concatenated messages)

Sample Response

{
    "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
            }
        ]
    }
}

Pagination

The API uses cursor-based pagination with HATEOAS links:

Use_links.next.href to retrieve the next page
Use_links.first.href to return to the first page
Use_links.last.href to jump to the last page
Thetotal_found field indicates the total number of records available

Notes

All timestamps are returned in ISO 8601 format (YYYY-MM-DD HH:MM:SS) with UTC timezone offset
Empty string values indicate that the field was not applicable or not provided for that transaction
The_links.self object within each CDR provides a direct link to retrieve detailed information about that specific transaction
Max Date Range: Limit your date range to improve query performance. Maximum range is 31 days.
Rate Limiting: The number of simultaneous API calls per user or IP is limited to 1
Requests per Minute/Hour/Day: To prevent abuse and ensure fair usage, the following limits are applied

Duration	Limit
Minute	3
Hour	10
Day	100

Page Size: Use appropriate page sizes (recommended: 25-100 records) to balance between API calls and response size.
Page: Page number for pagination (Min: 1 and Max: 1000)
Filtering: Apply filters likeenterprise-id,api-key, ornetwork to narrow down results and improve performance.

Description​

Description