List WhatsApp conversations

curl --request GET \
  --url https://api.dialtu.com/api/v2/public/whatsapp/conversations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dialtu.com/api/v2/public/whatsapp/conversations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialtu.com/api/v2/public/whatsapp/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "session_id": 123,
      "status": "<string>",
      "direction": "<string>",
      "customer_phone_number": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "client": {
        "id": 123,
        "name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "company": "<string>"
      },
      "disposition": {
        "id": 123,
        "name": "<string>"
      },
      "sentiment": "<string>",
      "summary": "",
      "message_count": 0,
      "has_more_messages": false,
      "last_message_at": "2023-11-07T05:31:56Z",
      "messages": [
        {
          "id": 123,
          "sender_type": "<string>",
          "sender": {
            "type": "<string>",
            "id": 123,
            "name": "<string>",
            "email": "<string>"
          },
          "message_type": "<string>",
          "content": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "media": {
            "kind": "<string>",
            "mime": "<string>",
            "filename": "<string>",
            "caption": "<string>"
          },
          "reply_to_id": 123
        }
      ],
      "assigned_users": [
        {
          "id": 123,
          "name": "<string>",
          "email": "<string>"
        }
      ],
      "participants": {
        "ai_agents": [
          {
            "id": 123,
            "name": "<string>",
            "message_count": 0,
            "first_message_at": "2023-11-07T05:31:56Z",
            "last_message_at": "2023-11-07T05:31:56Z"
          }
        ],
        "users": [
          {
            "id": 123,
            "name": "<string>",
            "email": "<string>",
            "message_count": 0,
            "first_message_at": "2023-11-07T05:31:56Z",
            "last_message_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    }
  ],
  "count": 123,
  "limit": 123,
  "offset": 123,
  "status": "success"
}

List WhatsApp conversations

List WhatsApp conversations (sessions) with their inline transcripts.

Results are a flat, paginated list of sessions ordered by sort_by. Each session carries a compact client object, its disposition, and (unless include_messages=false) its messages. Media messages expose metadata only (no file URLs). Sessions whose transcript exceeds max_messages_per_session are truncated with has_more_messages=true — fetch the rest from /conversations/{session_id}/messages.

Every message names its sender in sender (the AI agent, the team member, or the client). Each session also carries participants — everyone who replied in that conversation, split into ai_agents and users with per-participant message counts, covering the whole conversation even when the transcript is truncated or omitted.

Use updated_after together with sort_by=updated_at for incremental sync.

GET

api

public

conversations

List WhatsApp conversations

curl --request GET \
  --url https://api.dialtu.com/api/v2/public/whatsapp/conversations \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.dialtu.com/api/v2/public/whatsapp/conversations"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.dialtu.com/api/v2/public/whatsapp/conversations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "data": [
    {
      "session_id": 123,
      "status": "<string>",
      "direction": "<string>",
      "customer_phone_number": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "client": {
        "id": 123,
        "name": "<string>",
        "first_name": "<string>",
        "last_name": "<string>",
        "phone": "<string>",
        "email": "<string>",
        "company": "<string>"
      },
      "disposition": {
        "id": 123,
        "name": "<string>"
      },
      "sentiment": "<string>",
      "summary": "",
      "message_count": 0,
      "has_more_messages": false,
      "last_message_at": "2023-11-07T05:31:56Z",
      "messages": [
        {
          "id": 123,
          "sender_type": "<string>",
          "sender": {
            "type": "<string>",
            "id": 123,
            "name": "<string>",
            "email": "<string>"
          },
          "message_type": "<string>",
          "content": "<string>",
          "timestamp": "2023-11-07T05:31:56Z",
          "media": {
            "kind": "<string>",
            "mime": "<string>",
            "filename": "<string>",
            "caption": "<string>"
          },
          "reply_to_id": 123
        }
      ],
      "assigned_users": [
        {
          "id": 123,
          "name": "<string>",
          "email": "<string>"
        }
      ],
      "participants": {
        "ai_agents": [
          {
            "id": 123,
            "name": "<string>",
            "message_count": 0,
            "first_message_at": "2023-11-07T05:31:56Z",
            "last_message_at": "2023-11-07T05:31:56Z"
          }
        ],
        "users": [
          {
            "id": 123,
            "name": "<string>",
            "email": "<string>",
            "message_count": 0,
            "first_message_at": "2023-11-07T05:31:56Z",
            "last_message_at": "2023-11-07T05:31:56Z"
          }
        ]
      }
    }
  ],
  "count": 123,
  "limit": 123,
  "offset": 123,
  "status": "success"
}

Autorizaciones

Authorization

string

header

requerido

API key created in the dashboard under Settings → API Keys. Send it as Authorization: Bearer pk_....

Parámetros de consulta

created_after

string<date-time> | null

Only sessions created at/after this UTC timestamp.

created_before

string<date-time> | null

Only sessions created before this UTC timestamp.

updated_after

string<date-time> | null

Only sessions updated at/after this UTC timestamp. Use for incremental sync (pull only what changed since the last fetch).

client_id

integer | null

Only sessions belonging to this client.

string | null

Case-insensitive match against client first/last name and the customer phone number.

disposition_tag_ids

integer[] | null

Filter to sessions whose disposition tag is one of these IDs (OR).

include_uncategorized

boolean

predeterminado:false

When combined with disposition_tag_ids, also include sessions with no disposition tag.

status

string | null

Session status: new, ai_handling, human_handling, resolved, expired.

direction

string | null

Session direction: inbound or outbound.

sort_by

string

predeterminado:-created_at

Sort field, prefix with '-' for descending. One of: created_at, updated_at, last_message_at, client_name.

limit

integer

predeterminado:20

Max sessions per page (max 50).

Rango requerido: 1 <= x <= 50

offset

integer

predeterminado:0

Number of sessions to skip.

Rango requerido: x >= 0

include_messages

boolean

predeterminado:true

Include the inline transcript. Set false for a metadata-only browse.

max_messages_per_session

integer

predeterminado:500

Max messages embedded per session (oldest-first). Sessions with more set has_more_messages=true; fetch the rest from the messages endpoint.

Rango requerido: 1 <= x <= 2000

Respuesta

Paginated list of WhatsApp conversations.

data

PublicWhatsAppSessionSchema · object[]

requerido

Conversations on this page.

Show child attributes

count

integer

requerido

Total sessions matching the filters.

limit

integer

requerido

Page size that was applied.

offset

integer

requerido

Offset that was applied.

status

string

predeterminado:success

Always success.

Allowed value: "success"

Empezar

Guías

Endpoints

List WhatsApp conversations

Autorizaciones

Parámetros de consulta

Respuesta