API-интерфейс для создания бизнес-аккаунтов WhatsApp | Документация для разработчиков

Список решений для бизнес-аккаунтов WhatsApp с помощью API

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

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

Версия

API для получения информации о многопартнерских решениях, связанных с бизнес-аккаунтом WhatsApp (WABA).

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

которые связаны с конкретным бизнес-аккаунтом WhatsApp.

База URL

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

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

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

~~/{Version}/{WABA-ID}/solutions~~

GET /{Version}/{WABA-ID}/solutions

Получить постраничный список многопартнерских решений, связанных с указанным объектом

Бизнес-аккаунт WhatsApp. Данная конечная точка поддерживает выбор полей и выбор с помощью курсора

Пагинация для эффективного поиска данных.

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

Ознакомьтесь с доступными многопартнерскими решениями для адаптации новых клиентов

Отслеживайте состояние и доступность решения в рамках вашей системы WABA

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

Фильтрация решений по определенным полям или требованиям к статусу

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

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

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

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

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

Пагинация:

Этот конечный пункт поддерживает постраничную навигацию с использованием курсора, применяя параметры limit , after и before.

параметры. Используйте пагинации в ответах для навигации по наборам результатов.

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

GET / {Version} / {WABA-ID} /solutions

Попробуйте!

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

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

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

{
"multiple_solutions": {
"краткое содержание": "Множество решений с различными статусами",
"ценить": {
"данные": [
        {
"идентификатор": "1234567890123456",
"имя": «Решение для интеграции электронной коммерции»,
«статус»: "АКТИВНЫЙ",
"status_for_pending_request": "НИКТО",
"owner_app": {
"идентификатор": "9876543210987654",
"имя": «Приложение для партнеров по решениям»
          },
"owner_permissions": [
"УПРАВЛЯТЬ",
"РАЗВИВАТЬ",
"УПРАВЛЕНИЕ ШАБЛОНАМИ",
"VIEW_INSIGHTS"
          ]
        },
        {
"идентификатор": "2345678901234567",
"имя": «Решение для поддержки клиентов»,
«статус»: "ЧЕРНОВИК",
"status_for_pending_request": "НИКТО"
        }
      ],
"пейджинг": {
"курсоры": {
"до": "FAKE_CURSOR_BEFORE_123ABC",
"после": "FAKE_CURSOR_AFTER_456DEF"
        },
"следующий": "https://graph.facebook.com/v23.0/1234567890123456/solutions?limit=25&after=FAKE_CURSOR_AFTER_456DEF"
      }
    }
  },
"single_solution": {
"краткое содержание": «Единое решение с минимальным количеством полей»,
"ценить": {
"данные": [
        {
"идентификатор": "3456789012345678",
"имя": «Решение для интеграции аналитических систем»,
«статус»: "АКТИВНЫЙ",
"status_for_pending_request": "НИКТО"
        }
      ],
"пейджинг": {
"курсоры": {
"до": "FAKE_CURSOR_BEFORE_789GHI",
"после": "FAKE_CURSOR_AFTER_789GHI"
        }
      }
    }
  },
"пустой_список": {
"краткое содержание": "Решения для этого файла WABA не найдены",
"ценить": {
"данные": [],
"пейджинг": {
"курсоры": {}
      }
    }
  }
}

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

Строка User-Agent

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

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

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

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

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

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

Строка WABA-ID · обязательный

Идентификатор бизнес-аккаунта WhatsApp, по которому можно получить доступ к связанным многопартнерским решениям.

Этот идентификатор можно найти в вашем WhatsApp Business Manager или через API управления WABA.

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

поля строка

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

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

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

limit integer [min: 1, max: 100]

Максимальное количество решений, отображаемых на одной странице. По умолчанию — 25, максимум — 100.

после строки

Курсор для постраничной навигации. Возвращает решения, расположенные после этой позиции курсора.

paging.cursors.after предыдущего ответа .

перед строкой

