Spec-Zone.ru › AWS CLI v2

[ aws . connect ]

create-contact

Описание

Предупреждение

Поддерживаются только каналы EMAIL и VOICE. Поддерживаемые методы инициирования для EMAIL: OUTBOUND, AGENT_REPLY и FLOW. Для VOICE поддерживаются TRANSFER и подтип connect:ExternalAudio.

Создаёт новый контакт EMAIL или VOICE.

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

Синтаксис

  create-contact
--instance-id <value>
[--client-token <value>]
[--related-contact-id <value>]
[--attributes <value>]
[--references <value>]
--channel <value>
--initiation-method <value>
[--expiry-duration-in-minutes <value>]
[--user-info <value>]
[--initiate-as <value>]
[--name <value>]
[--description <value>]
[--segment-attributes <value>]
[--previous-contact-id <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]

Параметры

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

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

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

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

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

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

--attributes (карта)

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

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

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

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

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

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

--references (карта)

Отформатированный URL-адрес, отображаемый агенту в Панели управления контактами (CCP). Задачи могут иметь следующие типы ссылок при создании: URL | ЧИСЛО | СТРОКА | ДАТА | ЭЛЕКТРОННАЯ ПОЧТА | ВЛОЖЕННЫЙ ФАЙЛ.

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

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

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

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

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

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

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

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

Статус ссылки типа вложенного файла.

Arn -> (строка)

Идентификатор Amazon Resource Name (ARN) ссылки

ПричинаСтатуса -> (строка)

Подробная информация о причинах неудачного создания ссылки.

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

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

--channel (строка)

Канал контакта

Предупреждение

CreateContact поддерживает только каналы EMAIL и VOICE. Следующая информация, которая утверждает поддержку других каналов, неверна. Мы работаем над обновлением этой темы.

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

  • VOICE
  • CHAT
  • TASK
  • EMAIL

--initiation-method (строка)

Указывает, как был инициирован контакт.

Предупреждение

CreateContact поддерживает только следующие методы инициирования:

  • Для EMAIL: OUTBOUND, AGENT_REPLY и FLOW.
  • Для VOICE: TRANSFER и подтип connect:ExternalAudio.

Следующая информация, утверждающая поддержку других методов инициирования, неверна. Мы работаем над обновлением этой темы.

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

  • INBOUND
  • OUTBOUND
  • TRANSFER
  • QUEUE_TRANSFER
  • CALLBACK
  • API
  • DISCONNECT
  • MONITOR
  • EXTERNAL_OUTBOUND
  • WEBRTC_API
  • AGENT_REPLY
  • FLOW

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

Количество минут, в течение которых контакт будет активным перед истечением срока действия

--user-info (структура)

Данные пользователя для контакта

UserId -> (строка)

Идентификатор пользователя для контакта.

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

UserId=string

Синтаксис JSON:

{
  "UserId": "string"
}

--initiate-as (строка)

Начальное состояние контакта при его создании

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

  • CONNECTED_TO_USER

--name (строка)

Имя контакта.

--description (строка)

Описание контакта.

--segment-attributes (карта)

Набор системных пар ключ-значение, хранящихся в отдельных сегментах контакта (уникальный идентификатор контакта) с помощью карты атрибутов. Атрибуты являются стандартными атрибутами Amazon Connect. Они могут быть доступны в потоках.

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

Это поле может быть использовано для установки срока действия сегмента контакта в виде продолжительности в минутах.

Примечание

Для установки срока действия контакта необходимо указать ValueMap, содержащий целое число минут, в течение которых контакт будет активным перед истечением срока действия, с SegmentAttributes как { "connect:ContactExpiry": {"ValueMap" : { "ExpiryDuration": { "ValueInteger": 135}}}} .

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

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

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

ValueString -> (строка)

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

ValueMap -> (карта)

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

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

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

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

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

Идентификатор предыдущего контакта при создании контакта переадресации. Это значение может быть указано только для контактов внешнего аудио. Дополнительную информацию см. в разделе Integrate Amazon Connect Contact Lens with external voice systems в Руководстве администратора Amazon Connect.

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

Вывод

ContactId -> (строка)

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

ContactArn -> (строка)

Amazon Resource Name (ARN) созданного контакта.

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

Spec-Zone.ru

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