start-outbound-chat-contact

Описание

Инициирует новый исходящий SMS-контакт с клиентом. Ответ этого API предоставляет ContactId созданного исходящего SMS-контакта.

SourceEndpoint поддерживает только конечные точки с CONNECT_PHONENUMBER_ARN в качестве типа, а DestinationEndpoint поддерживает только конечные точки с TELEPHONE_NUMBER в качестве типа. ContactFlowId инициирует поток для управления созданным новым SMS-контактом.

Этот API можно использовать для инициации исходящих SMS-контактов для агента или для отклонения текущего контакта в исходящий SMS-контакт с помощью действия StartOutboundChatContact Flow.

Для получения дополнительной информации об использовании SMS в Amazon Connect см. следующие разделы в руководстве администратора Amazon Connect:

Настройка SMS-сообщений
Запрос номера телефона с поддержкой SMS через AWS End User Messaging SMS

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

Синтаксис

  start-outbound-chat-contact
--source-endpoint <value>
--destination-endpoint <value>
--instance-id <value>
--segment-attributes <value>
[--attributes <value>]
--contact-flow-id <value>
[--chat-duration-in-minutes <value>]
[--participant-details <value>]
[--initial-system-message <value>]
[--related-contact-id <value>]
[--supported-messaging-content-types <value>]
[--client-token <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]

Параметры

--source-endpoint (структура)

Информация о конечной точке.

Type -> (строка)

Тип конечной точки.

Address -> (строка)

Адрес конечной точки.

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

Type=string,Address=string

Синтаксис JSON:

{
  "Type": "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
  "Address": "string"
}

--destination-endpoint (структура)

Информация о конечной точке.

Type -> (строка)

Тип конечной точки.

Address -> (строка)

Адрес конечной точки.

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

Type=string,Address=string

Синтаксис JSON:

{
  "Type": "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
  "Address": "string"
}

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

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

--segment-attributes (массив)

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

Ключи атрибутов могут содержать только алфавитно-цифровые символы, - и _.
Это поле можно использовать для отображения подтипов каналов, таких как connect:Guide и connect:SMS.

key -> (строка)

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

Значение атрибута сегмента. Оно структурировано как массив, где ключ — valueString, а значение — строка.

ValueString -> (строка)

Значение атрибута сегмента.

ValueMap -> (массив)

Значение атрибута сегмента.

key -> (строка)

( … рекурсивно … )

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

Значение атрибута сегмента.

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

Значение атрибута сегмента.

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

KeyName1=ValueString=string,ValueMap={KeyName1={ValueString=string,( ... recursive ... ),ValueInteger=integer},KeyName2={ValueString=string,( ... recursive ... ),ValueInteger=integer}},ValueInteger=integer,KeyName2=ValueString=string,ValueMap={KeyName1={ValueString=string,( ... recursive ... ),ValueInteger=integer},KeyName2={ValueString=string,( ... recursive ... ),ValueInteger=integer}},ValueInteger=integer

Синтаксис JSON:

{"string": {
      "ValueString": "string",
      "ValueMap": {"string": {
            "ValueString": "string",
            "ValueMap": {"string": { ... recursive ... }
              ...},
            "ValueInteger": integer
          }
        ...},
      "ValueInteger": integer
    }
  ...}

--attributes (массив)

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

key -> (строка)

value -> (строка)

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

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

arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx

--chat-duration-in-minutes (целое число)

Общее время новой сессии чата. Если не указано, продолжительность сессии чата по умолчанию составляет 25 часов. Минимально настраиваемое время — 60 минут. Максимально настраиваемое время — 10 080 минут (7 дней).

--participant-details (структура)

Подробности клиента.

DisplayName -> (строка)

Имя участника для отображения.

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

DisplayName=string

Синтаксис JSON:

{
  "DisplayName": "string"
}

--initial-system-message (структура)

Сообщение чата.

ContentType -> (строка)

Тип содержимого. Поддерживаемые типы — text/plain, text/markdown, application/json и application/vnd.amazonaws.connect.message.interactive.response.

Content -> (строка)

Содержимое сообщения чата.

Для text/plain и text/markdown ограничения по длине составляют от 1 до 1024 символов.
Для application/json ограничения по длине составляют от 1 до 12 000 символов.
Для application/vnd.amazonaws.connect.message.interactive.response ограничения по длине составляют от 1 до 12 288 символов.

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

ContentType=string,Content=string

Синтаксис JSON:

{
  "ContentType": "string",
  "Content": "string"
}

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

Уникальный идентификатор контакта Amazon Connect, связанный с началом контакта.

--supported-messaging-content-types (список)

Поддерживаемые типы содержимого сообщений чата. Поддерживаемые типы:

text/plain
text/markdown
application/json, application/vnd.amazonaws.connect.message.interactive
application/vnd.amazonaws.connect.message.interactive.response

Типы содержимого должны всегда содержать text/plain. Затем можно добавить любые другие поддерживаемые типы в список. Например, все следующие списки допустимы, потому что они содержат text/plain:

[text/plain, text/markdown, application/json]
[text/markdown, text/plain]
[text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]

(строка)

Синтаксис:

"string" "string" ...

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

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

--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 (boolean)

Включить отладку протоколирования.

--endpoint-url (string)

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

--no-verify-ssl (boolean)

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

--no-paginate (boolean)

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

--output (string)

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

json
text
table
yaml
yaml-stream

--query (string)

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

--profile (string)

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

--region (string)

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

--version (string)

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

--color (string)

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

on
off
auto

--no-sign-request (boolean)

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

--ca-bundle (string)

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

--cli-read-timeout (int)

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

--cli-connect-timeout (int)

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

--cli-binary-format (string)

Стиль форматирования для двоичных блоков. Формат по умолчанию — 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 (boolean)

Отключить вывод CLI-страницы.

--cli-auto-prompt (boolean)

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

--no-cli-auto-prompt (boolean)

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

Вывод

ContactId -> (string)

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