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

API для предварительной проверки телефонных номеров в WhatsApp Business | Документация для разработчиков

API для предварительной проверки телефонных номеров в WhatsApp Business

Экземпляр для программы магистратуры (LLM)
Версия
API для получения предварительно подтвержденных номеров телефонов, связанных с бизнес-аккаунтом WhatsApp.
Этот интерфейс позволяет компаниям получать информацию о предварительно проверенных телефонных номерах
которые доступны для использования с их бизнес-аккаунтом WhatsApp.

Базовый URL

https://graph.facebook.com

Конечные точки


GET /{Version}/{Business-ID}/preverified_numbers

Получите предварительно проверенные телефонные номера, доступные для использования в указанной компании.
Этот конечный пункт предоставляет информацию о предварительно проверенных телефонных номерах
и готовы к немедленному использованию в мессенджере WhatsApp Business.
Варианты использования:
Получите доступные предварительно проверенные номера телефонов для настройки корпоративной системы обмена сообщениями
Проверьте статус подтверждения и доступность телефонных номеров
Мониторинг предварительно проверенных телефонных номеров
Перед настройкой бизнес-аккаунта WhatsApp проверьте правильность выбранных номеров телефонов
Упростите быструю настройку корпоративной переписки с помощью предварительно проверенных номеров
Фильтрация и пагинация:
Результаты можно отфильтровать по статусу проверки, доступности и стране
Для больших наборов результатов поддерживается постраничная навигация с использованием курсоров
По умолчанию на странице размещается 25 элементов, максимальное количество элементов на странице — 100
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация о номере телефона может храниться в кэше в течение коротких периодов времени, но статус доступности может быть недоступен
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.

Синтаксис запроса

GET / {Version} / {Business-ID} /preverified_numbers
Попробуйте!
Выберите язык

curl
--request GET \ --url
'https://graph.facebook.com/{Version}/{Business-ID }/preverified_numbers' \ --header
'Authorization: Bearer ' \ --header
'Content-Type: application/json' \ --data
'{}'
Выберите код состояния

{
"basic_response"
: { "summary"
: "Базовый ответ с предварительно проверенными номерами телефонов" , "value"
: { "data"
: [ {
"id"
: "1234567890123456" , "display_phone_number"
: "+1 (555) 123-4567" , "country_prefix"
: 1 , "verification_status"
: "VERIFIED" , "availability_status"
: "AVAILABLE" , "created_time"
: "2024-01-15T10:30:00Z" , "last_updated"
: "2024-01-20T14:45:00Z" , "supported_features"
: [ "MESSAGING"
, "BUSINESS_PROFILE"
, "ВЕБ-ХУКСЫ"
],
"country_code"
: "США" , "region"
: "Северная Америка" },
{
"id"
: "2345678901234567" , "display_phone_number"
: "+44 20 1234 5678" , "country_prefix"
: 44 , "verification_status"
: "ПРОВЕРЕНО" , "availability_status"
: "ДОСТУПНО" , "created_time"
: "2024-01-10T08:15:00Z" , "last_updated"
: "2024-01-18T16:20:00Z" , "supported_features"
: [ "СООБЩЕНИЯ"
, "ШАБЛОНЫ"
, "АНАЛИТИКА"
],
"country_code"
: "GB" , "region"
: "Europe" }
],
"paging"
: { "cursors"
: { "after"
: "QVFIUjJ5WjBpMGpJWXprYzVYaVhabW9PVks4ZD0" },
"next"
: "https://graph.facebook.com/v23.0/1234567890123456 /preverified_numbers?after=QVFIUjJ5WjBpMGpJWXprYzV YaVhabW9PVks4ZD0" }
}
},
"filtered_response"
: { "summary"
: "Отфильтрованный ответ по стране и статусу" , "value"
: { "data"
: [ {
"id"
: "1234567890123456" , "display_phone_number"
: "+1 (555) 123-4567" , "country_prefix"
: 1 , "verification_status"
: "VERIFIED" , "availability_status"
: "AVAILABLE" , "country_code"
: "US" , "region"
: "North America" ​​}
],
"paging"
: { "cursors"
: {} }
}
},
"empty_response"
: { "summary"
: "Пустой ответ, когда нет доступных номеров телефонов " , "value"
: { "data"
: [], "paging"
: { "cursors"
: {} }
}
}
}
Параметры заголовка
Строка 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
limit integer [min: 1, max: 100]
Максимальное количество телефонных номеров, отображаемых на одной странице. По умолчанию — 25, максимум — 100.
после строки
Курсор для постраничной навигации. Используйте его для перехода на следующую страницу результатов.
Это значение содержится в объекте 'paging' предыдущих ответов.
перед строкой
Курсор для постраничной навигации. Используйте его для возврата на предыдущую страницу результатов.
Это значение содержится в объекте 'paging' предыдущих ответов.
verification_status PhoneNumberVerificationStatus
Фильтрация результатов по статусу подтверждения. Только номера телефонов с указанным статусом
Будет возвращен статус проверки.
availability_status PhoneNumberAvailabilityStatus
Фильтрация результатов по статусу доступности. Только номера телефонов с указанным статусом доступности
Будет возвращен статус доступности.
строка country_code
Фильтрация результатов по коду страны. Только телефонные номера из указанного региона
Будет возвращена страна. Используйте двухбуквенные коды стран по стандарту ISO 3166-1.
Ответы
Получите предварительно проверенные телефонные номера, доступные для использования в указанной компании.
Этот конечный пункт предоставляет информацию о предварительно проверенных телефонных номерах
и готовы к немедленному использованию в мессенджере WhatsApp Business.
Варианты использования:
Получите доступные предварительно проверенные номера телефонов для настройки корпоративной системы обмена сообщениями
Проверьте статус подтверждения и доступность телефонных номеров
Мониторинг предварительно проверенных телефонных номеров
Перед настройкой бизнес-аккаунта WhatsApp проверьте правильность выбранных номеров телефонов
Упростите быструю настройку корпоративной переписки с помощью предварительно проверенных номеров
Фильтрация и пагинация:
Результаты можно отфильтровать по статусу проверки, доступности и стране
Для больших наборов результатов поддерживается постраничная навигация с использованием курсоров
По умолчанию на странице размещается 25 элементов, максимальное количество элементов на странице — 100
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация о номере телефона может храниться в кэше в течение коротких периодов времени, но статус доступности может быть недоступен
Возможны частые изменения. Внедрите соответствующие стратегии аннулирования кэша.
200
Успешно получены предварительно проверенные номера телефонов
Тип содержимого: application/json
Схема: PreVerifiedPhoneNumbersResponse
Показать дочерние атрибуты

