Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

start-outbound-voice-contact

Описание

Выполняет исходящий звонок контакту и затем инициирует поток. Выполняются действия в указанном потоке (в ContactFlowId ).

Агенты не инициируют исходящий API, что означает, что они не набирают номер контакта. Если поток выполняет исходящий звонок контакту и затем помещает контакт в очередь, звонок затем маршрутизируется к агенту, как и в любом другом случае входящего звонка.

Для этой операции установлено время ожидания набора номера в 60 секунд. Если соединение не установлено через 60 секунд, операция завершается с ошибкой.

Примечание

Номера из Великобритании с префиксом 447 по умолчанию запрещены. Перед тем, как набрать эти мобильные номера из Великобритании, необходимо подать запрос на увеличение квоты на услугу. Дополнительную информацию см. в руководстве администратора Amazon Connect — квоты на услуги Amazon Connect.

Примечание

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

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

Синтаксис

  start-outbound-voice-contact
[--name <value>]
[--description <value>]
[--references <value>]
[--related-contact-id <value>]
--destination-phone-number <value>
--contact-flow-id <value>
--instance-id <value>
[--client-token <value>]
[--source-phone-number <value>]
[--queue-id <value>]
[--attributes <value>]
[--answer-machine-detection-config <value>]
[--campaign-id <value>]
[--traffic-type <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]

Параметры

--name (строка)

Имя голосового контакта, отображаемое агенту в панели управления контактами (CCP).

--description (строка)

Описание голосового контакта, отображаемое в снимке агента в журнале CCP. Дополнительную информацию о журналах CCP см. в руководстве администратора Amazon Connect — Загрузка и просмотр журналов CCP.

--references (массив)

Форматированный URL, отображаемый агенту в панели управления контактами (CCP). Контакты могут иметь следующие типы ссылок при создании: URL | NUMBER | STRING | DATE | EMAIL . ATTACHMENT не является поддерживаемым типом ссылки при создании голосового контакта.

ключ -> (строка)

значение -> (структура)

Отформатированные данные о контакте, используемые агентами для завершения запроса на контакт. Общее количество байтов UTF-8 по всем ссылкам контакта может достигать 4096 байт.

Значение -> (строка)

Действительное значение для ссылки. Например, для ссылки на URL, отформатированный URL, отображаемый агенту в панели управления контактами (CCP).

Тип -> (строка)

Тип ссылки. DATE должен быть типа отметки времени эпохи.

Статус -> (строка)

Статус ссылки типа прикрепления.

Arn -> (строка)

Amazon Resource Name (ARN) ссылки.

StatusReason -> (строка)

Подробности о причинах, по которым ссылка не была успешно создана.

Упрощенный синтаксис:

KeyName1=Value=string,Type=string,Status=string,Arn=string,StatusReason=string,KeyName2=Value=string,Type=string,Status=string,Arn=string,StatusReason=string

Синтаксис JSON:

{"string": {
      "Value": "string",
      "Type": "URL"|"ATTACHMENT"|"CONTACT_ANALYSIS"|"NUMBER"|"STRING"|"DATE"|"EMAIL"|"EMAIL_MESSAGE",
      "Status": "AVAILABLE"|"DELETED"|"APPROVED"|"REJECTED"|"PROCESSING"|"FAILED",
      "Arn": "string",
      "StatusReason": "string"
    }
  ...}

--related-contact-id (строка)

contactId, связанный с этим контактом. Связывание голоса, задачи или чата с помощью RelatedContactID копирует атрибуты контакта из связанного контакта в новый контакт. Все обновления пользовательских атрибутов в новом контакте ограничены индивидуальным идентификатором контакта. Ограничений на количество контактов, которые можно связать, используя RelatedContactId, нет.

--destination-phone-number (строка)

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

--contact-flow-id (строка)

Идентификатор потока для исходящего звонка. Чтобы увидеть ContactFlowId на сайте администратора Amazon Connect, в меню навигации перейдите к пункту Маршрутизация , Потоки контактов . Выберите поток. На странице потока, под именем потока, выберите Показать дополнительную информацию о потоке . ContactFlowId — это последняя часть ARN, показанная здесь жирным шрифтом:

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/846ec553-a005-41c0-8341-xxxxxxxxxxxx

--instance-id (строка)

Идентификатор экземпляра Amazon Connect. Идентификатор экземпляра можно найти в Amazon Resource Name (ARN) экземпляра.

--client-token (строка)

Уникальный, чувствительный к регистру идентификатор, который вы предоставляете для обеспечения идемпотентности запроса. Если он не указан, Amazon Web Services SDK заполняет это поле. Дополнительную информацию об идемпотентности см. в статье Обеспечение безопасности повторных попыток с помощью идемпотентных API. Токен действителен в течение 7 дней после создания. Если контакт уже запущен, возвращается идентификатор контакта.

--source-phone-number (строка)

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

--queue-id (строка)

Очередь для звонка. Если вы указываете очередь, отображаемый номер для идентификатора вызывающего абонента — это номер телефона, указанный в очереди. Если вы не указываете очередь, используется очередь, определенная в потоке. Если вы не указываете очередь, необходимо указать исходный номер телефона.

--attributes (массив)

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

Общее количество байтов UTF-8 по всем парам ключ-значение на контакт может достигать 32 768 байт. Имена атрибутов могут содержать только символы латинского алфавита, цифры, дефисы и символы подчеркивания.

ключ -> (строка)

значение -> (строка)

Упрощенный синтаксис:

KeyName1=string,KeyName2=string

Синтаксис JSON:

{"string": "string"
  ...}

--answer-machine-detection-config (структура)

Настройка обнаружения ответа автоответчика для этого исходящего звонка.

EnableAnswerMachineDetection -> (логическое значение)

Флаг, указывающий, необходимо ли выполнять анализ обнаружения ответа автоответчика для голосового звонка. Если установлено значение true, TrafficType должно быть установлено как CAMPAIGN.

AwaitAnswerMachinePrompt -> (логическое значение)

Ожидание ответа автоответчика.

Упрощенный синтаксис:

EnableAnswerMachineDetection=boolean,AwaitAnswerMachinePrompt=boolean

Синтаксис JSON:

{
  "EnableAnswerMachineDetection": true|false,
  "AwaitAnswerMachinePrompt": true|false
}

--campaign-id (строка)

Идентификатор кампании исходящей коммуникации.

--traffic-type (строка)

Определяет класс трафика. Звонки с разными типами трафика обрабатываются Amazon Connect по-разному. Значение по умолчанию — GENERAL. Используйте CAMPAIGN, если EnableAnswerMachineDetection установлено в true. Во всех остальных случаях используйте GENERAL.

Возможные значения:

  • GENERAL
  • CAMPAIGN

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

Вывод

ContactId -> (строка)

Идентификатор этого контакта в экземпляре Amazon Connect.

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

Spec-Zone.ru

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