Skip to main content

Documentation Index

Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Conversations API

A single thread per contact-channel pair, regardless of which channel the message came in on. Conversations are how the inbox UI groups inbound messages, AI replies, and agent replies — and how you’d integrate the same lifecycle into your own UI. Base path: /v1/conversations Authentication: API key (X-API-Key) or session JWT.

​
Lifecycle

MethodPathPurpose
GET/v1/conversationsList all conversations
GET/v1/conversations/{id}Get a single conversation
GET/v1/conversations/{id}/messagesGet messages in a conversation
POST/v1/conversations/{id}/replyReply in the conversation’s channel
POST/v1/conversations/{id}/assignAssign to an agent or team
PUT/v1/conversations/{id}/tagsUpdate tags
POST/v1/conversations/{id}/closeClose (resolved)
POST/v1/conversations/{id}/snoozeSnooze until a future time
POST/v1/conversations/{id}/reopenReopen a closed/snoozed conversation
POST/v1/conversations/bulkBulk action across many conversation IDs

​
AI handoff & copilot

For AI-led conversations, Orbit provides explicit handoff mechanics so a human agent picks up exactly where the AI left off.
MethodPathPurpose
POST/v1/conversations/{id}/copilot/suggestSuggest the next reply + next-best actions
POST/v1/conversations/{id}/handoffHand off from AI to a human agent
POST/v1/conversations/{id}/handoff/resolveMark a handoff as resolved (closes the AI pause)

​
Example — reply on whatever channel the conversation is on

curl -X POST https://orbit-api.devotel.io/api/v1/conversations/conv_abc/reply \
  -H "X-API-Key: dv_live_sk_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{ "body": "Thanks — I just refunded that order." }'
The reply is sent over the same channel the conversation is on (SMS, WhatsApp, email, …). For WhatsApp specifically, the 24-hour customer-care window is enforced — if the contact hasn’t messaged you in 24 hours, the API will return a WHATSAPP_OUTSIDE_24H_WINDOW error and you’ll need to send an approved template via the Messaging API instead.

​
See also