Referência da APIInbox
Lista as conversas (historico persistido)
Lista as conversas do projeto (uma por contato/numero), com resumo da ultima mensagem e contagem de nao-lidas. O historico e PERSISTIDO pela nossa infra e sobrevive a deletar/reconectar a instancia — voce nao precisa de banco proprio. Paginado (30 por pagina).
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Query Parameters
status?string
Filtra por status. Vazio = todas.
Value in
"" | "open" | "pending" | "resolved"page?integer
Numero da pagina (1-based; padrao 1). Cada pagina traz no maximo 30 conversas, ordenadas pela ultima mensagem (mais recentes primeiro). Valores menores que 1 sao tratados como 1. Os contadores em counts sao do projeto inteiro e nao mudam com a paginacao nem com o filtro de status.
Default
1Range
1 <= valueResponse Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/inbox/conversations"{
"items": [
{
"id": "string",
"instanceId": "string",
"protocol": "string",
"contactId": "string",
"contactName": "string",
"contactPhone": "string",
"contactJid": "string",
"status": "open",
"assignedUserId": "string",
"unread": 0,
"lastMessageAt": "2019-08-24T14:15:22Z",
"lastMessageText": "string"
}
],
"page": 0,
"counts": {
"all": 0,
"open": 0,
"pending": 0,
"resolved": 0
}
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}