Chats

Chats · 11 операцій

GETList chats/api/chatGETCount chats by state, channel or manager/api/chat/breakdownGETGet chat/api/chat/{id}GETList chat channels/api/chat/channelsGETGet chat messages/api/chat/{id}/messageGETSearch chat messages/api/chat/{id}/message/searchPOSTSend chat message/api/chat/{id}/messagePOSTStart chat/api/chat/startPATCHAssign chat/api/chat/{id}/assignPATCHMark chat as spam/api/chat/{id}/spamPATCHSet chat tag/api/chat/{id}/tag

GET

List chats

/api/chat

Messenger chats with students, teachers, customers and leads (Telegram, iMessage and other connected channels). awaitingReply=true keeps open chats whose last message came from the contact; assignment=UNASSIGNED keeps open chats nobody handles. chatTagIds keeps chats whose tag is any of these (GET /api/chat-tag). Paginated, no total: to count chats use GET /api/chat/breakdown.

list_chats

Параметри запиту · 25

limitnumberPage size, 30 by default1–100

beforeChatIdnumberCursor: last chat of the shown page (keyset, see buildChatKeysetFilter).мін. 1

beforeLastMessageAtstringlastMessageAt of the cursor chat, echoed as received (school wall time, no Z). Absent for a chat without messages.

searchstringSearches chat name and message texts; every word must match in either.довжина макс. 100

searchScopestringname leaves message texts out of search; the chats page lists message hits through /chat/message/search.Одне з: all nameза замовчуванням all

dialogStatusstringOnly chats whose dialog is in this stateОдне з: OPEN CLOSED

assignmentstringUNASSIGNED: open dialogs without an assignee; MINE: open dialogs assigned to me. Both imply an open dialog, so dialogStatus is not needed.Одне з: UNASSIGNED MINE

spambooleanSpam chats only; overrides dialogStatus and assignment, since every work tab excludes spam.

Показати ще 17

excludeSpambooleanAll chats except spam, whatever the dialog state

entityTypestringOnly chats linked to a card of this type, none for unlinked; applies on top of tab and search.Одне з: student teacher customer none

entityTypesstring[]Linked to a card of any of these types; joins entityType rather than replacing it.Одне з: student teacher customer none

assignedUserIdsnumber[]Chats whose responsible manager is one of these users, open or closed.

includeUnassignedbooleanAdds chats without a responsible manager; alone it keeps only those.

openedStartstringA dialog of the chat was opened from this school-local day on.

openedEndstringInclusive: the end of that school-local day.

closedStartstringA dialog of the chat was closed from this school-local day on.

closedEndstringInclusive: the end of that school-local day.

unreadbooleanChats with inbound messages the current user has not read.

onlyMinebooleanChats assigned to me, on top of tab, type and search; unlike assignment: 'MINE', any dialog state.

awaitingReplybooleanOpen chats whose last message came from the contact: they wait for our reply.

chatTagIdsnumber[]Only chats with any of these chat tags

messengerIdnumberOnly chats of this channelмін. 1

studentIdnumberмін. 1

teacherIdnumberмін. 1

customerIdnumberмін. 1

Відповідь · 200

application/json

statusCodenumberобовʼязковийприклад 200

messagestringобовʼязковий—

dataobject[]17 полів

chatIdnumberобовʼязковий—

channelobjectобовʼязковий4 поля

messengerIdnumberобовʼязковий—

nameOfMessengerstringобовʼязковий—

typeOfMessengerstringобовʼязковийОдне з: TELEGRAM_BOT INSTAGRAM FACEBOOK IMESSAGE

capabilitiesobjectобовʼязковийможе бути nullWhat the channel supports; null when its adapter is not registered, so the chat is read-only.

contactNamestringобовʼязковийможе бути nullContact name as given by the channel; read-only.

namestringобовʼязковийможе бути nullChat name set in the CRM; null falls back to the card name, then contactName.

avatarstringобовʼязковийможе бути null—

isGroupbooleanобовʼязковий—

assignedUserobjectобовʼязковийможе бути nullAssignee; null means the chat is in the unassigned queue.3 поля

idnumberобовʼязковий—

firstNamestringобовʼязковий—

lastNamestringобовʼязковийможе бути null—

participantsobject[]обовʼязковий5 полів

chatParticipantIdnumberобовʼязковий—

studentIdnumberобовʼязковийможе бути null—

teacherIdnumberобовʼязковийможе бути null—

customerIdnumberобовʼязковийможе бути null—

personobjectобовʼязковийможе бути nullCard name, null for an unlinked participant. Used when the channel gives no name (iMessage labels a direct chat with the phone number).3 поля

firstNamestringобовʼязковий—

lastNamestringобовʼязковийможе бути null—

middleNamestringобовʼязковийможе бути null—

lastMessageobjectобовʼязковийможе бути null7 полів

chatMessageIdnumberобовʼязковий—

directionstringобовʼязковийОдне з: INBOUND OUTBOUND

authorTypestringобовʼязковийОдне з: CONTACT USER SYSTEM

textstringобовʼязковийможе бути null—

attachmentTypesstring[]обовʼязковийLets the list show an attachment label without fetching attachments.Одне з: IMAGE VIDEO AUDIO DOCUMENT

isDeletedbooleanобовʼязковий—

sentAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

unreadCountnumberобовʼязковий—

lastMessageAtstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

isSpambooleanобовʼязковийSpam chats stay out of every work tab and open no dialog until the mark is removed.

spamMarkedAtstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

blockedByContactAtstringобовʼязковийможе бути nullThe channel stopped delivering to the contact; cleared by any sign of life from them.формат YYYY-MM-DDTHH:mm:ss

