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--requestGET \
--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"·обязательный

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

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

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

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

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

include_sip_credentialsboolean

Включите учетные данные 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_hoursCallHoursSettings

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

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

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

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

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

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

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

call_iconsCallIconsSettings

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

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

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

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

restrict_to_user_countries[]string

sipSipSettingsResponse

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

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

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

серверовSipServerInfo

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

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

серверы[]SipServerInfo

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

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

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

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

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

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

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

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

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

видеоVideoSettingsResponse

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

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

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

аудиоAudioSettingsResponse

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

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

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

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

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

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

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

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

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

типстрока

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

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

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

payload_encryptionPayloadEncryptionSettingsResponse

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

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

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

client_encryption_key_fingerprintstring

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

cloud_encryption_keyстрока

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

storage_configurationStorageConfigurationSettingsResponse·required

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

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

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

data_localization_regionstring

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

400

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

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

403

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

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

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

curl--requestGET \
--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"·обязательный

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

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

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

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

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

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

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

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

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

CallingSettingsRequest

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

callingSettings·required

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

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

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

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

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

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

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

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

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

sipSipSettings

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

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

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

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

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

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

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

user_identity_changeUserIdentityChangeSettings·required

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

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

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

PayloadEncryptionSettingsRequest

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

payload_encryptionPayloadEncryptionSettings·required

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

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

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

client_encryption_keystring

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

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

StorageConfigurationSettingsRequest

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

storage_configurationStorageConfigurationSettings·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