PEPINO ZAPdocs
Referência da APIInbox

Lista as mensagens de uma conversa

Ver como Markdown
GET
/v1/inbox/conversations/{id}/messages

Devolve as mensagens da conversa em ordem cronologica (mais antiga → mais nova), em PAGINAS. Por padrao traz as limit mais recentes. Para o historico completo (scrollback), pagine para tras com before: passe o nextBefore da resposta para buscar as mensagens ANTERIORES, repetindo ate hasMore=false. Mensagens de midia trazem uma mediaUrl PRE-ASSINADA gerada na leitura (validade ~6h); o binario fica no nosso storage por 2 ANOS (depois e removido — o texto permanece), entao basta reler para obter uma URL nova; se precisar da midia por mais tempo, baixe e armazene do seu lado.

Authorization

bearerAuth
AuthorizationBearer <token>

API key enviada como Authorization Bearer pzk_live_... ou pzk_test_...

In: header

Path Parameters

id*string

Identificador da conversa.

Query Parameters

limit?integer

Quantas mensagens trazer por pagina (padrao 50, max 200).

Default50
Rangevalue <= 200
before?string

Cursor de scrollback: id de uma mensagem. Devolve as mensagens ANTERIORES a ela. Use o nextBefore da resposta anterior. Vazio = pagina mais recente.

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/inbox/conversations/string/messages"
{
  "items": [
    {
      "id": "string",
      "direction": "INBOUND",
      "type": "string",
      "text": "string",
      "mediaUrl": "string",
      "mediaMime": "string",
      "status": "string",
      "waMessageId": "string",
      "quotedWaMessageId": "string",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "hasMore": true,
  "nextBefore": "string"
}
{
  "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"
  }
}