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

WhatsApp Cloud API - API настроек

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

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

Версия

API настроек позволяет настраивать различные функции и параметры

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

настройки, настройки изменения личности пользователя, шифрование полезной нагрузки и данные

конфигурации хранилища.

Базовый URL

https://graph.facebook.com

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

ПОЛУЧАТЬ	/{Версия}/{Идентификатор-номера-телефона}/настройки
ПОЧТА	/{Версия}/{Идентификатор-номера-телефона}/настройки

GET /{Version}/{Phone-Number-ID}/settings

Получить текущие настройки номера телефона для WhatsApp Business.

Возвращает параметры вызова, параметры шифрования полезной нагрузки и данные

конфигурации хранилища.

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

GET / {Version} / {Phone-Number-ID} /settings

Попробуйте!

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

curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/settings ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{}'

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

{
 "Ответ основных настроек"
 : { "значение"
 : { "вызов"
 : { "статус"
 : "включено" , "видимость значка вызова"
 : "видимый" , "ip_адреса"
 : { "по умолчанию"
 : [ "157.240.0.1"
 , "157.240.0.2"
 ]
 },
 "статус разрешения обратного вызова"
 : "включено" , "видео"
 : { "статус"
 : "включено" }
 },
 "шифрование полезной нагрузки"
 : { "статус"
 : "отключено" },
 "конфигурация хранилища"
 : { "статус"
 : "по умолчанию" }
 }
 },
 "Настройки с SIP и шифрованием"
 : { "значение"
 : { "вызов"
 : { "статус"
 : "включено" , "call_icon_visibility"
 : "visible" , "ip_addresses"
 : { "default"
 : [ "157.240.0.1"
 , "157.240.0.2"
 ]
 },
 "callback_permission_status"
 : "enabled" , "srtp_key_exchange_protocol"
 : "DTLS-SRTP" , "sip"
 : { "status"
 : "enabled" , "servers"
 : [ {
 "app_id"
 : "12345" , "hostname"
 : "sip.whatsapp.com" , "port"
 : 5060 }
 ]
 },
 "video"
 : { "status"
 : "enabled" }
 },
 "payload_encryption"
 : { "status"
 : "enabled" , "client_encryption_key_fingerprint"
 : "SHA256:abcd1234..." , "cloud_encryption_key"
 : "eyJhbGc..." },
 "storage_configuration"
 : { "status"
 : "in_country_storage_enabled" , "data_localization_region"
 : "us" }
 }
 }
 }

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

Строка User-Agent

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

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

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

Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required

Тип носителя информации в теле запроса

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

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

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

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

include_sip_credentials boolean

Включите учетные данные SIP в ответ (требуются дополнительные разрешения)

Ответы

Получить текущие настройки номера телефона для WhatsApp Business.

Возвращает параметры вызова, параметры шифрования полезной нагрузки и данные

конфигурации хранилища.

200

Текущие настройки номера телефона успешно получены

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

Схема: PhoneNumberSettingsResponse

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

PhoneNumberSettingsResponse

вызов CallingSettingsResponse · обязательный

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

статус Один из "включено", "выключено" · требуется

Текущее состояние функции вызова

call_icon_visibility Один из значений "visible", "hidden" · обязательный

Текущая настройка видимости значка вызова

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

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

массив строк по умолчанию · обязательный

IP-адреса по умолчанию для звонков

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

строка по умолчанию[]

callback_permission_status Один из значений "enabled", "disabled" · required

статус разрешения обратного вызова

srtp_key_exchange_protocol Один из протоколов "DTLS-SRTP" и "SDES-SRTP"

Протокол обмена ключами SRTP (необязательно)

call_hours CallHoursSettings

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

статус Один из "включено", "выключено" · требуется

статус функции «Часы звонков»

строка часового пояса

Часовой пояс для часов дежурства

строка начала дня недели

Начальный день недели

call_icons CallIconsSettings

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

restrict_to_user_countries массив строк

Список стран, где значки вызовов ограничены

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

restrict_to_user_countries[] string

sip SipSettingsResponse

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

статус Один из "включено", "выключено" · требуется

статус вызова SIP

серверов SipServerInfo

конфигурация SIP-сервера

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

серверы[] SipServerInfo

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

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

Идентификатор приложения для SIP-сервера

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

имя хоста SIP-сервера

порт целое число

Порт SIP-сервера (необязательно)

строка пароля

Пароль SIP (указывается только при include_sip_credentials=true)

видео VideoSettingsResponse

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

статус Один из "включено", "выключено" · требуется

статус видеозвонка

аудио AudioSettingsResponse

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

статус Один из "включено", "выключено"

статус аудиозвонка

ограничения CallingRestrictionsResponse

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

ограничения массив объектов

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

ограничения[] объект

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

тип строка

Тип ограничения

истечение срока действия целое число (int64)

Отметка времени истечения срока действия ограничения

payload_encryption PayloadEncryptionSettingsResponse

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

статус Один из "включено", "выключено" · требуется

статус шифрования полезной нагрузки

client_encryption_key_fingerprint string

Отпечаток ключа шифрования клиента (при включенном шифровании)

строка cloud_encryption_key

Ключ облачного шифрования (при включенном шифровании)

storage_configuration StorageConfigurationSettingsResponse · required

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

статус Один из "default", "in_country_storage_enabled" · обязательный

Состояние конфигурации хранилища данных

data_localization_region string

Регион локализации данных (при включенной возможности хранения данных внутри страны)

400

Неверный запрос - Недопустимые параметры запроса

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

403

