İçeriğe geç
Geliştiriciler

Endpoint'ler

Conversations

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

Yollar temel URL'ye göredir. Her kart, çağrının gerektirdiği izni ve her parametreyi türü ve sınırlarıyla listeler.

GET
/conversations

List conversations, most recently updated first.

İzin: inbox
Eski yanıt biçimi

Sorgu parametreleri

  • limitisteğe bağlıinteger

    1–100, default 20.

  • offsetisteğe bağlı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 }.

İzin: inbox
Eski yanıt biçimi

Yol parametreleri

  • idzorunluinteger

    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.

İzin: inbox
Eski yanıt biçimi

Yol parametreleri

  • idzorunluinteger

    Conversation ID.

Sorgu parametreleri

  • sinceisteğe bağlı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.

İzin: inbox

Yol parametreleri

  • idzorunluinteger

    Conversation ID.

JSON gövdesi

  • statuszorunluenum

    New status.

    İzin verilen değerler:openclosed

  • closing_note_idisteğe bağlıinteger | null

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

  • closing_note_textisteğe bağlıstring | null

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

  • allow_reopenisteğe bağlı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.

İzin: inbox

Yol parametreleri

  • idzorunluinteger

    Conversation ID.

JSON gövdesi

  • user_idisteğe bağlıstring | null

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

POST
/conversations/:id/ai/pause

Stop AI replies on a conversation.

İzin: inbox

Yol parametreleri

  • idzorunluinteger

    Conversation ID.

JSON gövdesi

  • untilisteğe bağlıstring (ISO 8601 date-time with offset) | null

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

  • reasonisteğe bağlıstring

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

POST
/conversations/:id/ai/resume

Turn AI replies back on.

İzin: inbox

Yol parametreleri

  • idzorunluinteger

    Conversation ID.

POST
/conversations/:id/handover/resolve

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

İzin: inbox

Yol parametreleri

  • idzorunluinteger

    Conversation ID.

GET
/conversations/:id/comments

List internal team comments on a conversation, newest first.

İzin: inbox
Sayfalı

Yol parametreleri

  • idzorunluinteger

    Conversation ID.

POST
/conversations/:id/comments

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

İzin: inbox

Yol parametreleri

  • idzorunluinteger

    Conversation ID.

JSON gövdesi

  • bodyzorunlustring

    1–5,000 characters.

  • mentionsisteğe bağlıarray of strings

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