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

Многопартнерские решения WhatsApp Business — API для приема запросов на деактивацию

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

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

Версия

API для приема запросов на деактивацию многопартнерских решений WhatsApp Business.

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

Решения для работы с несколькими партнерами.

База URL

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

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

~~ПОЧТА~~

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

POST /{Version}/{Solution-ID}/accept_deactivation_request

Принимает ожидающий запрос на деактивацию решения WhatsApp Business Multi-Partner Solution.

Этот конечный пункт завершает процесс утверждения партнера, принимая запрос на деактивацию

Эта инициатива ранее была предложена другим партнером по решениям. После успешного принятия,

Статус решения меняется с АКТИВНОГО на ДЕАКТИВИРОВАННЫЙ, и ожидающий запрос также отображается

Статус изменяется с PENDING_DEACTIVATION на NONE.

Важная бизнес-логика:

Решение должно находиться в статусе ACTIVE со статусом PENDING_DEACTIVATION

Все непогашенные платежи и счета должны быть оплачены до принятия товара

Активные маркетинговые кампании должны быть завершены или переданы

После завершения процесса всем партнерам по решению будут отправлены уведомления через веб-перехватчик

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

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

POST /{Version}/{Solution-ID}/accept_deactivation_request

Попробуйте!

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

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

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

{
"идентификатор": "12345678901234567",
"имя": «Пример партнерства в сфере бизнес-решений»,
«статус»: "ДЕАКТИВИРОВАНО",
"status_for_pending_request": "НИКТО",
"owner_permissions": [
"УПРАВЛЯТЬ",
"РАЗВИВАТЬ"
  ]
}

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

User-AgentСтрока

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

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

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

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

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

Версия Graph API

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

Уникальный идентификатор для решения WhatsApp Business

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

полястрока

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

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

Поля по умолчанию: имя, статус, статус_для_ожидающего_запроса

Текст запросаНеобязательный

Пустое тело запроса — для этой конечной точки параметры не требуются

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

Схема: объект

Ответы

Принимает ожидающий запрос на деактивацию решения WhatsApp Business Multi-Partner Solution.

Этот конечный пункт завершает процесс утверждения партнера, принимая запрос на деактивацию

Эта инициатива ранее была предложена другим партнером по решениям. После успешного принятия,

Статус решения меняется с АКТИВНОГО на ДЕАКТИВИРОВАННЫЙ, и ожидающий запрос также отображается

Статус изменяется с PENDING_DEACTIVATION на NONE.

Важная бизнес-логика:

Решение должно находиться в статусе ACTIVE со статусом PENDING_DEACTIVATION

Все непогашенные платежи и счета должны быть оплачены до принятия товара

Активные маркетинговые кампании должны быть завершены или переданы

После завершения процесса всем партнерам по решению будут отправлены уведомления через веб-перехватчик

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

200

Запрос на деактивацию успешно принят. Статус решения обновлен до «ДЕАКТИВИРОВАНО».

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

Схема: WhatsAppBusinessSolution

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

WhatsAppBusinessSolution

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

Уникальный идентификатор для решения WhatsApp Business

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

Удобочитаемое название решения (текст пользовательского контента, 2-75 символов)

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

Текущее состояние решения WhatsApp Business

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

status_for_pending_requestWhatsAppBusinessSolutionPendingStatus·required

Статус всех ожидающих запросов на решение

owner_permissionsмассив

Массив разрешений, предоставленных владельцу решения

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

owner_permissions[]WhatsAppBusinessAccountPermissionTask

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

400

Неверный запрос — недопустимые параметры запроса или некорректный формат идентификатора решения.

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

Schema: GraphAPIError

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

GraphAPIError

ошибкиобъект·обязательный

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

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

Удобочитаемое сообщение об ошибке

Тип:Один из "OAuthException", "GraphMethodException", "GraphAPIException"·обязательный

Классификация типов ошибок

кодцелое число·обязательный

Числовой код ошибки

error_subcodeinteger

Более конкретный подкод ошибки

fbtrace_idстрока

Внутренний идентификатор трассировки для отладки

is_transientлогическое значение

Возможно ли устранить эту ошибку повторной попыткой?

error_user_titleстрока

Удобный для пользователя заголовок ошибки

error_user_msgстрока

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

401

Несанкционированный доступ — недействительный, отсутствующий или просроченный токен доступа.

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

Schema: GraphAPIError

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

GraphAPIError

ошибкиобъект·обязательный

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

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

Удобочитаемое сообщение об ошибке

Тип:Один из "OAuthException", "GraphMethodException", "GraphAPIException"·обязательный

Классификация типов ошибок

кодцелое число·обязательный

Числовой код ошибки

