---
title: "Get SMS message details"
method: GET
path: "/sms/logs/{message_id}"
tags: ["SMS"]
---

# Get SMS message details

`GET /sms/logs/{message_id}`

## Request

- Base URL: `https://cpaas.zoho.com/v1.1`
- URL: `https://cpaas.zoho.com/v1.1/sms/logs/{message_id}`
- Auth: API key in header `Authorization`

Returns the complete details of a single SMS message, including the rendered message text and the delivery event timeline.

## Response `200`

SMS message details retrieved successfully.

- SmsMessageDetailResponse: Response containing the details of a single SMS message.
  - `data` SmsMessageDetail: Full details of an SMS message: the log fields plus the template name, the rendered message text and the delivery event timeline.
    - `message_id` string, uuid: Unique identifier of the message.
    - `request_id` string: Identifier of the send request.
    - `client_reference` string: Client reference supplied at send time, if any.
    - `template_key` string, uuid: Key of the SMS template used.
    - `sender_key` string: Key of the sender the message went out as.
    - `sender_name` string: Name of the sender.
    - `agent_id` string: Identifier of the sending agent.
    - `to` string: Recipient mobile number.
    - `status` string: Message status (e.g. `delivered`, `sent`, `undelivered`, `failed`, `process_failed`, or a detailed telecom/DLT failure code).
    - `process_state` string: Processing state of the request.
    - `remote_ip` string: IP address the send request was made from.
    - `chunks` string: Number of SMS parts the message was split into.
    - `is_batch_request` boolean: Whether the message was part of a batch send.
    - `request_time` string: When the send request was received (ISO 8601).
    - `time_taken` integer: Processing time in milliseconds.
    - `error_message` AsyncFailureInfo: Why an accepted message failed asynchronously. Present only on failed messages (voice status `PROCESS_FAILED`, sms status `process_failed`).
      - `code` string: Failure code (e.g. voice `VOI_502`, sms `SMS_108`).
      - `message` string: Failure message.
    - `template_name` string: Name of the SMS template used.
    - `error_msg` string: The same failure information serialized as a JSON string.
    - `content` object: The message content that was sent.
      - `body_text` string: Rendered message text, with merge tags resolved.
    - `events` object[]: Chronological delivery events. Present once the message has entered delivery; absent for messages that failed processing (status `process_failed`). For undelivered messages the failure reason appears in `event_data`.
      - `event_name` string
      - `event_data` string
      - `event_time` string
  - `status` string

## Other responses

- `401`: Access Denied (`TM_4001`) - missing or invalid API token. Please check the authorization details and try again.
- `403`: Request Denied (`TM_3601`) - no message exists with the given message id.

---

[API](https://skmtc.dev/zoho/apis/zoho-cpaas.md) - [All operations](https://skmtc.dev/zoho/apis/zoho-cpaas/llms.txt) - [OpenAPI document](https://skmtc.dev/zoho/apis/zoho-cpaas/revisions/f0858a38e8b0?raw)