Fundamentos

Respostas e erros

O formato das respostas e o significado de cada código.

Resposta de sucesso

json

{
  "data": { "id": "cmf3k9x1a0001", "status": "OPEN" },
  "meta": { "timestamp": "2026-10-05T14:32:10.000Z" }
}

Resposta de erro

json

{
  "statusCode": 404,
  "message": "Conversa não encontrada",
  "error": "NotFoundException",
  "timestamp": "2026-10-05T14:32:10.000Z",
  "path": "/api/v1/public/conversations/abc"
}

Em erros de validação, message pode ser uma lista de textos.

Código	Significado
200 / 201	Deu certo.
400	Algum campo está ausente ou inválido. A mensagem diz qual.
401	Chave ausente, errada, vencida ou revogada.
402	Assinatura da empresa vencida: só leitura até renovar.
403	A chave não tem a permissão necessária (por exemplo, write).
404	Não existe, ou a chave não tem acesso a esse item.
409	Conflito: contato pediu para não receber mensagens, tag já existe, janela de 24 h fechada…
429	Limite de chamadas excedido. Aguarde e tente de novo.
5xx	Falha do nosso lado. Tente novamente em alguns instantes.

AnteriorAutenticação PróximaPaginação