Skip to main content

​
Respostas síncronas e assíncronas

A EZ API mistura dois padrões de resposta:
  • Operações de configuração retornam 200 OK ou 201 Created imediatamente.
  • Envios de mensagens retornam 202 Accepted quando entram na fila com sucesso.

​
Códigos mais comuns

StatusSignificado
200 OKRequisição concluída com sucesso.
201 CreatedRecurso criado com sucesso, como instância ou grupo.
202 AcceptedA operação foi aceita e colocada na fila da instância.
400 Bad RequestAlgum parâmetro obrigatório não foi informado ou está inválido.
401 UnauthorizedClient-Token ou instanceToken inválido.
404 Not FoundInstância, QR Code ou recurso consultado não foi encontrado.
408 Request TimeoutO worker não respondeu dentro do tempo esperado.
409 ConflictEstado atual da instância impede a ação, como pedir pairing code em instância já conectada.
422 Unprocessable EntityO worker recebeu a ação, mas não conseguiu executá-la.
429 Too Many RequestsLimite de taxa excedido.
500 Internal Server ErrorFalha inesperada do serviço.

​
Formato de erro

A maior parte dos erros segue um destes formatos: 
{
  "error": "Unauthorized",
  "message": "Invalid instanceToken"
}

{
  "error": "Worker command timeout"
}

{
  "error": "Unable to process request"
}

​
Respostas padrão de sucesso

​
Operações booleanas

{
  "value": true
}

​
Ajustes de privacidade

{
  "success": true
}

​
Envio assíncrono de mensagem

{
  "messageId": "3EB047ED70306656281B34",
  "id": "3EB047ED70306656281B34"
}

​
Atualização de webhook

{
  "value": "https://example.com/webhooks/received"
}

​
Quando usar webhooks para diagnosticar

Para operações assíncronas, o 202 confirma apenas a entrada na fila. O resultado final pode ser acompanhado por:
  • webhook de entrega
  • webhook de status da mensagem
  • endpoint de erros de envio