Запрещено — Шаблон не одобрен или имеются недостаточные права доступа

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

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

curl
 --request GET \ --url
 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/settings ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{}'

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

{
 "Ответ основных настроек"
 : { "значение"
 : { "вызов"
 : { "статус"
 : "включено" , "видимость значка вызова"
 : "видимый" , "ip_адреса"
 : { "по умолчанию"
 : [ "157.240.0.1"
 , "157.240.0.2"
 ]
 },
 "статус разрешения обратного вызова"
 : "включено" , "видео"
 : { "статус"
 : "включено" }
 },
 "шифрование полезной нагрузки"
 : { "статус"
 : "отключено" },
 "конфигурация хранилища"
 : { "статус"
 : "по умолчанию" }
 }
 },
 "Настройки с SIP и шифрованием"
 : { "значение"
 : { "вызов"
 : { "статус"
 : "включено" , "call_icon_visibility"
 : "visible" , "ip_addresses"
 : { "default"
 : [ "157.240.0.1"
 , "157.240.0.2"
 ]
 },
 "callback_permission_status"
 : "enabled" , "srtp_key_exchange_protocol"
 : "DTLS-SRTP" , "sip"
 : { "status"
 : "enabled" , "servers"
 : [ {
 "app_id"
 : "12345" , "hostname"
 : "sip.whatsapp.com" , "port"
 : 5060 }
 ]
 },
 "video"
 : { "status"
 : "enabled" }
 },
 "payload_encryption"
 : { "status"
 : "enabled" , "client_encryption_key_fingerprint"
 : "SHA256:abcd1234..." , "cloud_encryption_key"
 : "eyJhbGc..." },
 "storage_configuration"
 : { "status"
 : "in_country_storage_enabled" , "data_localization_region"
 : "us" }
 }
 }
 }

POST /{Version}/{Phone-Number-ID}/settings

Обновите различные настройки для номера телефона WhatsApp Business.

Вы можете настроить параметры вызовов, параметры изменения идентификации пользователя

Шифрование полезной нагрузки и конфигурации хранения данных.

В одном запросе можно указать только один параметр функции.

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

POST / {Version} / {Phone-Number-ID} /settings

Попробуйте!

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

curl
 --request POST \ --url
 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/settings ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{ "calling": {
 "status": "enabled",
 "call_icon_visibility": "visible",
 "video": {
 "status": "enabled"
 }
 }
 }'

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

{
 "Настройки успешно обновлены"
 : { "значение"
 : { "успех"
 : true }
 }
 }

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

Строка User-Agent

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

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

Content-Type — один из следующих типов данных: "application/json", "application/x-www-form-urlencoded", "multipart/form-data" · required

Тип носителя информации в теле запроса

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

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

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

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

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

Схема: Должна быть одной из следующих: CallingSettingsRequest, UserIdentityChangeSettingsRequest, PayloadEncryptionSettingsRequest, StorageConfigurationSettingsRequest

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

Должно быть одно из следующих значений: CallingSettingsRequest, UserIdentityChangeSettingsRequest, PayloadEncryptionSettingsRequest, StorageConfigurationSettingsRequest

CallingSettingsRequest

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

callingSettings · required

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

статус Один из "включено", "выключено" · требуется

Включить или отключить функцию звонков

call_icon_visibility Один из значений "visible", "hidden"

Управление видимостью значка вызова

видео Настройки

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

статус Один из "включено", "выключено" · требуется

Включить или отключить видеозвонки

sip SipSettings

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

статус Один из "включено", "выключено" · требуется

Включение или отключение SIP-звонков

srtp_key_exchange_protocol Один из протоколов "DTLS-SRTP" и "SDES-SRTP"

протокол обмена ключами SRTP

Запрос на изменение идентификационных данных пользователя

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

user_identity_change UserIdentityChangeSettings · required

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

включено логическое значение · обязательно

Включить или отключить уведомления об изменении идентификационных данных пользователя

PayloadEncryptionSettingsRequest

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

payload_encryption PayloadEncryptionSettings · required

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

статус Один из "включено", "выключено" · требуется

Включить или отключить шифрование полезной нагрузки

client_encryption_key string

Открытый ключ, закодированный в Base64, для шифрования полезной нагрузки

(необходимо при включении шифрования)

StorageConfigurationSettingsRequest

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

storage_configuration StorageConfigurationSettings · required

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

включено логическое значение · обязательно

Включение или отключение пользовательской конфигурации хранилища

строка региона

область хранения данных

Ответы

Обновите различные настройки для номера телефона WhatsApp Business.

Вы можете настроить параметры вызовов, параметры изменения идентификации пользователя

Шифрование полезной нагрузки и конфигурации хранения данных.

В одном запросе можно указать только один параметр функции.

200

Настройки успешно обновлены

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

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

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

успех логическое значение

400

Неверный запрос - Недопустимые параметры запроса

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

403

Запрещено — Шаблон не одобрен или имеются недостаточные права доступа

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

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

curl
 --request POST \ --url
 'https://graph.facebook.com/{Version}/{Phone-Number-ID}/settings ' \ --header
 'Authorization: Bearer' ' \ --header
 'Content-Type: application/json' \ --data
 '{ "calling": {
 "status": "enabled",
 "call_icon_visibility": "visible",
 "video": {
 "status": "enabled"
 }
 }
 }'

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

{
 "Настройки успешно обновлены"
 : { "значение"
 : { "успех"
 : true }
 }
 }

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

Схема	Тип	Расположение
bearerAuth	HTTP Bearer	Заголовок: `Авторизация`

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

bearerAuth:

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

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

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

bearerAuth