Pular para o conteúdo

GET /v1/conversations/counts

GET
/v1/conversations/counts
curl --request GET \
--url 'https://seu-endereco-da-api/v1/conversations/counts?status=pending&unread=1&kind=person&windowState=open&window=expiring&priorities=today&aiGoal=active&order=newest' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Ler conversas (conversations:read).

conversationId
string format: uuid
status
string
Allowed values: pending open snoozed resolved
contactId
string format: uuid
departmentId
string format: uuid
assignee
string
channelId
string format: uuid
unread
string
Allowed values: 1 true
adSourceId
string
<= 200 characters
tagId
string format: uuid
originId
string format: uuid
kind
string
Allowed values: person group
windowState
string
Allowed values: open closed
lastMessageFrom
string
lastMessageTo
string
window
string
Allowed values: expiring
priorities
string
Allowed values: today
aiGoal
string
Allowed values: active conducting paused completed returned
badge
Array<string>
q
string
<= 200 characters
order
string
Allowed values: newest oldest
cursor
string
limit
string
Media typeapplication/json
object
pending
required
number
mine
required
number
unassigned
required
number
snoozed
required

Conversations the actor snoozed, the tab that holds them until someone resumes

number
resolved
required

Encerradas, contadas ate 1000 (a partir dai o front mostra 1000+)

number
unread
required
number
withAi
required

Conversations the AI is conducting or has paused, within what the caller sees

number
openAssigned
required

Open conversations assigned to the actor, unscoped, the number the ceiling enforces

number
maxOpen
required

The actor ceiling of simultaneous open conversations, null when unlimited

number
nullable
snapshot
required

A foto do banco em que a resposta foi lida: um evento ja esta contido nela quando seu txid e menor que xmin, ou menor que xmax e fora de xip

object
xmin
required

Toda transacao abaixo deste numero ja esta na leitura

number
xmax
required

Nenhuma transacao deste numero em diante esta na leitura

number
xip
required

Transacoes entre xmin e xmax que ainda estavam abertas e por isso ficaram fora

Array<number>

Example generated

{
"pending": 1,
"mine": 1,
"unassigned": 1,
"snoozed": 1,
"resolved": 1,
"unread": 1,
"withAi": 1,
"openAssigned": 1,
"maxOpen": 1,
"snapshot": {
"xmin": 1,
"xmax": 1,
"xip": [
1
]
}
}