blockReasonstringобовʼязковийможе бути nullОдне з: CONTACT_BLOCKED ACCOUNT_DELETED

openDialogobjectобовʼязковийможе бути nullCurrent open dialog, or null; this, not the chat, tells whether it is in work now.14 полів

chatDialogIdnumberобовʼязковий—

chatIdnumberобовʼязковий—

statusstringобовʼязковийОдне з: OPEN CLOSED

openedAtstringобовʼязковийформат YYYY-MM-DDTHH:mm:ss

closedAtstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

openedBystringобовʼязковийWho opened the dialog; SYSTEM is our side without a user (channel echo).Одне з: CONTACT MANAGER SYSTEM

openedByUserobjectобовʼязковийможе бути nullOpening manager; set only for MANAGER.3 поля

idnumberобовʼязковий—

firstNamestringобовʼязковий—

lastNamestringобовʼязковийможе бути null—

closedByUserobjectобовʼязковийможе бути nullNull while open and when auto-closed after inactivity.3 поля

idnumberобовʼязковий—

firstNamestringобовʼязковий—

lastNamestringобовʼязковийможе бути null—

firstMessageIdnumberобовʼязковийможе бути null—

firstManagerMessageAtstringобовʼязковийможе бути nullFirst manager message in the dialog; it assigns the chat to that manager.формат YYYY-MM-DDTHH:mm:ss

firstContactMessageAtstringобовʼязковийможе бути nullFirst message from the contact (customer, student or teacher).формат YYYY-MM-DDTHH:mm:ss

lastMessageAtstringобовʼязковийможе бути nullформат YYYY-MM-DDTHH:mm:ss

notSpamAtstringобовʼязковийможе бути nullSet when a manager answered the first-contact spam suggestion with "not spam"; spam itself is on the chat.формат YYYY-MM-DDTHH:mm:ss

messageCountnumberобовʼязковий—

tagobjectобовʼязковийможе бути nullOne tag per chat, null — untagged; a chat with a restricted tag the role has no grant for is not returned at all.4 поля

chatTagIdnumberобовʼязковий—

nameOfTagstringобовʼязковий—

isRestrictedbooleanобовʼязковий—

isSilentbooleanобовʼязковий—

Помилки400401403429500

curl "https://your-school.rist.pro/api/chat" \
  -H "Authorization: Bearer $RIST_API_KEY"

const response = await fetch("https://your-school.rist.pro/api/chat", {
  headers: {
    Authorization: `Bearer ${process.env.RIST_API_KEY}`,
  },
});
const { data } = await response.json();

import os
import requests

response = requests.get(
    "https://your-school.rist.pro/api/chat",
    headers={"Authorization": f"Bearer {os.environ['RIST_API_KEY']}"},
)
response.raise_for_status()
data = response.json()["data"]

Приклад відповіді · 200

{
  "statusCode": 200,
  "message": "Operation completed successfully",
  "data": [
    {
      "chatId": 1,
      "channel": {
        "messengerId": 1,
        "nameOfMessenger": "string",
        "typeOfMessenger": "TELEGRAM_BOT",
        "capabilities": {}
      },
      "contactName": "string",
      "name": "string",
      "avatar": "string",
      "isGroup": false,
      "assignedUser": {
        "id": 1,
        "firstName": "string",
        "lastName": "string"
      },
      "participants": [
        {
          "chatParticipantId": 1,
          "studentId": 1,
          "teacherId": 1,
          "customerId": 1,
          "person": {
            "firstName": "string",
            "lastName": "string",
            "middleName": "string"
          }
        }
      ],
      "lastMessage": {
        "chatMessageId": 1,
        "direction": "INBOUND",
        "authorType": "CONTACT",
        "text": "string",
        "attachmentTypes": [
          "IMAGE"
        ],
        "isDeleted": false,
        "sentAt": "2026-11-09T14:30:00"
      },
      "unreadCount": 0,
      "lastMessageAt": "2026-11-09T14:30:00",
      "isSpam": false,
      "spamMarkedAt": "2026-11-09T14:30:00",
      "blockedByContactAt": "2026-11-09T14:30:00",
      "blockReason": "CONTACT_BLOCKED",
      "openDialog": {
        "chatDialogId": 1,
        "chatId": 1,
        "status": "OPEN",
        "openedAt": "2026-11-09T14:30:00",
        "closedAt": "2026-11-09T14:30:00",
        "openedBy": "CONTACT",
        "openedByUser": {
          "id": 1,
          "firstName": "string",
          "lastName": "string"
        },
        "closedByUser": {
          "id": 1,
          "firstName": "string",
          "lastName": "string"
        },
        "firstMessageId": 1,
        "firstManagerMessageAt": "2026-11-09T14:30:00",
        "firstContactMessageAt": "2026-11-09T14:30:00",
        "lastMessageAt": "2026-11-09T14:30:00",
        "notSpamAt": "2026-11-09T14:30:00",
        "messageCount": 0
      },
      "tag": {
        "chatTagId": 1,
        "nameOfTag": "string",
        "isRestricted": false,
        "isSilent": false
      }
    }
  ]
}

GET

Count chats by state, channel or manager

/api/chat/breakdown

How many chats match the GET /api/chat filters, per dialog state (OPEN, CLOSED, SPAM), channel or assigned manager (groupBy). messageStart/messageEnd (school days) keep chats with a message from the contact or staff in that period: "unique teacher chats today, open and closed" is entityType=teacher, groupBy=dialogStatus, both set to today. Chats with an isSilent tag never open a dialog, so they count as CLOSED. One call instead of paging through GET /api/chat.

count_chats