Μετάβαση στο περιεχόμενο
Προγραμματιστές

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
Παλαιά μορφή απόκρισης

Παράμετροι query

  • 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.

Παράμετροι query

  • 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.