API для партнеров WhatsApp Business по предварительной проверке телефонных номеров | Документация для разработчиков
API для партнеров WhatsApp Business по предварительной проверке телефонных номеров
Экземпляр для программы магистратуры (LLM)
Версия
API для получения информации о компаниях-партнерах, связанных с предварительно подтвержденным номером телефона WhatsApp Business.
Этот конечный пункт позволяет авторизованным приложениям получать список компаний-партнеров
которым предоставлен доступ к определенному предварительно проверенному номеру телефона.
GET /{Version}/{Pre-Verified-Phone-Number-ID}/partners
Получите список компаний-партнеров, которым предоставлен доступ к определенному ресурсу
Предварительно подтвержденный номер телефона для WhatsApp Business.
Варианты использования:
Отслеживайте деловые отношения с партнерами и права доступа
Проверьте, какие компании имеют доступ к общим предварительно проверенным телефонным номерам
Получение информации о деятельности партнеров для оперативных целей
Перед началом бизнес-операций проверьте конфигурацию партнерских отношений
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация о партнерах может кэшироваться в течение умеренного времени, но партнерские отношения остаются неизменными
Возможны изменения. Внедрите соответствующие стратегии аннулирования кэша.
Синтаксис запроса
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
"Pre-Verified-Phone-Number-ID"Строка·обязательна
Идентификатор вашего предварительно подтвержденного номера телефона. Этот идентификатор предоставляется после подтверждения номера телефона
Он создан и доступен в интерфейсе управления вашей учетной записью WhatsApp Business.
Параметры запроса
полястрока
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены поля по умолчанию (id, name). Доступные поля: id, name, created_time,
updated_time, verification_status, primary_page, timezone_id, two_factor_type
limitinteger [min: 1, max: 100]
Максимальное количество компаний-партнеров, отображаемых на одной странице. По умолчанию — 25, максимум — 100.
послестроки
Курсор для постраничной навигации. Используйте курсор «после» из предыдущего ответа, чтобы перейти на следующую страницу.
передстрокой
Курсор для постраничной навигации. Используйте курсор «перед» из предыдущего ответа, чтобы перейти на предыдущую страницу.
Ответы
Получите список компаний-партнеров, которым предоставлен доступ к определенному ресурсу
Предварительно подтвержденный номер телефона для WhatsApp Business.
Варианты использования:
Отслеживайте деловые отношения с партнерами и права доступа
Проверьте, какие компании имеют доступ к общим предварительно проверенным телефонным номерам
Получение информации о деятельности партнеров для оперативных целей
Перед началом бизнес-операций проверьте конфигурацию партнерских отношений
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация о партнерах может кэшироваться в течение умеренного времени, но партнерские отношения остаются неизменными
Возможны изменения. Внедрите соответствующие стратегии аннулирования кэша.
200
Успешно получены данные о компаниях-партнерах по предварительно проверенному номеру телефона
Тип содержимого: application/json
Схема: WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse
Показать дочерние атрибуты
WhatsAppBusinessPreVerifiedPhoneNumberPartnersResponse
данныхBusinessPartner·обязательный
Список компаний-партнеров, имеющих доступ к предварительно проверенному номеру телефона
Показать дочерние атрибуты
данные[]Бизнес-партнер
Юридическое лицо, имеющее партнерский доступ к предварительно проверенному номеру телефона
Показать дочерние атрибуты
идентификаторстроковый·обязательный
Уникальный идентификатор для партнерского бизнеса
именистрока·обязательный
Название компании-партнера
created_timeстрока (дата-время)
Отметка времени создания компании в соответствии со стандартом ISO 8601
updated_timeстрока (дата-время)
Отметка времени в формате ISO 8601, когда компания в последний раз обновляла свои данные
verification_statusОдин из значений "not_verified", "pending", "verified"
Статус подтверждения бизнеса
основная_страницастрока
Основной идентификатор страницы Facebook, связанный с компанией
timezone_idцелое число
Идентификатор часового пояса для местоположения предприятия
two_factor_typeОдин из вариантов: "none", "admin_required"
Для бизнеса настроен метод двухфакторной аутентификации
навигацияКурсорСтраничная
Информация о постраничной навигации на основе курсора
Показать дочерние атрибуты
курсоровобъект
Показать дочерние атрибуты
передстрокой
Курсор, указывающий на начало страницы с возвращенными данными
послестроки
Курсор, указывающий на конец страницы с возвращенными данными
следующаястрока
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
Комментарии отсутствуют
Комментарии отсутствуют