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

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

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

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

Версия

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

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

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

База URL

~~https://graph.facebook.com~~

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

~~ПОЛУЧАТЬ~~

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

GET /{Version}/{Solution-ID}

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

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

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

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

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

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

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

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

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

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

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

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

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

GET /{Version}/{Solution-ID}

Попробуйте!

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

локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{Solution-ID}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'

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

{
"active_solution": {
"краткое содержание": «Активное решение с подробным описанием»,
"ценить": {
"идентификатор": "1234567890123456",
"имя": «Решение для интеграции электронной коммерции»,
«статус»: "АКТИВНЫЙ",
"status_for_pending_request": "НИКТО",
"owner_app": {
"идентификатор": "9876543210987654",
"имя": «Приложение для партнеров по решениям»
      },
"owner_permissions": [
"УПРАВЛЯТЬ",
"РАЗВИВАТЬ",
"УПРАВЛЕНИЕ ШАБЛОНАМИ",
"VIEW_INSIGHTS"
      ]
    }
  },
"draft_solution": {
"краткое содержание": «Предварительный вариант решения с минимальным количеством деталей»,
"ценить": {
"идентификатор": "2345678901234567",
"имя": «Решение для поддержки клиентов»,
«статус»: "ЧЕРНОВИК",
"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_requestWhatsAppBusinessSolutionPendingStatus·required

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

owner_appApplicationNode

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

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

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

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

именистрока

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

owner_permissionsмассив

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

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

owner_permissions[]WhatsAppBusinessAccountPermissionTask

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

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строка

Удобное для пользователя сообщение об ошибке для отображения

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

локон--запросПОЛУЧАТЬ \
--url'https://graph.facebook.com/{Version}/{Solution-ID}' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{}'

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

{
"active_solution": {
"краткое содержание": «Активное решение с подробным описанием»,
"ценить": {
"идентификатор": "1234567890123456",
"имя": «Решение для интеграции электронной коммерции»,
«статус»: "АКТИВНЫЙ",
"status_for_pending_request": "НИКТО",
"owner_app": {
"идентификатор": "9876543210987654",
"имя": «Приложение для партнеров по решениям»
      },
"owner_permissions": [
"УПРАВЛЯТЬ",
"РАЗВИВАТЬ",
"УПРАВЛЕНИЕ ШАБЛОНАМИ",
"VIEW_INSIGHTS"
      ]
    }
  },
"draft_solution": {
"краткое содержание": «Предварительный вариант решения с минимальным количеством деталей»,
"ценить": {
"идентификатор": "2345678901234567",
"имя": «Решение для поддержки клиентов»,
«статус»: "ЧЕРНОВИК",
"status_for_pending_request": "НИКТО"
    }
  }
}

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

Схема

Тип

Расположение

bearerAuth

HTTP Bearer

Заголовок: Авторизация

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

bearerAuth:

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

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

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

bearerAuth