Многопартнерские решения WhatsApp Business — API для принятия решений | Документация для разработчиков
Многопартнерские решения WhatsApp Business - API для принятия решений
Экземпляр для программы магистратуры (LLM)
Версия
API для приема приглашений к участию в партнерских программах с несколькими партнерами.
Этот конечный пункт позволяет партнерским приложениям принимать приглашения к участию в
Решения для работы с несколькими партнерами.
POST /{Version}/{Solution-ID}/accept
Примите приглашение принять участие в многопартнерском решении в качестве партнера.
Эта конечная точка изменяет статус партнера с NOTIFICATION_SENT на ACCEPTED
это позволит перевести решение в активный статус после того, как все необходимые партнеры дадут свое согласие.
Варианты использования:
Принимайте приглашения к сотрудничеству для разработки многопартнерских решений
Активизировать участие партнеров в существующих решениях
Подтвердите приверженность партнерского приложения условиям использования решения
Обеспечьте переход процесса обработки решения из статуса «ИНИЦИИРОВАНО» в статус «АКТИВНО»
Бизнес-логика:
Только приглашенные партнерские приложения могут принимать приглашения к использованию решений
Для принятия партнерских соглашений решение должно находиться в статусе «Инициировано»
Статус партнера меняется с NOTIFICATION_SENT на ACCEPTED
Решение может стать активным после того, как все необходимые партнеры примут его
Принятие условий создает формальное партнерское соглашение между приложениями
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Проверка:
Приложение-партнер должно получить действительное приглашение к использованию решения
Решение должно существовать и быть доступно для партнерского приложения
Партнерское приложение должно обладать соответствующими разрешениями и возможностями
В запросе на принятие необходимо указать действительный идентификатор партнерского приложения
Синтаксис запроса
POST /{Version}/{Solution-ID}/accept
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
User-AgentСтрока
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
авторизацииСтрока·обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
версииСтрока·обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
идентификатора решенияСтрока·обязательный
Идентификатор многопартнерского решения, которое необходимо принять. Этот идентификатор указан в исходном документе
Приглашение можно найти в уведомлениях для партнеров или в интерфейсах управления решениями.
Текст запросаНеобходимый
Тип содержимого: application/json
Схема: WhatsAppBusinessSolutionAcceptRequest
Показать дочерние атрибуты
WhatsAppBusinessSolutionAcceptRequest
partner_app_idстрока·обязательный
Идентификатор приложения-партнера, принявшего приглашение к использованию решения.
Этот идентификатор должен совпадать с идентификатором приложения, получившего первоначальное приглашение.
log_session_idстрока
Необязательный идентификатор сессии для целей ведения журналов и отладки.
Используется для отслеживания процесса подтверждения в рамках нескольких вызовов API.
Ответы
Примите приглашение принять участие в многопартнерском решении в качестве партнера.
Эта конечная точка изменяет статус партнера с NOTIFICATION_SENT на ACCEPTED
это позволит перевести решение в активный статус после того, как все необходимые партнеры дадут свое согласие.
Варианты использования:
Принимайте приглашения к сотрудничеству для разработки многопартнерских решений
Активизировать участие партнеров в существующих решениях
Подтвердите приверженность партнерского приложения условиям использования решения
Обеспечьте переход процесса обработки решения из статуса «ИНИЦИИРОВАНО» в статус «АКТИВНО»
Бизнес-логика:
Только приглашенные партнерские приложения могут принимать приглашения к использованию решений
Для принятия партнерских соглашений решение должно находиться в статусе «Инициировано»
Статус партнера меняется с NOTIFICATION_SENT на ACCEPTED
Решение может стать активным после того, как все необходимые партнеры примут его
Принятие условий создает формальное партнерское соглашение между приложениями
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Проверка:
Приложение-партнер должно получить действительное приглашение к использованию решения
Решение должно существовать и быть доступно для партнерского приложения
Партнерское приложение должно обладать соответствующими разрешениями и возможностями
В запросе на принятие необходимо указать действительный идентификатор партнерского приложения
200
Приглашение к многопартнерскому решению успешно принято. Статус партнера:
Статус обновлен до «ПРИНЯТО», и решение может перейти в статус «АКТИВНО».
Тип содержимого: application/json
Схема: WhatsAppBusinessSolutionAcceptResponse
Показать дочерние атрибуты
WhatsAppBusinessSolutionAcceptResponse
solution_idстрока·обязательный
Идентификатор принятого многопартнерского решения
partner_statusWhatsAppBusinessSolutionPartnerStatus·required
Текущий статус участия партнера в многопартнерском решении
успехлогическое значение·обязательно
Указывает, было ли принятие решения успешным
сообщениястрока
Подтверждающее сообщение, понятное человеку
update_timeстрока (дата-время)
Отметка времени обработки подтверждения
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