v51

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-014102371.0 MB

Webchat

Get a list of webchat messages.

Retrieves a paginated list of webchat messages for the authenticated customer.

get/webchat_messages

Query parameters

page_sizeinteger

Example:25

Number of results to return per page.

page_tokenstring

Cursor token for pagination. Use the next_page_token value from the previous response.

session_idstring uuid

Filter messages to those belonging to this session. Returned from the POST /webchat_sessions or GET /webchat_sessions response.

Response

A list of webchat messages.

next_page_tokenstring

Cursor token for the next page of results. Pass this value as the page_token parameter in the next request.

Example response

{
  "result": [
    {
      "id": "5e9c2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "customer_id": "7c4d2f3a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "widget_id": "550e8400-e29b-41d4-a716-446655440000",
      "session_id": "7a1bcb1a-1b8e-4f5c-9a6d-3e2f1a0b4c5d",
      "direction": "inbound",
      "status": "sent",
      "sender_id": "d4e5f6a7-b8c9-0d1e-2f3a-4b5c6d7e8f90",
      "text": "Hi, I have a question about pricing",
      "tm_create": "2026-01-15T09:30:00.000000Z",
      "tm_delete": "2026-01-15T09:30:00.000000Z"
    }
  ]
}