Get WhatsApp logs

Returns the agent's WhatsApp message logs, newest first, with pagination and filtering by delivery attributes (status, recipient, sender number) and request attributes (client reference, template, request id, date range). Requires an API token with the WhatsApp scope. Rate limited to 40 requests per minute.

get/whatsapp/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

Returns the WhatsApp message logs based on the provided message status. Common values: delivered, read, sent, undelivered, failed, processed, process_failed.

recipientstring

Returns the WhatsApp message logs based on the provided recipient phone number (with country code).

client_referencestring

Returns the WhatsApp message logs based on the provided client reference supplied at send time.

template_keystring

Returns the WhatsApp message logs based on the provided WhatsApp template key.

request_idstring

Returns the WhatsApp message logs based on the provided request id returned by the send WhatsApp message API.

date_fromstring date-time

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

date_tostring date-time

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

Response

WhatsApp logs retrieved successfully.

statusstring

Example response

{
  "metadata": {
    "count": 10
  },
  "data": [
    {
      "from": "+14155550142",
      "to": "+919876543210",
      "status": "delivered",
      "process_state": "processed",
      "remote_ip": "10.61.232.23"
    }
  ],
  "status": "success"
}

Changes

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