Перейти к содержимому
Разработчикам

Endpoints

Conversations

Open, close, assign and hand over conversations, pause the AI, and leave team comments.

Пути указаны относительно базового URL. В каждой карточке указано, какое разрешение нужно для вызова, и перечислены все параметры с типами и ограничениями.

GET
/conversations

List conversations, most recently updated first.

Разрешение: inbox
Старый формат ответа

Параметры запроса

  • limitнеобязательноinteger

    1–100, default 20.

  • offsetнеобязательноinteger

    Number of conversations to skip, default 0.

  • Returns a plain JSON array (offset pagination, not the list envelope).
GET
/conversations/:id

Retrieve a conversation with its messages, as { conversation, messages }.

Разрешение: inbox
Старый формат ответа

Параметры пути

  • idобязательноinteger

    Conversation ID.

GET
/conversations/:id/messages

Poll the AI replies of an API-channel conversation. Returns { conversationId, messages, cursor } with assistant messages newer than since.

Разрешение: inbox
Старый формат ответа

Параметры пути

  • idобязательноinteger

    Conversation ID.

Параметры запроса

  • sinceнеобязательноinteger

    Return only messages with a larger ID (pass the previous cursor). Default 0.

  • For every message of any conversation, use GET /messages?conversation_id= instead.
PUT
/conversations/:id/status

Open or close a conversation, with an optional closing note.

Разрешение: inbox

Параметры пути

  • idобязательноinteger

    Conversation ID.

Тело JSON

  • statusобязательноenum

    New status.

    Допустимые значения:openclosed

  • closing_note_idнеобязательноinteger | null

    A closing note from GET /closing-notes. Only when closing.

  • closing_note_textнеобязательноstring | null

    Free-text closing note, up to 2,000 characters. Only when closing.

  • allow_reopenнеобязательноboolean

    When closing: whether a new customer message reopens this conversation (true) or starts a new one (false).

PUT
/conversations/:id/assignee

Assign the conversation to a team member, or unassign it.

Разрешение: inbox

Параметры пути

  • idобязательноinteger

    Conversation ID.

Тело JSON

  • user_idнеобязательноstring | null

    A user from GET /users. Omit or send null to unassign.

POST
/conversations/:id/ai/pause

Stop AI replies on a conversation.

Разрешение: inbox

Параметры пути

  • idобязательноinteger

    Conversation ID.

Тело JSON

  • untilнеобязательноstring (ISO 8601 date-time with offset) | null

    Resume automatically at this time (must be in the future). Omit to pause until resumed.

  • reasonнеобязательноstring

    Up to 100 characters, passed to the conversation.ai_paused event.

POST
/conversations/:id/ai/resume

Turn AI replies back on.

Разрешение: inbox

Параметры пути

  • idобязательноinteger

    Conversation ID.

POST
/conversations/:id/handover/resolve

Mark the conversation's open handover requests as handled. Returns resolved_count.

Разрешение: inbox

Параметры пути

  • idобязательноinteger

    Conversation ID.

GET
/conversations/:id/comments

List internal team comments on a conversation, newest first.

Разрешение: inbox
Постраничный

Параметры пути

  • idобязательноinteger

    Conversation ID.

POST
/conversations/:id/comments

Add an internal team comment. It is never sent to the customer.

Разрешение: inbox

Параметры пути

  • idобязательноinteger

    Conversation ID.

Тело JSON

  • bodyобязательноstring

    1–5,000 characters.

  • mentionsнеобязательноarray of strings

    Up to 20 user IDs from GET /users to notify.