GET /v1/monitoring/conversations
GET
/v1/monitoring/conversations
const url = 'https://seu-endereco-da-api/v1/monitoring/conversations?tab=risco&riskKind=queue&kind=person&windowState=open';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url 'https://seu-endereco-da-api/v1/monitoring/conversations?tab=risco&riskKind=queue&kind=person&windowState=open' \ --header 'Authorization: Bearer <token>'Permissão que a Chave de acesso precisa: Monitoramento (monitoring:read).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Query Parameters
Seção intitulada “Query Parameters”tab
string
cursor
string
limit
number
assigneeId
string format: uuid
unassigned
boolean
riskKind
string
departmentId
string format: uuid
channelId
string format: uuid
tagId
string format: uuid
adSourceId
string
originId
string format: uuid
kind
string
windowState
string
Responses
Seção intitulada “Responses”Media typeapplication/json
object
items
required
Array<object>
object
id
required
string
ticketId
required
string
status
required
string
contactName
required
string
contactPhoneNumber
required
string
contactProfilePicUrl
required
string
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
accountName
required
O nome da conta no provedor: o verificado da Meta, ou o do aparelho no canal lite
string
removed
required
O canal foi apagado; a conversa continua descrevendo por onde ela aconteceu
boolean
departmentId
required
string
departmentName
required
string
assigneeId
required
string
assigneeName
required
string
lastMessageAt
required
string format: date-time
lastMessagePreview
required
string
unreadCount
required
number
lastDirection
required
string
waitingSince
required
string format: date-time
windowExpiresAt
required
string format: date-time
resolvedAt
required
string format: date-time
riskKind
required
string
riskOverSec
required
number
assigneeOverflow
required
string
waitStartedAt
When the customer’s wait started: queue arrival while unassigned, last unanswered inbound while assigned
string format: date-time
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
string
Example
{ "items": [ { "riskKind": "queue" } ]}