ZOzoho
SMS

Get SMS logs

Returns the agent's SMS logs, newest first, with pagination and filtering by delivery attributes (status, recipient, sender name) and request attributes (client reference, template, request id, date range).

get/sms/logs

Request

  • Base URL
    https://cpaas.zoho.com/v1.1
  • Auth
    API key in header Authorization

Query parameters

offsetinteger

Zero-based offset for pagination.

limitinteger

Maximum number of log entries to return.

statusstring
Example:delivered

Filter by message status. Common values: delivered, sent, not-sent, undelivered, failed, processed, process_failed, spam. Detailed telecom/DLT failure codes (e.g. dnd-number, inv-number, tl-nt-found) are also accepted.

recipientstring

Filter by recipient mobile number (with country code).

sender_namestring

Filter by sender name.

client_referencestring

Filter by the client reference supplied at send time.

template_keystring

Filter by SMS template key.

request_idstring

Filter by the request id returned by the send API.

date_fromstring date-time
Example:2026-09-22T00:00:00+05:30

Start of the date range - an ISO 8601 date-time with UTC offset.

date_tostring date-time
Example:2026-09-22T23:59:59+05:30

End of the date range - an ISO 8601 date-time with UTC offset.

Response

SMS logs retrieved successfully.

statusstring

Example response

{
  "metadata": {
    "count": 10
  },
  "data": [
    {
      "status": "delivered",
      "process_state": "processed",
      "remote_ip": "10.61.232.23",
      "chunks": "1"
    }
  ],
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.