API для предварительной проверки телефонных номеров в WhatsApp Business | Документация для разработчиков
API для предварительной проверки телефонных номеров в WhatsApp Business
Экземпляр для программы магистратуры (LLM)
Версия
API для получения предварительно подтвержденных номеров телефонов, связанных с бизнес-аккаунтом WhatsApp.
Этот интерфейс позволяет компаниям получать информацию о предварительно проверенных телефонных номерах
которые доступны для использования с их бизнес-аккаунтом WhatsApp.
GET /{Version}/{Business-ID}/preverified_numbers
Получите предварительно проверенные телефонные номера, доступные для использования в указанной компании.
Этот конечный пункт предоставляет информацию о предварительно проверенных телефонных номерах
и готовы к немедленному использованию в мессенджере WhatsApp Business.
Варианты использования:
Получите доступные предварительно проверенные номера телефонов для настройки корпоративной системы обмена сообщениями
Проверьте статус подтверждения и доступность телефонных номеров
Мониторинг предварительно проверенных телефонных номеров
Перед настройкой бизнес-аккаунта WhatsApp проверьте правильность выбранных номеров телефонов
Упростите быструю настройку корпоративной переписки с помощью предварительно проверенных номеров
Фильтрация и пагинация:
Результаты можно отфильтровать по статусу проверки, доступности и стране
Для больших наборов результатов поддерживается постраничная навигация с использованием курсоров
По умолчанию на странице размещается 25 элементов, максимальное количество элементов на странице — 100
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация о номере телефона может храниться в кэше в течение коротких периодов времени, но статус доступности может быть недоступен
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Business-IDСтрока·обязательный
Идентификационный номер вашей компании, для которого можно получить предварительно подтвержденные номера телефонов.
Этот идентификатор можно найти в вашем Meta Business Manager или через API управления бизнесом.
Параметры запроса
полястрока
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (id, display_phone_number, verification_status).
Доступные поля: id, display_phone_number, country_prefix, verification_status,
availability_status, created_time, last_updated, supported_features, country_code, region
limitinteger [min: 1, max: 100]
Максимальное количество телефонных номеров, отображаемых на одной странице. По умолчанию — 25, максимум — 100.
послестроки
Курсор для постраничной навигации. Используйте его для перехода на следующую страницу результатов.
Это значение содержится в объекте 'paging' предыдущих ответов.
передстрокой
Курсор для постраничной навигации. Используйте его для возврата на предыдущую страницу результатов.
Это значение содержится в объекте 'paging' предыдущих ответов.
verification_statusPhoneNumberVerificationStatus
Фильтрация результатов по статусу подтверждения. Только номера телефонов с указанным статусом
Будет возвращен статус проверки.
availability_statusPhoneNumberAvailabilityStatus
Фильтрация результатов по статусу доступности. Только номера телефонов с указанным статусом доступности
Будет возвращен статус доступности.
country_codeстрока
Фильтрация результатов по коду страны. Только телефонные номера из указанного региона
Будет возвращена страна. Используйте двухбуквенные коды стран по стандарту ISO 3166-1.
Ответы
Получите предварительно проверенные телефонные номера, доступные для использования в указанной компании.
Этот конечный пункт предоставляет информацию о предварительно проверенных телефонных номерах
и готовы к немедленному использованию в мессенджере WhatsApp Business.
Варианты использования:
Получите доступные предварительно проверенные номера телефонов для настройки корпоративной системы обмена сообщениями
Проверьте статус подтверждения и доступность телефонных номеров
Мониторинг предварительно проверенных телефонных номеров
Перед настройкой бизнес-аккаунта WhatsApp проверьте правильность выбранных номеров телефонов
Упростите быструю настройку корпоративной переписки с помощью предварительно проверенных номеров
Фильтрация и пагинация:
Результаты можно отфильтровать по статусу проверки, доступности и стране
Для больших наборов результатов поддерживается постраничная навигация с использованием курсоров
По умолчанию на странице размещается 25 элементов, максимальное количество элементов на странице — 100
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация о номере телефона может храниться в кэше в течение коротких периодов времени, но статус доступности может быть недоступен
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
200
Успешно получены предварительно проверенные номера телефонов
Тип содержимого: application/json
Схема: PreVerifiedPhoneNumbersResponse
Показать дочерние атрибуты
PreVerifiedPhoneNumbersResponse
данныхPreVerifiedPhoneNumber·обязательный
Список предварительно проверенных телефонных номеров
Показать дочерние атрибуты
data[]PreVerifiedPhoneNumber
Предварительно проверенные данные номера телефона и информация о его статусе
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Уникальный идентификатор предварительно проверенного номера телефона
display_phone_numberstring·required
Отформатированная версия номера телефона для отображения
country_prefixinteger [min: 1, max: 999]
Код страны, добавленный к номеру телефона
verification_statusPhoneNumberVerificationStatus·required
Текущий статус проверки предварительно подтвержденного номера телефона
availability_statusPhoneNumberAvailabilityStatus
Текущий статус доступности предварительно проверенного номера телефона
created_timeстрока (дата-время)
Отметка времени предварительной проверки номера телефона
last_updatedстрока (дата-время)
Отметка времени последнего обновления информации о номере телефона
supported_featuresмассив
Список функций WhatsApp Business, поддерживаемых этим номером телефона
Показать дочерние атрибуты
supported_features[]WhatsAppBusinessFeature
Функции WhatsApp Business, поддерживаемые номером телефона
country_codeстрока
Код страны ISO 3166-1 alpha-2 для телефонного номера
регионастрока
Географический регион или область, для которой предназначен телефонный номер
навигацияКурсорСтраничная
Информация о постраничной навигации на основе курсора
Показать дочерние атрибуты
курсоровобъект
Показать дочерние атрибуты
передстрокой
Курсор, указывающий на начало страницы с возвращенными данными
послестроки
Курсор, указывающий на конец страницы с возвращенными данными
следующаястрока
URL-адрес конечной точки Graph API для следующей страницы результатов
предыдущаястрока
URL-адрес конечной точки Graph API для предыдущей страницы результатов
400
Неверный запрос — недопустимые параметры или некорректный формат запроса
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
401
Несанкционированный доступ - Недействительный или отсутствующий токен доступа
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
403
Запрещено — Недостаточные права доступа или отказ в доступе
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
404
Компания не найдена — она не существует или недоступна
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
422
Необрабатываемый объект — Параметры запроса действительны, но не могут быть обработаны
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
429
Слишком много запросов — превышен лимит запросов
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
500
Внутренняя ошибка сервера — Неожиданная ошибка сервера
Тип содержимого: application/json
Schema: GraphAPIError
Показать дочерние атрибуты
GraphAPIError
ошибкиобъект·обязательный
Показать дочерние атрибуты
сообщениястрока·обязательный
Удобочитаемое сообщение об ошибке
типстрока·обязательный
Тип категории ошибки
кодцелое число·обязательный
Числовой код ошибки
error_subcodeinteger
Более подробный подкод ошибки, если он доступен
fbtrace_idстрока
Уникальный идентификатор для запросов на отладку и поддержку в Meta
is_transientлогическое значение
Указывает, является ли эта ошибка временной и следует ли повторить запрос
error_user_titleстрока
Удобный для пользователя заголовок сообщения об ошибке для наглядности
error_user_msgстрока
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют