start-chat-contact

Описание

Инициализирует поток для начала нового чата для клиента. Ответ этого API предоставляет токен, необходимый для получения учетных данных из API CreateParticipantConnection в службе Amazon Connect Participant Service.

Когда новый контакт чата успешно создается, клиенты должны подписаться на соединение участника для созданного чата в течение 5 минут. Это достигается путем вызова CreateParticipantConnection с WEBSOCKET и CONNECTION_CREDENTIALS.

Ошибка 429 возникает в следующих ситуациях:

• Превышен лимит скорости API. Ограничение TPS API возвращает исключение TooManyRequests.
• Превышен лимит одновременных активных чатов. Ограничение активных чатов возвращает LimitExceededException.

Если вы используете параметр ChatDurationInMinutes и получаете ошибку 400, ваш аккаунт, возможно, не поддерживает возможность настройки пользовательских сроков действия чата. Для получения дополнительной информации обратитесь в службу поддержки Amazon Web Services.

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

• Концепции: возможности веб- и мобильной связи в Amazon Connect
• Рекомендации по безопасности чата Amazon Connect

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

Синопсис

  start-chat-contact
--instance-id <value>
--contact-flow-id <value>
[--attributes <value>]
--participant-details <value>
[--initial-message <value>]
[--client-token <value>]
[--chat-duration-in-minutes <value>]
[--supported-messaging-content-types <value>]
[--persistent-chat <value>]
[--related-contact-id <value>]
[--segment-attributes <value>]
[--customer-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 (строка)

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

--attributes (словарь)

Краткая форма синтаксиса:

KeyName1=string,KeyName2=string

Синтаксис JSON:

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

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

Краткая форма синтаксиса:

DisplayName=string

Синтаксис JSON:

{
  "DisplayName": "string"
}

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

Краткая форма синтаксиса:

ContentType=string,Content=string

Синтаксис JSON:

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

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

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

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

Синтаксис:

"string" "string" ...

--persistent-chat (структура)

Краткая форма синтаксиса:

RehydrationType=string,SourceContactId=string

Синтаксис JSON:

{
  "RehydrationType": "ENTIRE_PAST_SESSION"|"FROM_SEGMENT",
  "SourceContactId": "string"
}

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

--segment-attributes (словарь)

Краткая форма синтаксиса:

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

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

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

ParticipantId -> (string)

ParticipantToken -> (string)

ContinuedFromContactId -> (string)