Справочник API

Справочник

Справочник ошибок

При ошибке проверьте HTTP-статус и определите причину по error.code или пятизначному error.numeric_code. error.message предназначено для чтения, а не ветвления программы. Сохраните request_id для диагностики.

400 Bad Request

  • invalid_request10000

    Проверьте JSON и обязательные поля.

  • invalid_provider30000

    Проверьте идентификатор канала в URL.

  • unsupported_action30005

    Действие аккаунта не распознано; используйте документированное действие.

  • invalid_conversation_type37000

    type должен быть user, group или channel.

  • unsupported_conversation_type37001

    Канал не поддерживает операцию; выберите доступную в таблице возможностей.

  • unsupported_message_type36000

    Используйте поддерживаемый каналом message.type.

  • unsupported_provider_auth_mode20018

    Используйте поддерживаемый каналом auth_mode.

  • auth_mode_phone_required20019

    При создании аккаунта этот способ требует provider_data.phone.

  • invalid_reply_token36006

    Токен цитирования не читается. Передайте data.message.reply_token входящего события без изменений.

  • provider_invalid_request30001

    Проверьте поля и форматы, специфичные для канала.

  • create_api_key_failed11101

    Операция отклонена. Проверьте запрос и сохраните request_id.

  • update_api_key_failed11102

    Операция отклонена. Проверьте запрос и сохраните request_id.

  • rotate_api_key_failed11103

    Операция отклонена. Проверьте запрос и сохраните request_id.

  • update_workspace_failed41001

    Операция отклонена. Проверьте запрос и сохраните request_id.

401 Unauthorized

  • missing_api_key11000

    Добавьте заголовок X-Api-Key.

  • invalid_api_key11001

    Проверьте правильность и активность ключа API.

403 Forbidden

  • beta_feature_not_enabled41002

    Для API звонков и явной подписки на события нужен доступ рабочего пространства к закрытому тестированию.

  • cors_forbidden11009

    Источник, метод или заголовки CORS не разрешены. Проверьте среду вызова.

404 Not Found

  • call_not_found38003

    Звонок не найден в этом аккаунте и рабочем пространстве.

  • not_found10001

    Проверьте путь API и HTTP-метод.

  • conversation_not_found37002

    Канал не нашёл беседу. Проверьте идентификатор и аккаунт.

  • contact_not_found35000

    Контакт не найден для этого аккаунта; проверьте идентификатор.

  • group_not_found34004

    Группа не найдена для этого аккаунта; проверьте ID группы.

409 Conflict

  • call_already_active38000

    У аккаунта уже есть управляемый звонок. Запросите call_id и завершите его или дождитесь окончания.

  • account_allocation_busy20011

    Распределение аккаунта занято; повторите позже.

  • no_allocatable_server20013

    В регионе нет свободной ёмкости; запросите доступные регионы.

  • workspace_account_quota_exceeded20014

    Достигнут лимит аккаунтов для сообщений; проверьте квоту и использование.

  • duplicate_provider_account20015

    Эта учётная запись канала уже привязана к другому аккаунту пространства.

  • account_already_authorized20016

    Аккаунт уже авторизован. Используйте его или отмените авторизацию перед новым процессом.

  • account_binding_not_found30006

    Нет активной привязки к подключению канала; проверьте состояние аккаунта.

  • provider_account_mismatch20017

    Идентификатор канала в запросе не совпадает с привязкой аккаунта.

  • provider_not_ready30009

    Подключение не готово. Перед повтором проверьте авторизацию и runtime_status.

422 Unprocessable Entity

  • contact_not_found35000

    GET /contacts/info вернул Conversation not found. Проверьте идентификатор цели и аккаунт запроса.

