WhatsApp Business API - API для ввода номера счета WhatsApp | Документация для разработчиков
WhatsApp Business API - API для ввода номера счета WhatsApp
Экземпляр для программы магистратуры (LLM)
Версия
API для получения данных о номере учетной записи WhatsApp и информации о конфигурации.
Этот конечный пункт позволяет компаниям получать исчерпывающую информацию о своих..
Номера учетных записей WhatsApp, включая статус, данные для подтверждения и настройки конфигурации.
GET /{Version}/{WhatsApp-Account-Number-ID}
Получите исчерпывающую информацию о номере учетной записи WhatsApp, включая ее текущий статус
Информация для проверки, оценка качества и параметры конфигурации.
Варианты использования:
Отслеживайте статус номера счета и рейтинг качества
Перед отправкой сообщений проверьте правильность настройки номера счета
Проверьте статус проверки и утверждения
Получить отображаемое имя и информацию о бизнес-профиле
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Данные номера счета могут кэшироваться на короткие периоды, но информация о статусе может изменяться
часто. Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка "Номер-аккаунта-WhatsApp" · обязательный
Ваш идентификатор учетной записи WhatsApp. Этот идентификатор обозначает номер счета
и их можно получить из списка телефонных номеров вашего бизнес-аккаунта WhatsApp.
Параметры запроса
поля строка
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (id, display_phone_number, status).
Доступные поля: id, display_phone_number, verified_name, status, quality_rating,
country_code, country_dial_code, code_verification_status, name_status,
messaging_limit_tier, account_mode, certificate, is_official_business_account
Ответы
Получите исчерпывающую информацию о номере учетной записи WhatsApp, включая ее текущий статус
Информация для проверки, оценка качества и параметры конфигурации.
Варианты использования:
Отслеживайте статус номера счета и рейтинг качества
Перед отправкой сообщений проверьте правильность настройки номера счета
Проверьте статус проверки и утверждения
Получить отображаемое имя и информацию о бизнес-профиле
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Данные номера счета могут кэшироваться на короткие периоды, но информация о статусе может изменяться
часто. Внедрите соответствующие стратегии аннулирования кэша.
200
Данные номера учетной записи WhatsApp успешно получены
Тип содержимого: application/json
Схема: WhatsAppAccountNumber
Показать дочерние атрибуты
Номер аккаунта WhatsApp
строковый идентификатор · обязательный
Уникальный идентификатор номера учетной записи WhatsApp
display_phone_number string · required
Номер телефона в международном формате для отображения
verified_name string
Название компании для этого номера телефона подтверждено
статус WhatsAppAccountNumberStatus · обязательный
Текущий статус номера аккаунта WhatsApp
quality_rating WhatsAppPhoneNumberQualityRating
Оценка качества основана на доставке сообщения и отзывах пользователей
строка country_code
Код страны ISO 3166-1 alpha-2
строка country_dial_code
код страны
code_verification_status WhatsAppCodeVerificationStatus
Статус двухфакторной аутентификации для номера телефона
name_status WhatsAppDisplayNameStatus
Статус отображаемого имени, связанного с номером телефона
messaging_limit_tier Один из "TIER_50", "TIER_250", "TIER_1K", "TIER_10K", "TIER_100K", "TIER_UNLIMITED"
Текущий лимит сообщений для номера счета
account_mode WhatsAppBusinessSandboxEligibility
Режим учетной записи, указывающий на тестовую или рабочую среду
строка сертификата
Информация о регистрационном удостоверении предприятия для номера счета
is_official_business_account boolean
Является ли это официальным бизнес-аккаунтом?
400
Неверный запрос — недопустимые параметры или некорректный формат запроса
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
403
Запрещено — Недостаточные права доступа или отказ в доступе
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
404
Счет не найден — Идентификатор счета не существует или недоступен
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
422
Необрабатываемый объект — Параметры запроса действительны, но не могут быть обработаны
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
500
Внутренняя ошибка сервера — Неожиданная ошибка сервера
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
объект ошибки · обязательный
Показать дочерние атрибуты
строка сообщения · обязательный
Удобочитаемое сообщение об ошибке
тип строка · обязательный
Тип категории ошибки
код целое число · обязательный
Числовой код ошибки
error_subcode integer
Более подробный подкод ошибки, если он доступен
fbtrace_id строка
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transient логическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
строка error_user_title
Удобный для пользователя заголовок сообщения об ошибке для наглядности
строка error_user_msg
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют