Spec-Zone.ru › AWS CLI v2

[ aws . connectparticipant ]

get-transcript

Описание

Получает протокол сессии, включая детали любых вложений. Сведения о доступе к протоколам прошлых чатов для постоянного чата см. в разделе Включить постоянный чат.

Рекомендации по безопасности см. в Рекомендации по лучшим практикам безопасности Amazon Connect Chat.

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

  • application/vnd.amazonaws.connect.event.participant.left
  • application/vnd.amazonaws.connect.event.participant.joined
  • application/vnd.amazonaws.connect.event.chat.ended
  • application/vnd.amazonaws.connect.event.transfer.succeeded
  • application/vnd.amazonaws.connect.event.transfer.failed

Примечание

ConnectionToken используется для вызова этого API вместо ParticipantToken .

API-интерфейсы Amazon Connect Participant Service не используют аутентификацию Signature Version 4 .

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

Синтаксис

  get-transcript
[--contact-id <value>]
[--max-results <value>]
[--next-token <value>]
[--scan-direction <value>]
[--sort-order <value>]
[--start-position <value>]
--connection-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]

Параметры

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

ContactId из текущей цепочки контактов, для которого требуется протокол.

--max-results (целое число)

Максимальное количество результатов, возвращаемых на странице. По умолчанию: 10.

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

Токен постраничной навигации. Используйте значение, возвращённое ранее в следующем запросе, чтобы получить следующий набор результатов.

--scan-direction (строка)

Направление с StartPosition, с которого извлекать сообщения. По умолчанию: BACKWARD, если StartPosition не предоставлен, FORWARD с StartPosition.

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

  • FORWARD
  • BACKWARD

--sort-order (строка)

Порядок сортировки записей. По умолчанию: DESCENDING.

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

  • DESCENDING
  • ASCENDING

--start-position (структура)

Фильтрующий параметр для определения стартовой точки.

Id -> (строка)

Идентификатор сообщения или события, с которого начать.

AbsoluteTime -> (строка)

Время в формате ISO, с которого начать.

Указывается в формате ISO 8601: yyyy-MM-ddThh:mm:ss.SSSZ. Например, 2019-11-08T02:41:28.172Z.

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

Начальная позиция самого последнего сообщения, с которого вы хотите начать.

Краткая запись:

Id=string,AbsoluteTime=string,MostRecent=integer

Синтаксис JSON:

{
  "Id": "string",
  "AbsoluteTime": "string",
  "MostRecent": integer
}

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

Токен аутентификации, связанный с соединением участника.

--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
  • таблица
  • 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.

Вывод

InitialContactId -> (строка)

Идентификатор начального контакта для контакта.

Transcript -> (список)

Список сообщений в сессии.

(структура)

Элемент - сообщение или событие - который был отправлен.

AbsoluteTime -> (строка)

Время отправки сообщения или события.

Указывается в формате ISO 8601: yyyy-MM-ddThh:mm:ss.SSSZ. Например, 2019-11-08T02:41:28.172Z.

Content -> (строка)

Содержимое сообщения или события.

ContentType -> (строка)

Тип содержимого элемента.

Id -> (строка)

Идентификатор элемента.

Type -> (строка)

Тип элемента: сообщение или событие.

ParticipantId -> (строка)

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

DisplayName -> (строка)

Имя отображения чата отправителя.

ParticipantRole -> (строка)

Роль отправителя. Например, клиент, агент или система.

Attachments -> (список)

Предоставляет информацию о вложениях.

(структура)

Регистронезависимый ввод для указания стандартного MIME-типа, описывающего формат загружаемого файла.

ContentType -> (строка)

Описание MIME-типа файла вложения. Список поддерживаемых типов файлов см. в разделе «Спецификации функций» в руководстве администратора Amazon Connect.

AttachmentId -> (строка)

Уникальный идентификатор вложения.

AttachmentName -> (строка)

Регистрозависимое имя загружаемого вложения.

Status -> (строка)

Статус вложения.

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

Метаданные, связанные с сообщением. В настоящее время это поддерживает только информацию, связанную с получением сообщений.

MessageId -> (строка)

Идентификатор сообщения, содержащего метаданные.

Receipts -> (список)

Список информации о получении сообщения для разных получателей.

(структура)

Квитанция о доставке сообщения получателю.

DeliveredTimestamp -> (строка)

Время доставки сообщения получателю.

ReadTimestamp -> (строка)

Время прочтения сообщения получателем.

RecipientParticipantId -> (строка)

Идентификатор получателя сообщения.

RelatedContactId -> (строка)

ContactId, на который первоначально было отправлено элемент протокола. Это поле заполняется только для постоянных чатов, когда элемент протокола относится к прошлой сессии чата. Подробнее см. Включить постоянный чат.

ContactId -> (строка)

ContactId, на который первоначально был отправлен элемент протокола. Это поле заполняется только при том, что элемент протокола относится к текущей сессии чата.

NextToken -> (строка)

Токен постраничной навигации. Используйте значение, возвращенное ранее в следующем запросе, чтобы получить следующий набор результатов.

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

Spec-Zone.ru

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