Pular para o conteúdo

GET /v1/contacts/{id}/activity

GET
/v1/contacts/{id}/activity
curl --request GET \
--url https://seu-endereco-da-api/v1/contacts/example/activity \
--header 'Authorization: Bearer <token>'

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

id
required
string
Media typeapplication/json
object
summary
required
object
conversationsCount
required
number
messagesCount
required
number
firstContactAt
required
string
nullable
lastContactAt
required
string
nullable
ticketsResolved
required
number
avgCsat
required
number
nullable
conversations
required
Array<object>
object
id
required
string
channelId
required
string
channel
required
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
status
required
string
departmentName
required
string
nullable
assigneeName
required
string
nullable
lastMessageAt
required
string
nullable
lastMessagePreview
required
string
nullable
unreadCount
required
number
flows
required
Array<object>
object
id
required

Id da execução, o mesmo de GET /v1/flows/:flowId/runs/:runId

string
flowId
required
string
flowName
required
string
status
required
string
result
required
string
Allowed values: concluida presa falhou em_andamento
createdAt
required
string format: date-time
conversationId
required
string
nullable
agents
required
Array<object>
object
id
required
string
agentId
required
string
agentName
required

Null when the AI was removed

string
nullable
status
required

Running, waiting_reply, handed_off, completed, stopped, failed, budget_exceeded or passed_to_ai (handed to another AI)

string
createdAt
required
string format: date-time
conversationId
required
string
passedFrom
required

AI that passed the conversation to this one

object
agentId
required
string
agentName
required

Null when the AI was removed

string
nullable
operators
required
Array<object>
object
userId
required
string
name
required
string
avatarUrl
required

Public url for the user’s photo

string
nullable
ticketsCount
required
number
messagesCount
required
number
lastAt
required
string
nullable
tickets
required
Array<object>
object
id
required
string
openedAt
required
string format: date-time
resolvedAt
required
string
nullable
resolutionMs
required
number
nullable
assigneeName
required
string
nullable
departmentName
required
string
nullable
closingReasonName
required
string
nullable
csatRating
required
number
nullable
csatComment
required
string
nullable
channels
required
Array<object>
object
channelId
required
string
channel
required
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
messagesCount
required

How many messages this contact exchanged through this channel

number
lastMessageAt
required
string
nullable

Example

{
"flows": [
{
"result": "concluida"
}
]
}