Spec-Zone.ru › AWS CLI v2

[ aws . connectcampaignsv2 ]

put-outbound-request-batch

Описание

Создаёт исходящие запросы для указанной кампании учётной записи Amazon Connect. Этот API идемпотентен.

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

Синтаксис

  put-outbound-request-batch
--id <value>
--outbound-requests <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]

Параметры

--id (строка)

Идентификатор, представляющий кампанию

--outbound-requests (список)

Список исходящих запросов.

(структура)

Исходящий запрос для кампании.

clientToken -> (строка)

Переданный клиентом параметр, используемый для идемпотентности. Его значение должно быть уникальным для каждого запроса.

expirationTime -> (временная метка)

Временная метка без смещения UTC или часового пояса

channelSubtypeParameters -> (структура помеченного объединения)

ChannelSubtypeParameters для исходящего запроса

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: telephony, sms, email.

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

Параметры для подтипа канала Телефония

destinationPhoneNumber -> (строка)

Номер телефона клиента в формате E.164.

attributes -> (массив)

Пользовательская пара ключ-значение, использующая карту атрибутов. Атрибуты являются стандартными атрибутами Amazon Connect и могут быть доступны в потоках контактов так же, как и любые другие атрибуты контактов.

key -> (строка)

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

value -> (строка)

Значение атрибута.

connectSourcePhoneNumber -> (строка)

Номер телефона, связанный с экземпляром Amazon Connect, в формате E.164. Если вы не укажете номер источника телефона, вы должны указать очередь.

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

Настройка обнаружения голосовых почтовых ящиков

enableAnswerMachineDetection -> (булево)

Включить или отключить обнаружение голосовых почтовых ящиков

awaitAnswerMachinePrompt -> (булево)

Включить или отключить ожидание ответа голосовой почты

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

Параметры для подтипа канала SMS

destinationPhoneNumber -> (строка)

Номер телефона клиента в формате E.164.

connectSourcePhoneNumberArn -> (строка)

Имена ресурсов Amazon (ARN)

templateArn -> (строка)

Имена ресурсов Amazon (ARN)

templateParameters -> (массив)

Пользовательская пара ключ-значение, использующая карту атрибутов. Атрибуты являются стандартными атрибутами Amazon Connect и могут быть доступны в потоках контактов так же, как и любые другие атрибуты контактов.

key -> (строка)

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

value -> (строка)

Значение атрибута.

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

Параметры для подтипа канала Email

destinationEmailAddress -> (строка)

Адрес электронной почты источника/назначения для сообщений электронной почты

connectSourceEmailAddress -> (строка)

Адрес электронной почты источника/назначения для сообщений электронной почты

templateArn -> (строка)

Имена ресурсов Amazon (ARN)

templateParameters -> (массив)

Пользовательская пара ключ-значение, использующая карту атрибутов. Атрибуты являются стандартными атрибутами Amazon Connect и могут быть доступны в потоках контактов так же, как и любые другие атрибуты контактов.

key -> (строка)

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

value -> (строка)

Значение атрибута.

Синтаксис JSON:

[
  {
    "clientToken": "string",
    "expirationTime": timestamp,
    "channelSubtypeParameters": {
      "telephony": {
        "destinationPhoneNumber": "string",
        "attributes": {"string": "string"
          ...},
        "connectSourcePhoneNumber": "string",
        "answerMachineDetectionConfig": {
          "enableAnswerMachineDetection": true|false,
          "awaitAnswerMachinePrompt": true|false
        }
      },
      "sms": {
        "destinationPhoneNumber": "string",
        "connectSourcePhoneNumberArn": "string",
        "templateArn": "string",
        "templateParameters": {"string": "string"
          ...}
      },
      "email": {
        "destinationEmailAddress": "string",
        "connectSourceEmailAddress": "string",
        "templateArn": "string",
        "templateParameters": {"string": "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
  • text
  • table
  • yaml
  • yaml-stream

--query (строка)

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

--profile (строка)

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

--region (строка)

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

--version (строка)

Отображает версию данного инструмента.

--color (строка)

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

  • on
  • off
  • auto

--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.

Вывод

successfulRequests -> (список)

Список успешных запросов, идентифицированных уникальным маркером client token.

(структура)

Успешный запрос, идентифицированный уникальным маркером client token.

clientToken -> (строка)

Переданный клиентом параметр, используемый для идемпотентности. Его значение должно быть уникальным для каждого запроса.

id -> (строка)

Идентификатор, представляющий запрос звонка

failedRequests -> (список)

Список неудачных запросов.

(структура)

Неудачный запрос, идентифицированный уникальным маркером client token.

clientToken -> (строка)

Переданный клиентом параметр, используемый для идемпотентности. Его значение должно быть уникальным для каждого запроса.

id -> (строка)

Идентификатор, представляющий запрос звонка

failureCode -> (строка)

Предопределённый код, указывающий ошибку, которая привела к ошибке.

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

Spec-Zone.ru

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