انتقل إلى المحتوى
المطورون

الـ Endpoints

Conversations

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

المسارات نسبية للـ base URL. كل كارت بيوضّح الصلاحية اللي الاستدعاء محتاجها وكل parameter، مع نوعه وحدوده.

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.

الـ body بصيغة 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.

الـ body بصيغة 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.

الـ body بصيغة 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.

الـ body بصيغة JSON

  • bodyمطلوبstring

    1–5,000 characters.

  • mentionsاختياريarray of strings

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