error_subcodeinteger

Более конкретный подкод ошибки

fbtrace_idстрока

Внутренний идентификатор трассировки для отладки

is_transientлогическое значение

Возможно ли устранить эту ошибку повторной попыткой?

error_user_titleстрока

Удобный для пользователя заголовок ошибки

error_user_msgстрока

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

403

Запрещено — Недостаточно прав доступа или приложение не авторизовано для данного решения.

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

Schema: GraphAPIError

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

GraphAPIError

ошибкиобъект·обязательный

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

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

Удобочитаемое сообщение об ошибке

Тип:Один из "OAuthException", "GraphMethodException", "GraphAPIException"·обязательный

Классификация типов ошибок

кодцелое число·обязательный

Числовой код ошибки

error_subcodeinteger

Более конкретный подкод ошибки

fbtrace_idстрока

Внутренний идентификатор трассировки для отладки

is_transientлогическое значение

Возможно ли устранить эту ошибку повторной попыткой?

error_user_titleстрока

Удобный для пользователя заголовок ошибки

error_user_msgстрока

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

404

Решение не найдено — идентификатор решения не существует или недоступен для запрашивающего приложения.

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

Schema: GraphAPIError

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

GraphAPIError

ошибкиобъект·обязательный

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

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

Удобочитаемое сообщение об ошибке

Тип:Один из "OAuthException", "GraphMethodException", "GraphAPIException"·обязательный

Классификация типов ошибок

кодцелое число·обязательный

Числовой код ошибки

error_subcodeinteger

Более конкретный подкод ошибки

fbtrace_idстрока

Внутренний идентификатор трассировки для отладки

is_transientлогическое значение

Возможно ли устранить эту ошибку повторной попыткой?

error_user_titleстрока

Удобный для пользователя заголовок ошибки

error_user_msgстрока

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

422

Необрабатываемая сущность — допустимые параметры, но бизнес-логика препятствует обработке (например, неправильное состояние решения, непогашенные платежи).

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

Schema: GraphAPIError

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

GraphAPIError

ошибкиобъект·обязательный

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

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

Удобочитаемое сообщение об ошибке

Тип:Один из "OAuthException", "GraphMethodException", "GraphAPIException"·обязательный

Классификация типов ошибок

кодцелое число·обязательный

Числовой код ошибки

error_subcodeinteger

Более конкретный подкод ошибки

fbtrace_idстрока

Внутренний идентификатор трассировки для отладки

is_transientлогическое значение

Возможно ли устранить эту ошибку повторной попыткой?

error_user_titleстрока

Удобный для пользователя заголовок ошибки

error_user_msgстрока

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

429

Слишком много запросов — превышен лимит запросов. Используйте экспоненциальную задержку для повторных попыток.

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

Schema: GraphAPIError

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

GraphAPIError

ошибкиобъект·обязательный

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

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

Удобочитаемое сообщение об ошибке

Тип:Один из "OAuthException", "GraphMethodException", "GraphAPIException"·обязательный

Классификация типов ошибок

кодцелое число·обязательный

Числовой код ошибки

error_subcodeinteger

Более конкретный подкод ошибки

fbtrace_idстрока

Внутренний идентификатор трассировки для отладки

is_transientлогическое значение

Возможно ли устранить эту ошибку повторной попыткой?

error_user_titleстрока

Удобный для пользователя заголовок ошибки

error_user_msgстрока

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

500

Внутренняя ошибка сервера — Неожиданная ошибка сервера. Повторите попытку с экспоненциальной задержкой, если is_transient имеет значение true.

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

Schema: GraphAPIError

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

GraphAPIError

ошибкиобъект·обязательный

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

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

Удобочитаемое сообщение об ошибке

Тип:Один из "OAuthException", "GraphMethodException", "GraphAPIException"·обязательный

Классификация типов ошибок

кодцелое число·обязательный

Числовой код ошибки

error_subcodeinteger

Более конкретный подкод ошибки

fbtrace_idстрока

Внутренний идентификатор трассировки для отладки

is_transientлогическое значение

Возможно ли устранить эту ошибку повторной попыткой?

error_user_titleстрока

Удобный для пользователя заголовок ошибки

error_user_msgстрока

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

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

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

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

{
"идентификатор": "12345678901234567",
"имя": «Пример партнерства в сфере бизнес-решений»,
«статус»: "ДЕАКТИВИРОВАНО",
"status_for_pending_request": "НИКТО",
"owner_permissions": [
"УПРАВЛЯТЬ",
"РАЗВИВАТЬ"
  ]
}

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

Схема

Тип

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

bearerAuth

HTTP Bearer

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

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

bearerAuth:

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

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

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

bearerAuth