WhatsApp Cloud API — API для шифрования бизнес-данных | Документация для разработчиков
WhatsApp Cloud API - Business Encryption API
Экземпляр для программы магистратуры (LLM)
Версия
API для управления настройками шифрования бизнес-аккаунта WhatsApp и управлением открытыми ключами.
Этот интерфейс позволяет компаниям настраивать и управлять шифрованием для своего WhatsApp Business
Обмен сообщениями осуществляется путем загрузки и получения открытых ключей предприятия, используемых для шифрования полезной нагрузки.
GET /{Version}/{Phone-Number-ID}/whatsapp_business_encryption
Получите текущий открытый ключ предприятия и статус проверки его подписи.
Этот конечный пункт возвращает открытый ключ, который в данный момент настроен для шифрования
Содержит данные сообщения и указывает, является ли сохраненная подпись действительной или имеет несоответствие.
Варианты использования:
Проверьте текущую конфигурацию шифрования
Проверить статус подтверждения подписи открытого ключа
Получение открытого ключа для настройки шифрования на стороне клиента
Отслеживайте состояние ключей шифрования для обеспечения соответствия требованиям безопасности
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация об открытом ключе может кэшироваться в течение умеренного времени, но статус подписи может оставаться неизменным
Может меняться, поэтому следует регулярно проверять его на предмет безопасности.
Синтаксис запроса
GET / {Version} / {Phone-Number-ID} /whatsapp_business_encryption
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка идентификатора номера телефона · обязательный
Идентификатор вашего бизнес-телефона в WhatsApp. Этот идентификатор обозначает номер телефона
Этот номер можно получить из списка телефонных номеров вашего бизнес-аккаунта WhatsApp.
Параметры запроса
поля строка
Список полей, разделенных запятыми, которые необходимо включить в ответ. Если не указано иное,
Будут возвращены все доступные поля.
Доступные поля: business_public_key, business_public_key_signature_status
Ответы
Получите текущий открытый ключ предприятия и статус проверки его подписи.
Этот конечный пункт возвращает открытый ключ, который в данный момент настроен для шифрования
Содержит данные сообщения и указывает, является ли сохраненная подпись действительной или имеет несоответствие.
Варианты использования:
Проверьте текущую конфигурацию шифрования
Проверить статус подтверждения подписи открытого ключа
Получение открытого ключа для настройки шифрования на стороне клиента
Отслеживайте состояние ключей шифрования для обеспечения соответствия требованиям безопасности
Ограничение скорости запросов:
Применяются стандартные ограничения скорости запросов к Graph API. Используйте соответствующую логику повторных попыток с экспоненциальной задержкой.
Кэширование:
Информация об открытом ключе может кэшироваться в течение умеренного времени, но статус подписи может оставаться неизменным
Может меняться, поэтому следует регулярно проверять его на предмет безопасности.
200
Информация об открытом ключе шифрования бизнес-процесса успешно получена
Тип содержимого: application/json
Схема: объект
Показать дочерние атрибуты
массив данных
Показать дочерние атрибуты
данные[] WhatsAppBusinessEncryptionInfo
Информация об открытом ключе шифрования для бизнеса и статус его проверки
Показать дочерние атрибуты
строка business_public_key · обязательный
Открытый ключ предприятия, используемый для шифрования содержимого сообщений.
Этот ключ используется для шифрования запросов и ответов по каналу передачи данных.
Показать дочерние атрибуты
business_public_key_signature_status BusinessPublicKeyVerificationStatus · required
Статус проверки подписи открытого ключа предприятия
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
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
POST /{Version}/{Phone-Number-ID}/whatsapp_business_encryption
Загрузите и настройте открытый ключ предприятия для шифрования полезной нагрузки сообщения.
Этот конечный пункт принимает открытый ключ бизнес-логики в формате PEM и выполняет его проверку
и сохраняет его с криптографической подписью для дальнейшего использования в шифровании
Содержимое сообщений и запросы к каналам передачи данных.
Варианты использования:
Первоначальная настройка шифрования для сообщений WhatsApp Business
Обновите существующий открытый ключ для ротации ключей
Включите безопасное шифрование полезной нагрузки для конфиденциальных деловых коммуникаций
Настройте ключи шифрования в соответствии с требованиями соответствия
Основные требования:
Должен быть действительный открытый ключ RSA в формате PEM
Ключ должен соответствовать стандартам безопасности Meta для шифрования
На каждый номер телефона одновременно может быть активен только один открытый ключ
Предыдущие ключи заменяются при загрузке новых
Ограничение скорости запросов:
Действуют стандартные ограничения скорости запросов к Graph API. Загрузка ключей может потребовать дополнительных действий
Ограничение скорости запросов, связанное с безопасностью, для предотвращения злоупотреблений.
Синтаксис запроса
POST / {Version} / {Phone-Number-ID} /whatsapp_business_encryption
Попробуйте!
Выберите язык
Выберите код состояния
Параметры заголовка
Строка User-Agent
Строка пользовательского агента, идентифицирующая клиентское программное обеспечение, выполняющее запрос.
Строка авторизации · обязательный
Токен Bearer для аутентификации API. Это должен быть действительный токен доступа, полученный через соответствующий поток OAuth, или системный пользовательский токен.
Параметры пути
Строка версии · обязательный
Версия Graph API, используемая для этого запроса. Определяет поведение API и доступные функции.
Строка идентификатора номера телефона · обязательный
Идентификатор вашего бизнес-телефона в WhatsApp. Этот идентификатор обозначает номер телефона
Этот номер можно получить из списка телефонных номеров вашего бизнес-аккаунта WhatsApp.
Текст запросаНеобходимый
Тип содержимого: multipart/form-data
Схема: WhatsAppBusinessEncryptionUploadRequest
Показать дочерние атрибуты
WhatsAppBusinessEncryptionUploadRequest
строка business_public_key · обязательный
Для загрузки и подписания необходимо предоставить открытый ключ предприятия в формате PEM.
Это должен быть действительный открытый ключ RSA, который будет использоваться для шифрования полезной нагрузки.
Ответы
Загрузите и настройте открытый ключ предприятия для шифрования полезной нагрузки сообщения.
Этот конечный пункт принимает открытый ключ бизнес-логики в формате PEM и выполняет его проверку
и сохраняет его с криптографической подписью для дальнейшего использования в шифровании
Содержимое сообщений и запросы к каналам передачи данных.
Варианты использования:
Первоначальная настройка шифрования для сообщений WhatsApp Business
Обновите существующий открытый ключ для ротации ключей
Включите безопасное шифрование полезной нагрузки для конфиденциальных деловых коммуникаций
Настройте ключи шифрования в соответствии с требованиями соответствия
Основные требования:
Должен быть действительный открытый ключ RSA в формате PEM
Ключ должен соответствовать стандартам безопасности Meta для шифрования
На каждый номер телефона одновременно может быть активен только один открытый ключ
Предыдущие ключи заменяются при загрузке новых
Ограничение скорости запросов:
Действуют стандартные ограничения скорости запросов к Graph API. Загрузка ключей может потребовать дополнительных действий
Ограничение скорости запросов, связанное с безопасностью, для предотвращения злоупотреблений.
200
Открытый ключ шифрования для бизнеса успешно загружен и настроен
Тип содержимого: application/json
Схема: WhatsAppBusinessEncryptionUploadResponse
Показать дочерние атрибуты
WhatsAppBusinessEncryptionUploadResponse
успех логическое значение · обязательно
Указывает, был ли открытый ключ успешно загружен и подписан
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
Удобное для пользователя сообщение об ошибке для отображения
Выберите язык
Выберите код состояния
Аутентификация
|
Схема |
Тип |
Расположение |
|
bearerAuth |
HTTP Bearer |
Заголовок: Авторизация |
Примеры использования
bearerAuth:
Включите
Authorization: Bearer your-token-here в заголовки запроса.Глобальные требования к аутентификации
Для работы всех конечных точек требуется:
bearerAuth
Комментарии отсутствуют
Комментарии отсутствуют