Spec-Zone.ru › AWS CLI v2

[ aws . socialmessaging ]

Подключение учётной записи WhatsApp Business

Описание

Используется только через консоль Amazon Web Services во время регистрации для привязки вашей учётной записи WhatsApp Business к вашей учётной записи Amazon Web Services.

См. также: Документацию API AWS

Синтаксис

  associate-whatsapp-business-account
[--signup-callback <value>]
[--setup-finalization <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Параметры

--signup-callback (структура)

Содержит токен доступа к обратной связи.

accessToken -> (строка)

Токен доступа к вашей учётной записи WhatsApp Business. Значение accessToken предоставляется Meta.

Сокращённый синтаксис:

accessToken=string

Синтаксис JSON:

{
  "accessToken": "string"
}

--setup-finalization (структура)

Объект JSON, содержащий номера телефонов и учётную запись WhatsApp Business для привязки к вашей учётной записи.

associateInProgressToken -> (строка)

Токен доступа Amazon Web Services, сгенерированный WhatsAppSignupCallback и используемый WhatsAppSetupFinalization.

phoneNumbers -> (список)

Массив объектов WabaPhoneNumberSetupFinalization, содержащих данные каждого номера телефона, привязанного к учётной записи WhatsApp Business.

(структура)

Данные регистрации привязанного номера телефона.

id -> (строка)

Уникальный идентификатор исходного номера телефона, связанного со средством. Идентификаторы номеров телефонов имеют формат phone-number-id-01234567890123456789012345678901. Используйте GetLinkedWhatsAppBusinessAccount для поиска идентификатора номера телефона.

twoFactorPin -> (строка)

Код PIN для двухфакторной аутентификации. Чтобы сбросить код PIN, следуйте инструкциям в разделе Обновление кода PIN в справочнике WhatsApp Business Platform Cloud API.

dataLocalizationRegion -> (строка)

Двухбуквенный ISO-код региона, где Meta будет хранить данные.

Азиатско-Тихоокеанский регион (АТР)
  • Австралия AU
  • Индонезия ID
  • Индия IN
  • Япония JP
  • Сингапур SG
  • Республика Корея KR
Европа
  • Германия DE
  • Швейцария CH
  • Соединённое Королевство GB
Латинская Америка (ЛА)
  • Бразилия BR
Ближний Восток и Африка (БВА)
  • Бахрейн BH
  • Южная Африка ZA
  • Объединённые Арабские Эмираты AE
Северная Америка (СА)
  • Канада CA

tags -> (список)

Массив пар ключ-значение тегов.

(структура)

Тег ресурса.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

phoneNumberParent -> (строка)

Используется для добавления нового номера телефона к существующей учётной записи WhatsApp Business. Это поле не может быть использовано, когда присутствует поле waba.

waba -> (структура)

Используется для создания новой учётной записи WhatsApp Business и добавления номера телефона. Это поле не может быть использовано, когда присутствует поле phoneNumberParent.

id -> (строка)

Идентификатор привязанной учётной записи WhatsApp Business, отформатированный как waba-01234567890123456789012345678901.

eventDestinations -> (список)

Направления событий для привязанной учётной записи WhatsApp Business.

(структура)

Содержит информацию о направлении события.

eventDestinationArn -> (строка)

ARN направления события.

roleArn -> (строка)

Amazon Resource Name (ARN) имени роли Identity and Access Management, которая может импортировать номера телефонов и записывать события.

tags -> (список)

Массив пар ключ-значение тегов.

(структура)

Тег ресурса.

key -> (строка)

Ключ тега.

value -> (строка)

Значение тега.

Синтаксис JSON:

{
  "associateInProgressToken": "string",
  "phoneNumbers": [
    {
      "id": "string",
      "twoFactorPin": "string",
      "dataLocalizationRegion": "string",
      "tags": [
        {
          "key": "string",
          "value": "string"
        }
        ...
      ]
    }
    ...
  ],
  "phoneNumberParent": "string",
  "waba": {
    "id": "string",
    "eventDestinations": [
      {
        "eventDestinationArn": "string",
        "roleArn": "string"
      }
      ...
    ],
    "tags": [
      {
        "key": "string",
        "value": "string"
      }
      ...
    ]
  }
}

--cli-input-json | --cli-input-yaml (строка) Читает аргументы из предоставленной строки JSON. Строка JSON соответствует формату, предоставленному --generate-cli-skeleton. Если на командной строке указаны другие аргументы, эти значения переопределят значения, предоставленные JSON. Невозможно передать произвольные двоичные значения с помощью предоставленного JSON-значения, поскольку строка будет взята буквально. Это не может быть указано вместе с --cli-input-yaml.

--generate-cli-skeleton (строка) Выводит каркас JSON в стандартный вывод, не отправляя запрос API. Если предоставлено значение без значения или значение input, выводит пример входного JSON, который можно использовать в качестве аргумента для --cli-input-json. Аналогично, если предоставлено yaml-input, он выведет пример входного YAML, который можно использовать с --cli-input-yaml. Если предоставлено значение output, он проверяет входные данные команды и возвращает пример выходного JSON для данной команды. Сгенерированный каркас JSON не стабилен между версиями AWS CLI, и нет гарантий обратной совместимости в сгенерированном каркасе JSON.

Глобальные параметры

--debug (булево)

Включить отладочную запись.

--endpoint-url (строка)

Переопределить URL по умолчанию команды заданным URL.

--no-verify-ssl (булево)

По умолчанию AWS CLI использует SSL при общении с AWS-сервисами. Для каждого SSL-соединения AWS CLI будет проверять сертификаты SSL. Этот параметр переопределяет поведение проверки SSL-сертификатов по умолчанию.

--no-paginate (булево)

Отключить автоматическую постраничность. Если автоматическая постраничность отключена, AWS CLI выполнит только один вызов для первой страницы результатов.

--output (строка)

Стиль форматирования вывода команды.

  • json
  • текст
  • таблица
  • yaml
  • yaml-поток

--query (строка)

Запрос JMESPath для фильтрации данных ответа.

--profile (строка)

Использовать определённый профиль из файла учетных данных.

--region (строка)

Регион для использования. Переопределяет настройки конфигурации/среды.

--version (строка)

Отобразить версию этого инструмента.

--color (строка)

Включить/выключить цветной вывод.

  • вкл
  • выкл
  • авто

--no-sign-request (булево)

Не подписывать запросы. Учетные данные не будут загружены, если этот аргумент предоставлен.

--ca-bundle (строка)

Файл сертификатов CA для проверки SSL-сертификатов. Переопределяет настройки конфигурации/среды.

--cli-read-timeout (целое число)

Максимальное время чтения сокета в секундах. Если значение установлено в 0, чтение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-connect-timeout (целое число)

Максимальное время подключения сокета в секундах. Если значение установлено в 0, подключение сокета будет блокирующим и не будет иметь таймаута. Значение по умолчанию составляет 60 секунд.

--cli-binary-format (строка)

Стиль форматирования для двоичных блоков. Формат по умолчанию - base64. Формат base64 ожидает, что двоичные блоки будут предоставлены как закодированная в base64 строка. Формат raw-in-base64-out сохраняет совместимость с поведением AWS CLI V1, и двоичные значения должны быть переданы буквально. При предоставлении содержимого из файла, отображающего двоичный блок fileb://, всегда будет обрабатываться как двоичный и будет использоваться содержимое файла напрямую независимо от параметра cli-binary-format. При использовании file:// содержимое файла должно быть должным образом отформатировано для конфигурированного параметра cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (булево)

Отключить паджинг CLI для вывода.

--cli-auto-prompt (булево)

Автоматически запрашивать параметры ввода CLI.

--no-cli-auto-prompt (булево)

Отключить автоматическое запроса параметров ввода CLI.

Вывод

signupCallbackResult -> (структура)

Содержит статус вашей регистрации WhatsApp.

associateInProgressToken -> (строка)

Токен доступа Amazon Web Services, сгенерированный WhatsAppSignupCallback и используемый WhatsAppSetupFinalization.

linkedAccountsWithIncompleteSetup -> (карта)

Карта объектов LinkedWhatsAppBusinessAccountIdMetaData, содержащих данные любых учётных записей WhatsApp Business, у которых не завершена настройка.

key -> (строка)

value -> (структура)

Содержит статус вашей регистрации WhatsApp и данные любых не зарегистрированных номеров WhatsApp.

accountName -> (строка)

Название вашей учётной записи.

registrationStatus -> (строка)

Статус регистрации связанной учётной записи WhatsApp Business.

unregisteredWhatsAppPhoneNumbers -> (список)

Данные не зарегистрированных номеров WhatsApp.

(структура)

Данные вашего номера WhatsApp.

arn -> (строка)

ARN номера телефона WhatsApp.

phoneNumber -> (строка)

Номер телефона для отправки сообщений WhatsApp.

phoneNumberId -> (строка)

Идентификатор номера телефона. Идентификаторы номеров телефонов имеют формат phone-number-id-01234567890123456789012345678901.

metaPhoneNumberId -> (строка)

Идентификатор номера телефона от Meta.

displayPhoneNumberName -> (строка)

Используемое для отображения имя этого номера телефона.

displayPhoneNumber -> (строка)

Номер телефона, отображаемый получателю.

qualityRating -> (строка)

Рейтинг качества номера телефона.

wabaId -> (строка)

Amazon Resource Name (ARN) идентификатора учётной записи WhatsApp Business.

statusCode -> (целое число)

Код состояния ответа.

© Copyright 2025, Amazon Web Services. Created using Sphinx.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API