Pular para o conteúdo

GET /v1/monitoring/board

GET
/v1/monitoring/board
curl --request GET \
--url 'https://seu-endereco-da-api/v1/monitoring/board?riskKind=queue&kind=person&windowState=open' \
--header 'Authorization: Bearer <token>'

Permissão que a Chave de acesso precisa: Monitoramento (monitoring:read).

perColumn
number
>= 1 <= 100
assigneeId
string format: uuid
unassigned
boolean
riskKind
string
Allowed values: queue offline idle window resolution
departmentId
string format: uuid
channelId
string format: uuid
tagId
string format: uuid
adSourceId
string
<= 200 characters
originId
string format: uuid
kind
string
Allowed values: person group
windowState
string
Allowed values: open closed
Media typeapplication/json
object
columns
required
Array<object>
object
assigneeId
required

Null is the unassigned queue

string
nullable
total
required

Every open conversation in the column, not only the ones returned

number
items
required

The most urgent ones first

Array<object>
object
id
required
string
ticketId
required
string
nullable
status
required
string
contactName
required
string
nullable
contactPhoneNumber
required
string
nullable
contactProfilePicUrl
required
string
nullable
channelId
required
string
channel
required

O canal pelo qual a conversa chegou, com o estado da conexao dele

object
name
required

O nome que o cliente deu ao canal na plataforma

string
provider
required
string
status
required
string
coexistence
required
boolean
phoneNumber
required

O numero ou @ da conta no provedor

string
nullable
accountName
required

O nome da conta no provedor: o verificado da Meta, ou o do aparelho no canal lite

string
nullable
removed
required

O canal foi apagado; a conversa continua descrevendo por onde ela aconteceu

boolean
departmentId
required
string
nullable
departmentName
required
string
nullable
assigneeId
required
string
nullable
assigneeName
required
string
nullable
lastMessageAt
required
string format: date-time
nullable
lastMessagePreview
required
string
nullable
unreadCount
required
number
lastDirection
required
string
nullable
waitingSince
required
string format: date-time
nullable
windowExpiresAt
required
string format: date-time
nullable
resolvedAt
required
string format: date-time
nullable
riskKind
required
string
nullable
Allowed values: queue offline idle window resolution
riskOverSec
required
number
nullable
assigneeOverflow
required
string
nullable
waitStartedAt

When the customer’s wait started: queue arrival while unassigned, last unanswered inbound while assigned

string format: date-time
nullable
waitOverTarget

The wait is past the target, whatever riskKind was chosen

boolean
windowClosing

The 24h window closes within the warning period, whatever riskKind was chosen

boolean
nextCursor
required

Cursor for GET /monitoring/conversations (with assigneeId, or unassigned for the queue) to see more of this column

string
nullable
counts
required
object
queue
required
number
waitingCustomer
required
number
answered
required
number
overTarget
required
number
windowClosing
required
number

Example

{
"columns": [
{
"items": [
{
"riskKind": "queue"
}
]
}
]
}