Перейти к основному содержанию

Что это такое

YCloud использует коды состояния HTTP и структурированное тело ошибки, чтобы ваше приложение могло решить, исправить ли запрос, отклонить его или повторить.

Ответ

Неудачный запрос возвращает объект error.

Поля ошибки

Коды ошибок

Используйте error.code для различения ошибок с одинаковым HTTP-статусом. В этом справочнике перечислены коды ошибок YCloud API; отдельная конечная точка может документировать дополнительные ошибки. Квоты для аккаунтов и отправителей приведены в разделе Ограничения частоты запросов. Ошибки Meta также могут отображаться в error.whatsappApiError после того, как запрос достигает WhatsApp. Сохраняйте эти подробности вместе с кодом ошибки YCloud.

Как обрабатывать ответ

Корреляция запросов

Логируйте эндпоинт, HTTP-метод, статус ответа, YCloud requestId и собственный идентификатор корреляции. Удаляйте ключи API и персональные данные. Это предоставит вам достаточно информации для расследования сбоя без раскрытия конфиденциальных данных.

Безопасный повтор запросов

Повторяйте запросы только для чтения, если сбой носит временный характер. Соблюдайте осторожность при отправке сообщений и других операциях создания. Повторный POST может создать второй ресурс или отправить дублирующее сообщение. Если это поддерживается схемой запроса, задайте для externalId уникальное значение из вашей системы. Сохраняйте идентификатор ответа YCloud после успешного запроса.
Если у вас есть персональный менеджер (business manager), свяжитесь с ним. В противном случае отправьте заявку через YCloud Ticket Service. Укажите requestId, эндпоинт, HTTP-статус и время возникновения сбоя. Удалите ключи API и персональные данные перед передачей этих сведений.

Чек-лист по реализации

  • Выполняйте парсинг ошибок по code, а не путем сопоставления текста message.
  • Устанавливайте таймауты для каждого исходящего запроса.
  • Повторяйте попытки только при временных сбоях.
  • Добавьте экспоненциальную задержку, джиттер и максимальное количество попыток.
  • Предотвращайте дублирование эффектов POST с помощью собственного стабильного идентификатора, когда запрос это поддерживает.