500 Internal Server Error

  • create_call_failed38002

    Создать звонок: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • call_control_failed38004

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • create_account_failed20002

    Создать аккаунт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • update_account_failed20003

    Обновить аккаунт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • delete_account_failed20004

    Удалить аккаунт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_account_failed20001

    Получить аккаунт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_accounts_failed20000

    Список аккаунтов: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_session_failed20005

    Состояние аутентификации: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_auth_state_failed20006

    Состояние аутентификации: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • run_action_failed20007

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • run_runtime_action_failed20008

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • run_session_action_failed20009

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • run_auth_action_failed20010

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • send_message_failed36001

    Отправить текстовое сообщение: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • pin_message_failed36002

    Закрепить / открепить сообщение: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • revoke_message_failed36003

    Отозвать сообщение: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • react_message_failed36004

    Реакция на сообщение: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • edit_message_failed36005

    Редактировать сообщение: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_conversations_failed37003

    Список бесед: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_conversation_failed37004

    Детали беседы: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_conversation_members_failed37005

    Список участников: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • mark_conversation_read_failed37006

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • mark_conversation_unread_failed37007

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • mute_conversation_failed37008

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • unmute_conversation_failed37009

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • pin_conversation_failed37010

    Закрепить беседу: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • unpin_conversation_failed37011

    Открепить беседу: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_conversation_labels_failed37012

    Список меток бесед: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • upsert_label_failed37013

    Создать или обновить метку: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • delete_label_failed37014

    Удалить метку: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • set_label_members_failed37015

    Добавить / убрать метку на беседах: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_contacts_failed35001

    Список контактов: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_contact_failed35002

    Получить контакт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • create_contact_failed35003

    Добавить контакт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_contact_membership_failed35004

    Проверить наличие контакта: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • block_contact_failed35005

    Заблокировать контакт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • unblock_contact_failed35006

    Разблокировать контакт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_blocklist_failed35007

    Получить чёрный список: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • set_contact_note_failed35008

    Заметка о контакте: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_groups_failed34000

    Список групп: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_group_failed34001

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • create_group_failed34002

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • leave_group_failed34003

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • update_group_members_failed34005

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • update_group_info_failed34006

    Обновить информацию группы: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_group_join_requests_failed34007

    Заявки на вступление в группу: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • update_group_join_requests_failed34008

    Одобрить / отклонить заявки: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • set_group_join_approval_mode_failed34009

    Режим одобрения вступления: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_group_invite_code_failed34010

    Пригласительная ссылка группы: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_webhook_endpoints_failed40000

    Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • create_webhook_endpoint_failed40001

    Создать Webhook-эндпоинт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_webhook_endpoint_failed40002

    Получить Webhook-эндпоинт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • update_webhook_endpoint_failed40003

    Обновить Webhook-эндпоинт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • deactivate_webhook_endpoint_failed40004

    Деактивировать Webhook-эндпоинт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • delete_webhook_endpoint_failed40005

    Удалить Webhook-эндпоинт: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • get_workspace_failed41000

    Получить текущий workspace: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_api_keys_failed11100

    Список API-ключей: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

  • list_provider_regions_failed30011

    Список регионов провайдера: Сервис или канал не завершил операцию. Сохраните request_id и проверьте результат перед повтором записи.

501 Not Implemented

  • unsupported_by_provider30003

    Канал не поддерживает операцию; выберите доступную в таблице возможностей.

502 Bad Gateway

  • provider_adapter_not_found30004

    Сервис канала недоступен. Проверьте состояние или повторите позже; перед повтором записи проверьте предыдущий результат.

  • provider_unavailable30002

    Сервис канала недоступен. Проверьте состояние или повторите позже; перед повтором записи проверьте предыдущий результат.

503 Service Unavailable

  • call_service_unavailable38001

    Сервис звонков недоступен. Проверьте соединение и настройки Provider/Gateway.

  • allocation_service_unavailable20012

    Сервис распределения временно недоступен; повторите позже.

Детализированные числовые коды Provider

Эти коды уточняют причину Provider, не изменяя исходный HTTP-статус или legacy code.

  • provider_operation_failed30010

    Provider operation failed

    Канал не завершил операцию. Сохраните request_id для диагностики.

  • group_not_found34004

    Group not found

    Группа не найдена. Некоторые существующие пути канала сохраняют исходные HTTP-статус и error.code.

  • group_not_participant34011

    Account is not participating in this group

    Группа может существовать, но аккаунт в ней не участвует.