Курсор для постраничной навигации. Возвращает решения, расположенные перед этой позицией курсора.

paging.cursors.before предыдущего ответа .

Ответы

Получить постраничный список многопартнерских решений, связанных с указанным объектом

Бизнес-аккаунт WhatsApp. Данная конечная точка поддерживает выбор полей и выбор с помощью курсора

Пагинация для эффективного поиска данных.

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

Ознакомьтесь с доступными многопартнерскими решениями для адаптации новых клиентов

Отслеживайте состояние и доступность решения в рамках вашей системы WABA

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

Фильтрация решений по определенным полям или требованиям к статусу

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

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

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

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

Пагинация:

параметры. Используйте пагинации в ответах для навигации по наборам результатов.

200

Список многопартнерских решений успешно получен

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

Схема: SolutionsList

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

SolutionsList

массив данных · обязательный

Множество многосторонних партнерских решений, связанных с WABA

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

данные[] WhatsAppBusinessSolution

Подробности и конфигурация многопартнерского решения

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

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

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

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

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

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

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

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

status_for_pending_request WhatsAppBusinessSolutionPendingStatus · required

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

owner_app ApplicationNode

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

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

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

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

строка имени

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

массив owner_permissions

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

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

owner_permissions[] WhatsAppBusinessAccountPermissionTask

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

пейджинг

Информация о постраничной навигации для навигации с помощью курсора

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

объект курсоров

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

перед строкой

Курсор, указывающий на начало страницы с возвращенными данными

после строки

Курсор, указывающий на конец страницы с возвращенными данными

предыдущая строка

URL-адрес конечной точки Graph API для предыдущей страницы данных

следующая строка

URL-адрес конечной точки Graph API для следующей страницы данных

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

Не найдено — идентификатор WABA не существует или недоступен

Тип содержимого: 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

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

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

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

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

{
"multiple_solutions": {
"краткое содержание": "Множество решений с различными статусами",
"ценить": {
"данные": [
        {
"идентификатор": "1234567890123456",
"имя": «Решение для интеграции электронной коммерции»,
«статус»: "АКТИВНЫЙ",
"status_for_pending_request": "НИКТО",
"owner_app": {
"идентификатор": "9876543210987654",
"имя": «Приложение для партнеров по решениям»
          },
"owner_permissions": [
"УПРАВЛЯТЬ",
"РАЗВИВАТЬ",
"УПРАВЛЕНИЕ ШАБЛОНАМИ",
"VIEW_INSIGHTS"
          ]
        },
        {
"идентификатор": "2345678901234567",
"имя": «Решение для поддержки клиентов»,
«статус»: "ЧЕРНОВИК",
"status_for_pending_request": "НИКТО"
        }
      ],
"пейджинг": {
"курсоры": {
"до": "FAKE_CURSOR_BEFORE_123ABC",
"после": "FAKE_CURSOR_AFTER_456DEF"
        },
"следующий": "https://graph.facebook.com/v23.0/1234567890123456/solutions?limit=25&after=FAKE_CURSOR_AFTER_456DEF"
      }
    }
  },
"single_solution": {
"краткое содержание": «Единое решение с минимальным количеством полей»,
"ценить": {
"данные": [
        {
"идентификатор": "3456789012345678",
"имя": «Решение для интеграции аналитических систем»,
«статус»: "АКТИВНЫЙ",
"status_for_pending_request": "НИКТО"
        }
      ],
"пейджинг": {
"курсоры": {
"до": "FAKE_CURSOR_BEFORE_789GHI",
"после": "FAKE_CURSOR_AFTER_789GHI"
        }
      }
    }
  },
"пустой_список": {
"краткое содержание": "Решения для этого файла WABA не найдены",
"ценить": {
"данные": [],
"пейджинг": {
"курсоры": {}
      }
    }
  }
}

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

Схема

Тип

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

bearerAuth

HTTP Bearer

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

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

bearerAuth:

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

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

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

bearerAuth