Saltar al contenido principal
GET
Returns the conversations of a WhatsApp channel that started between two dates, newest first, one page at a time. They are the same conversations as Reports → Sessions in the app. A thread is the whole chat with a contact on a channel and never ends. A conversation is one stretch of that thread: it opens with new activity and closes after a period without messages, so one thread has many conversations. To read the messages of a conversation, call List Thread Messages with its thread_id and session_id set to its id.
Only WhatsApp (WABA) channels have conversations. For any other channel the list is empty.

Headers

string
requerido
Your API key for authentication. An organization key lists every conversation of the channel. A personal key needs the messages.read permission and the channel inside its role’s channels; it lists only the conversations of threads its user can see in the inbox.

Query Parameters

string
requerido
ID of the WhatsApp channel, from List Channels.
string
requerido
First day of the range, YYYY-MM-DD. A conversation is in the range when it started in it.
string
requerido
Last day of the range, included, YYYY-MM-DD. It cannot be before start_date.
string
predeterminado:"UTC"
IANA time zone the two days are read in, e.g. America/Bogota. An unknown zone is read as UTC.
number
predeterminado:"50"
Conversations per page, from 1 to 100.
number
predeterminado:"0"
Number of conversations to skip, up to 10000.

Response

array
Conversations of the page, newest first.
object
The conversation does not carry who it was assigned to: read the thread’s assignee with Get Thread, or the sender_id of each message.

Error Codes

  • 400 Bad Request — A parameter is missing or invalid, or end_date is before start_date
  • 401 Unauthorized — Invalid or missing API key
  • 403 Forbidden — The personal key lacks messages.read, or the channel is not among its role’s channels
  • 429 Too Many Requests — Rate limit exceeded, see Rate limits
  • 500 Internal Server Error — Server-side error

Code Examples