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

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

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

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

Версия

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

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

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

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

База

~~URL~~

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

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

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

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

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

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

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

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

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

~~Попробуйте!~~

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

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

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

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

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

~~Агент пользователянить~~

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

~~Авторизациянить~~·~~необходимый~~

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

~~Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"~~·~~необходимый~~

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

~~Путь~~ ~~Параметры~~

~~Версиянить~~·~~необходимый~~

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

~~Номер телефона - IDнить~~·~~необходимый~~

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

~~include_sip_credentialsлогический~~

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

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

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

Схема

Тип

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

~~Ответы~~

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

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

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

~~200~~

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

~~Тип контента:~~ ~~приложение/json~~

~~Схема:~~ ~~PhoneNumberSettingsResponse~~

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

~~PhoneNumberSettingsResponse~~

~~звонокCallingSettingsResponse~~·~~необходимый~~

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~call_icon_visibilityОдин из "видимых", "скрытых"~~·~~необходимый~~

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

~~ip_addressesобъект~~·~~необходимый~~

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

~~по умолчаниюмассив строк~~·~~необходимый~~

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

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

~~по умолчанию[]нить~~

~~callback_permission_statusОдин~~ из

~~"включено", "отключено"~~·~~необходимый~~

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

~~srtp_key_exchange_protocolОдин из проектов: "DTLS-SRTP", "SDES-SRTP"~~

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

~~часы звонковCallHoursSettings~~

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~часовой пояснить~~

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

~~день_начала_неделинить~~

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

~~call_iconsCallIconsSettings~~

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

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

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

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

~~restrict_to_user_countries[]нить~~

~~глотокSipSettingsResponse~~

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~серверымассив SipServerInfo~~

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

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

~~серверы[]SipServerInfo~~

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

~~app_idнить~~·~~необходимый~~

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

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

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

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

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

~~парольнить~~

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

~~видеоVideoSettingsResponse~~

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~аудиоAudioSettingsResponse~~

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

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

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

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

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

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

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

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

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

~~типнить~~

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

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

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

~~шифрование полезной нагрузкиPayloadEncryptionSettingsResponse~~

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~отпечаток_ключа_шифрования_клиентанить~~

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

~~cloud_encryption_keyнить~~

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

~~storage_configurationStorageConfigurationSettingsResponse~~·~~необходимый~~

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

~~статусОдин из вариантов: "default", "in_country_storage_enabled"~~·~~необходимый~~

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

~~data_localization_regionнить~~

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

~~400~~

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

~~Тип контента:~~ ~~приложение/json~~

~~403~~

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

~~Тип контента:~~ ~~приложение/json~~

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

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

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

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

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

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

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

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

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

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

~~ПОЧТА~~ /~~{Версия}~~/~~{Номер-телефона-ID}/настройки~~

~~Попробуйте!~~

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

локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{Phone-Number-ID}/настройки' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "вызов": {
    "статус": "включено",
    "call_icon_visibility": "visible",
    "видео": {
      "статус": "включено"
    }
  }
}'

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

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

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

~~Агент пользователянить~~

~~Авторизациянить~~·~~необходимый~~

~~Content-TypeОдин из "application/json", "application/x-www-form-urlencoded", "multipart/form-data"~~·~~необходимый~~

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

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

~~Версиянить~~·~~необходимый~~

~~Номер телефона - IDнить~~·~~необходимый~~

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

~~Тип контента:~~ ~~приложение/json~~

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

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

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

~~CallingSettingsRequest~~

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

~~звонокНастройки вызовов~~·~~необходимый~~

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~call_icon_visibilityОдин из "видимых", "скрытых"~~

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

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

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~глотокSipSettings~~

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~srtp_key_exchange_protocolОдин из проектов: "DTLS-SRTP", "SDES-SRTP"~~

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

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

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

~~изменение_идентификации_пользователяUserIdentityChangeSettings~~·~~необходимый~~

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

~~включенологический~~·~~необходимый~~

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

~~PayloadEncryptionSettingsRequest~~

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

~~шифрование полезной нагрузкиНастройки шифрования полезной нагрузки~~·~~необходимый~~

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

~~статусОдин из вариантов: "включен", "отключен"~~·~~необходимый~~

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

~~client_encryption_keyнить~~

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

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

~~StorageConfigurationSettingsRequest~~

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

~~storage_configurationНастройки конфигурации хранилища~~·~~необходимый~~

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

~~включенологический~~·~~необходимый~~

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

~~областьнить~~

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

~~Ответы~~

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

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

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

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

~~200~~

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

~~Тип контента:~~ ~~приложение/json~~

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

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

~~успехлогический~~

~~400~~

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

~~Тип контента:~~ ~~приложение/json~~

~~403~~

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

~~Тип контента:~~ ~~приложение/json~~

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

локон--запрос ПОЧТА \
--url'https://graph.facebook.com/{Version}/{Phone-Number-ID}/настройки' \
--заголовок«Авторизация: Предъявитель»<Token> ' \
--заголовок'Content-Type: application/json' \
--данные'{
  "вызов": {
    "статус": "включено",
    "call_icon_visibility": "visible",
    "видео": {
      "статус": "включено"
    }
  }
}'

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

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

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

~~Схема~~	~~Тип~~	~~Расположение~~
~~bearerAuth~~	HTTP Bearer

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

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

bearerAuth:

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

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

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

bearerAuth