Sign in
Chats

List replica's chats

List of replica's chats with pagination and sorting. Chats are groups of user+replica+platform conversations.

get/v1/replicas/{replicaUUID}/chats

Request

  • Base URL: https://api.sensay.io
  • URL: https://api.sensay.io/v1/replicas/{replicaUUID}/chats
  • Auth: one of:
    • API key in header X-ORGANIZATION-SECRET and API key in header X-USER-ID and API key in header X-USER-ID-TYPE
    • API key in header X-ORGANIZATION-SECRET

Path parameters

replicaUUIDstring uuid required

The replica unique identifier (UUID)

Example:03db5651-cb61-4bdf-9ef0-89561f7c9c53

Query parameters

pageSizeinteger nullable

The number of items per page.

Example:24
pagenumber

The page number.

Example:1
sortBy'replicaReplies' | 'firstMessageAt' | 'lastReplicaReplyAt'

Sort criteria.

Example:replicaReplies
sortOrder'asc' | 'desc'

The order of the sort.

Example:desc

Headers

X-API-Versionstring
Example:2025-03-25

Response

List of chats

successboolean
totalnumber required

The total number of chats for this replica.

Example response

{
  "items": [
    {
      "uuid": "8e9309af-baa4-4a85-8c59-c3a2a0c2ad0f",
      "source": "telegram",
      "messageCount": 42,
      "replicaReplyCount": 21,
      "firstMessageAt": "2025-05-27T15:02:44.499744+00:00",
      "lastMessageAt": "2025-05-27T18:45:12.123456+00:00",
      "lastReplicaReplyAt": "2025-05-27T18:30:22.654321+00:00",
      "chatName": "John Doe",
      "chatImageURL": "https://example.com/image.png",
      "chatType": "individual"
    }
  ],
  "total": 1001
}

Changes

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