Перейти к содержимому

Messenger API

Всё, что панель умеет с подключённым аккаунтом Instagram, WhatsApp или Telegram, — через REST: один ключ, один формат ответа, по разделам.

Ошибки и лимиты

Формат ошибки, каждый код ошибки с HTTP-статусом и как работают лимиты.

Формат ошибки

Ошибки всегда в этом формате. Ветвитесь по code, а не по тексту. details (необязательно) содержит ошибки валидации по полям.

{
  "success": false,
  "error": { "code": "DEVICE_OFFLINE", "message": "No available device is currently online.", "details": {} }
}

Коды ошибок

401INVALID_API_KEYAPI-ключ не указан или неверен.
401API_KEY_EXPIREDСрок действия этого API-ключа истёк.
401API_KEY_REVOKEDЭтот API-ключ отозван.
403INSUFFICIENT_SCOPEУ этого API-ключа нет нужного разрешения.
403ORGANIZATION_SUSPENDEDЭтот аккаунт приостановлен.
401INVALID_CREDENTIALSНеверный email или пароль.
403ACCOUNT_SUSPENDEDЭтот аккаунт приостановлен. Напишите в поддержку.
422TWO_FACTOR_CODE_INVALIDНеверный код.
422CHALLENGE_EXPIREDВремя этой попытки входа истекло. Начните заново.
422APPLE_NOT_LINKEDЭтот Apple ID ещё не привязан к аккаунту ChatVendor. Войдите один раз по e-mail, затем привяжите Apple ID в разделе «Безопасность».
401UNAUTHENTICATEDСессия не найдена или истекла. Войдите снова.
403FORBIDDENУ вас нет доступа к этому.
404NOT_FOUNDЗапрошенный объект не найден.
400REQUEST_FAILEDНе удалось выполнить запрос.
422VALIDATION_FAILEDВ запросе есть неверные параметры.
422INVALID_PHONE_NUMBERНе удалось распознать номер телефона получателя.
422MESSAGE_TOO_LONGТекст сообщения длиннее допустимого.
404MESSAGE_NOT_FOUNDСообщение не найдено.
404BATCH_NOT_FOUNDПакет не найден.
404DEVICE_NOT_FOUNDУстройство не найдено.
404WEBHOOK_NOT_FOUNDВебхук не найден.
409DEVICE_OFFLINEСейчас нет ни одного устройства в сети.
409DEVICE_DISABLEDВыбранное устройство отключено.
409SIM_UNAVAILABLEВыбранная SIM-карта недоступна.
409SMS_PERMISSION_MISSINGУстройство не дало разрешения на SMS.
422MESSAGE_NOT_CANCELLABLEЭто сообщение уже нельзя отменить.
429RATE_LIMIT_EXCEEDEDСлишком много запросов. Повторите после указанной паузы.
402ENTITLEMENT_EXCEEDEDЭто действие превышает лимиты вашего тарифа.
422IDEMPOTENCY_KEY_REUSEDЭтот ключ идемпотентности уже использован с другим запросом.
409IDEMPOTENT_REQUEST_IN_PROGRESSЗапрос с этим ключом идемпотентности ещё выполняется.
422INVALID_PAIRING_CODEНеверный код привязки.
422PAIRING_CODE_EXPIREDСрок действия кода привязки истёк.
500INTERNAL_ERRORПроизошла непредвиденная ошибка.
402PLAN_REQUIREDТекущий тариф не включает API мессенджеров.
404CHANNEL_NOT_FOUNDКанал не найден.
409CHANNEL_NOT_CONNECTEDКанал не подключён.
502CONNECTOR_ERRORКоннектор канала не ответил.
429FLOOD_WAITМессенджер попросил отправлять реже. Повторите после указанной паузы.
422CHANNEL_REQUEST_FAILEDМессенджер отклонил запрос.
403CHECKOUT_UNAVAILABLEВ этом приложении тариф сменить нельзя.
403BILLING_OWNER_ONLYСменить тариф может только владелец рабочего пространства.
422BILLING_COUNTRY_REQUIREDСначала выберите страну оплаты.
409BILLING_COUNTRY_LOCKEDСтрану оплаты может изменить только поддержка.
422PLAN_NOT_PURCHASABLEЭтот тариф сейчас нельзя купить.
422PAYMENT_PROVIDER_UNAVAILABLEЭтот способ оплаты сейчас недоступен.
409PRICE_CHANGEDЦена изменилась. Проверьте новую сумму.
409CHECKOUT_IN_PROGRESSПлатёж уже создаётся. Повторите через минуту.
502PAYMENT_PROVIDER_ERRORПлатёжный сервис не ответил. Попробуйте ещё раз.
404PAYMENT_NOT_FOUNDПлатёж не найден.

Лимиты

Лимиты многоуровневые: на API-ключ, workspace, устройство и SIM (лимит на SIM защищает карту от бесконечного цикла). Telegram добавляет свои flood-лимиты: 429 FLOOD_WAIT сообщает, сколько секунд ждать. Каждый 429 несёт заголовки Retry-After и X-RateLimit-*.