Agent/Get Conversations
GET /v1/agent/conversations

Get Conversations

Base URL https://api.{cluster}.{platform}.voiger.io
Request · cURL
curl https://api.{cluster}.{platform}.voiger.io/v1/agent/conversations?_limit=&_skip= \
  -H "Cookie: sid=$VOIGER_SESSION" \
  -H "x-workspace-code: your-workspace-code"

Parameters

x-workspace-code string required in header
_limit number optional in query
_skip number optional in query
_search string optional in query

Response

conversations▾
array
id
string
status
string
state
string
tags▾
array The conversation's own tags. The full current set: the resolve dialog opens pre-filled from it, resolving by hand replaces it, and a wrap-up resolution adds to it. The client resolves names and colours for `tag_id` against its replicated tag store. An object per tag rather than a bare id list, the same as a call's `tags`, because who put it there and when are real.
tag_id
string
actor
any
created_at
string
channels▾
object Every medium this conversation has used, as a map keyed by channel -- not just the one its latest activity rode. Maintained as the activities are written, so a client can filter and badge a thread without reading its timeline. A map rather than a list because each value is a channel's own object, empty today and room for detail later. Empty for a thread that has only routing events.
voice
object
whatsapp
object
sms
object
unread_count
integer How much on this thread is waiting on the requesting agent. Per agent, and maintained server-side rather than counted per request: raised by an inbound activity (a message or a call) and by being assigned the conversation, reset to zero by PUT /v1/agent/conversations/{id}/read. Our own outbound activity and routing events never raise it.
latest_activity
any
participants▾
array
id
string
type
string
reference_id
string
role
string | null
assigned_at
string | null
left_at
string | null
created_at
string
updated_at
string