Saltar para o conteúdo principal

O que é

A YCloud usa códigos de status HTTP e um corpo de erro estruturado para que sua aplicação possa decidir se deve corrigir, rejeitar ou tentar novamente uma solicitação.

Resposta

Uma solicitação com falha retorna um objeto error.

Campos de erro

Códigos de erro

Use error.code para distinguir falhas que compartilham um status HTTP. Este catálogo lista os códigos de erro da API da YCloud; um endpoint pode documentar erros adicionais. Para cotas de conta e remetente, consulte Limites de taxa. Erros da Meta também podem aparecer no error.whatsappApiError depois que a solicitação chega ao WhatsApp. Preserve esses detalhes juntamente com o código de erro da YCloud.

Como lidar com a resposta

Correlação de solicitações

Registre em log o endpoint, o método HTTP, o status da resposta, o requestId da YCloud e o seu próprio ID de correlação. Remova chaves de API e dados pessoais. Isso fornece evidências suficientes para investigar uma falha sem expor segredos.

Repetir com segurança

Tente novamente solicitações somente leitura quando a falha for temporária. Tenha cautela com envios de mensagens e outras operações de criação. Um POST repetido pode criar um segundo recurso ou enviar uma mensagem duplicada. Quando compatível com o esquema da solicitação, defina externalId com um valor exclusivo do seu sistema. Armazene o ID da resposta da YCloud após uma solicitação bem-sucedida.
Se você tiver um gerente de negócios, entre em contato com ele. Caso contrário, envie um chamado por meio do YCloud Ticket Service. Inclua o requestId, endpoint, status HTTP e horário da falha. Remova chaves de API e dados pessoais antes de compartilhar esses detalhes.

Lista de verificação de implementação

  • Analise erros por code, não por correspondência de texto de message.
  • Defina tempos limites (timeouts) em todas as solicitações de saída.
  • Tente novamente apenas falhas temporárias.
  • Adicione backoff exponencial, jitter e um número máximo de tentativas.
  • Evite efeitos duplicados de POST com o seu próprio identificador estável quando a solicitação oferecer suporte a um.