Referência da APIInbox
Detalha uma conversa
Retorna os dados de uma unica conversa (resumo do contato, status, atribuicao, contagem de nao-lidas e resumo da ultima mensagem), igual ao item devolvido por listInboxConversations. Use para recarregar o cabecalho de uma conversa ja conhecida pelo id. A conversa e resolvida no escopo do projeto (tenant): um id de outro projeto retorna 404. Para o corpo das mensagens, use GET /v1/inbox/conversations/{id}/messages.
Authorization
bearerAuth AuthorizationBearer <token>
API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...
In: header
Path Parameters
id*string
Identificador da conversa.
Response Body
application/json
application/json
application/json
application/json
curl -X GET "https://example.com/v1/inbox/conversations/string"{
"id": "conv_01HV9Z3K8QABCDEF",
"instanceId": "inst_01HV9Z3K8Q1234567",
"protocol": "2026-000123",
"contactId": "ct_01HV9Z3K8QXYZ",
"contactName": "Maria Silva",
"contactPhone": "5511999990000",
"contactJid": "5511999990000@s.whatsapp.net",
"status": "open",
"assignedUserId": null,
"unread": 2,
"lastMessageAt": "2026-06-06T13:45:12Z",
"lastMessageText": "Bom dia, ainda esta disponivel?"
}{
"error": {
"code": "UNAUTHORIZED",
"message": "API key ausente ou invalida"
}
}{
"error": {
"code": "FORBIDDEN",
"message": "Projeto inativo ou sem permissao"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Instancia nao encontrada"
}
}