Многопартнерские решения WhatsApp Business — подробная информация о решении API | Документация для разработчиков

Многопартнерские решения WhatsApp Business — подробная информация о решении (API)

Экземпляр для программы магистратуры (LLM)

Просмотреть в формате Markdown

Версия

API для получения подробной информации о многопартнерском решении и данных о его конфигурации.

Эта конечная точка позволяет партнерам по решениям получать исчерпывающую информацию о своих продуктах

Многопартнерские решения, включая информацию о статусе, правах доступа и правах собственности.

Базовый URL

https://graph.facebook.com

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

ПОЛУЧАТЬ

/{Версия}/{Идентификатор решения}

GET /{Version}/{Solution-ID}

Получите исчерпывающую информацию о многопартнерском решении, включая его текущий статус

Ожидаемые изменения статуса, информация о владельцах и предоставленные разрешения.

Варианты использования:

Отслеживайте жизненный цикл решения и изменения его статуса

Перед подключением бизнеса к системе проверьте конфигурацию решения

Проверьте ожидающие утверждения запросы и изменения статуса

Получите информацию о владельце решения и его правах доступа

Ограничение скорости запросов:

Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.

Кэширование:

Детали решения могут кэшироваться на короткие периоды, но информация о состоянии может изменяться

Часто во время переходов. Внедрите соответствующие стратегии аннулирования кэша.

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

GET / {Version} / {Solution-ID}

Попробуйте!

Выберите язык

curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{Solution-ID }' \ --header
 'Authorization: Bearer ' \ --header
 'Content-Type: application/json' \ --data
 '{}'

Выберите код состояния

{
 "active_solution"
 : { "summary"
 : "Активное решение с полными подробностями" , "value"
 : { "id"
 : "1234567890123456" , "name"
 : "Решение для интеграции электронной коммерции" , "status"
 : "АКТИВНЫЙ" , "status_for_pending_request"
 : "НЕТ" , "owner_app"
 : { "id"
 : "9876543210987654" , "name"
 : "Приложение партнера по решениям" },
 "owner_permissions"
 : [ "MANAGE"
 , "DEVELOP"
 , "MANAGE_TEMPLATES"
 , "VIEW_INSIGHTS"
 ]
 }
 },
 "draft_solution"
 : { "summary"
 : "Черновик решения с минимальными подробностями" , "value"
 : { "id"
 : "2345678901234567" , "name"
 : "Решение для поддержки клиентов" , "status"
 : "Черновик" , "status_for_pending_request"
 : "Нет" }
 }
 }

Параметры заголовка

Строка User-Agent

Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.

Строка авторизации · обязательный

Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.

Параметры пути

Строка версии · обязательный

Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.

Строка идентификатора решения · обязательный

Идентификатор вашего многопартнерского решения. Этот идентификатор присваивается при создании решения

и их можно найти в вашей партнерской панели или через API управления решениями.

Параметры запроса

поля строка

Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,

Будут возвращены поля по умолчанию (имя, статус, статус для ожидающего запроса).

Доступные поля: id, name, status, status_for_pending_request, owner_app, owner_permissions

Ответы

Получите исчерпывающую информацию о многопартнерском решении, включая его текущий статус

Ожидаемые изменения статуса, информация о владельцах и предоставленные разрешения.

Варианты использования:

Отслеживайте жизненный цикл решения и изменения его статуса

Перед подключением бизнеса к системе проверьте конфигурацию решения

Проверьте ожидающие утверждения запросы и изменения статуса

Получите информацию о владельце решения и его правах доступа

Ограничение скорости запросов:

Кэширование:

Детали решения могут кэшироваться на короткие периоды, но информация о состоянии может изменяться

Часто во время переходов. Внедрите соответствующие стратегии аннулирования кэша.

200

Получены подробные сведения о многопартнерском решении

Тип содержимого: application/json

Схема: WhatsAppBusinessSolution

Показать дочерние атрибуты

WhatsAppBusinessSolution

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

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

строка имени · обязательный

Удобочитаемое название многопартнерского решения

статус WhatsAppBusinessSolutionStatus · обязательный

Текущий статус функционирования многопартнерского решения

Показать дочерние атрибуты

status_for_pending_request WhatsAppBusinessSolutionPendingStatus · required

Статус любых ожидающих запросов на изменение статуса решения

owner_app ApplicationNode

Мета-приложение, владеющее многопартнерским решением

Показать дочерние атрибуты

строка идентификатора

Уникальный идентификатор приложения Meta

строка имени

Название приложения Meta

массив owner_permissions

Список разрешений для бизнес-аккаунта WhatsApp, предоставленных владельцу решения

Показать дочерние атрибуты

owner_permissions[] WhatsAppBusinessAccountPermissionTask

Детализированные задачи по предоставлению разрешений для доступа к бизнес-аккаунту WhatsApp

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}/{Solution-ID }' \ --header
 'Authorization: Bearer ' \ --header
 'Content-Type: application/json' \ --data
 '{}'

Выберите код состояния

{
 "active_solution"
 : { "summary"
 : "Активное решение с полными подробностями" , "value"
 : { "id"
 : "1234567890123456" , "name"
 : "Решение для интеграции электронной коммерции" , "status"
 : "АКТИВНЫЙ" , "status_for_pending_request"
 : "НЕТ" , "owner_app"
 : { "id"
 : "9876543210987654" , "name"
 : "Приложение партнера по решениям" },
 "owner_permissions"
 : [ "MANAGE"
 , "DEVELOP"
 , "MANAGE_TEMPLATES"
 , "VIEW_INSIGHTS"
 ]
 }
 },
 "draft_solution"
 : { "summary"
 : "Черновик решения с минимальными подробностями" , "value"
 : { "id"
 : "2345678901234567" , "name"
 : "Решение для поддержки клиентов" , "status"
 : "Черновик" , "status_for_pending_request"
 : "Нет" }
 }
 }

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

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

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

bearerAuth:

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

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

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

bearerAuth