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

API для отслеживания намерений миграции бизнес-аккаунта WhatsApp

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

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

Версия

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

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

Информация о намерениях по миграции бизнес-аккаунта WhatsApp, включая текущий статус и детали миграции.

База URL

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

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

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

~~/{Version}/{Migration-Intent-ID}~~

GET /{Version}/{Migration-Intent-ID}

Получите исчерпывающую информацию о намерении перенести бизнес-аккаунт WhatsApp

включая информацию о текущем состоянии и миграции.

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

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

Проверьте конфигурацию намерения миграции и текущее состояние

Проверьте ход миграции и статус завершения

Получение сведений о намерениях миграции для бизнес-процессов

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

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

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

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

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

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

GET / {Version} / {Migration-Intent-ID}

Попробуйте!

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

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

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

{
"инициированная_миграция": {
"краткое содержание": "Инициировано намерение миграции",
"ценить": {
"идентификатор": "1234567890123456",
«статус»: "Инициировано"
    }
  },
"accepted_migration": {
"краткое содержание": «Принятое намерение о миграции»,
"ценить": {
"идентификатор": "2345678901234567",
«статус»: "ПРИНЯЛ"
    }
  },
"completed_migration": {
"краткое содержание": "Завершено намерение о миграции",
"ценить": {
"идентификатор": "3456789012345678",
«статус»: "ЗАВЕРШЕННЫЙ"
    }
  }
}

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

Строка User-Agent

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

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

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

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

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

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

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

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

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

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

поля строка

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

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

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

Ответы

Получите исчерпывающую информацию о намерении перенести бизнес-аккаунт WhatsApp

включая информацию о текущем состоянии и миграции.

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

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

Проверьте конфигурацию намерения миграции и текущее состояние

Проверьте ход миграции и статус завершения

Получение сведений о намерениях миграции для бизнес-процессов

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

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

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

200

Получены подробные сведения о намерениях миграции

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

Схема: WhatsAppBusinessAccountMigrationIntent

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

WhatsAppBusinessAccountMigrationIntent

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

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

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

Текущий статус намерения о миграции аккаунта WhatsApp Business

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

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

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

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

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

{
"инициированная_миграция": {
"краткое содержание": "Инициировано намерение миграции",
"ценить": {
"идентификатор": "1234567890123456",
«статус»: "Инициировано"
    }
  },
"accepted_migration": {
"краткое содержание": «Принятое намерение о миграции»,
"ценить": {
"идентификатор": "2345678901234567",
«статус»: "ПРИНЯЛ"
    }
  },
"completed_migration": {
"краткое содержание": "Завершено намерение о миграции",
"ценить": {
"идентификатор": "3456789012345678",
«статус»: "ЗАВЕРШЕННЫЙ"
    }
  }
}

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

Схема

Тип

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

bearerAuth

HTTP Bearer

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

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

bearerAuth:

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

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

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

bearerAuth