PreVerifiedPhoneNumbersResponse

данных PreVerifiedPhoneNumber · обязательный
Список предварительно проверенных телефонных номеров
Показать дочерние атрибуты

data[] PreVerifiedPhoneNumber
Предварительно проверенные данные номера телефона и информация о его статусе
Показать дочерние атрибуты

строковый идентификатор · обязательный
Уникальный идентификатор предварительно проверенного номера телефона

display_phone_number string · required
Отформатированная версия номера телефона для отображения

country_prefix integer [min: 1, max: 999]
Код страны, добавленный к номеру телефона

verification_status PhoneNumberVerificationStatus · required
Текущий статус проверки предварительно подтвержденного номера телефона

availability_status PhoneNumberAvailabilityStatus
Текущий статус доступности предварительно проверенного номера телефона

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_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
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык

curl
--request GET \ --url
'https://graph.facebook.com/{Version}/{Business-ID }/preverified_numbers' \ --header
'Authorization: Bearer ' \ --header
'Content-Type: application/json' \ --data
'{}'
Выберите код состояния

{
"basic_response"
: { "summary"
: "Базовый ответ с предварительно проверенными номерами телефонов" , "value"
: { "data"
: [ {
"id"
: "1234567890123456" , "display_phone_number"
: "+1 (555) 123-4567" , "country_prefix"
: 1 , "verification_status"
: "VERIFIED" , "availability_status"
: "AVAILABLE" , "created_time"
: "2024-01-15T10:30:00Z" , "last_updated"
: "2024-01-20T14:45:00Z" , "supported_features"
: [ "MESSAGING"
, "BUSINESS_PROFILE"
, "ВЕБ-ХУКСЫ"
],
"country_code"
: "США" , "region"
: "Северная Америка" },
{
"id"
: "2345678901234567" , "display_phone_number"
: "+44 20 1234 5678" , "country_prefix"
: 44 , "verification_status"
: "ПРОВЕРЕНО" , "availability_status"
: "ДОСТУПНО" , "created_time"
: "2024-01-10T08:15:00Z" , "last_updated"
: "2024-01-18T16:20:00Z" , "supported_features"
: [ "СООБЩЕНИЯ"
, "ШАБЛОНЫ"
, "АНАЛИТИКА"
],
"country_code"
: "GB" , "region"
: "Europe" }
],
"paging"
: { "cursors"
: { "after"
: "QVFIUjJ5WjBpMGpJWXprYzVYaVhabW9PVks4ZD0" },
"next"
: "https://graph.facebook.com/v23.0/1234567890123456 /preverified_numbers?after=QVFIUjJ5WjBpMGpJWXprYzV YaVhabW9PVks4ZD0" }
}
},
"filtered_response"
: { "summary"
: "Отфильтрованный ответ по стране и статусу" , "value"
: { "data"
: [ {
"id"
: "1234567890123456" , "display_phone_number"
: "+1 (555) 123-4567" , "country_prefix"
: 1 , "verification_status"
: "VERIFIED" , "availability_status"
: "AVAILABLE" , "country_code"
: "US" , "region"
: "North America" ​​}
],
"paging"
: { "cursors"
: {} }
}
},
"empty_response"
: { "summary"
: "Пустой ответ, когда нет доступных номеров телефонов " , "value"
: { "data"
: [], "paging"
: { "cursors"
: {} }
}
}
}

Аутентификация

Схема
Тип
Расположение
bearerAuth
HTTP Bearer
Заголовок: Авторизация

Примеры использования

bearerAuth:
Включите Authorization: Bearer your-token-here в заголовки запроса.

Глобальные требования к аутентификации

Для работы всех конечных точек требуется:
bearerAuth