send-chat-integration-event
Описание
Обрабатывает события интеграции чата из Amazon Web Services или внешних интеграций в Amazon Connect. Событие интеграции чата включает:
- SourceId, DestinationId и Subtype: набор идентификаторов, уникально представляющих чат
- ChatEvent: детали действия в чате, такие как отправка сообщения, событие или отключение от чата
Когда событие интеграции чата отправляется с идентификаторами чата, которые не сопоставляются с активным контактом чата, новый контакт чата также создается перед обработкой действия чата.
Доступ к этому API в настоящее время ограничен для Amazon Web Services End User Messaging для поддержки интеграции SMS.
См. также: Документацию API AWS
Синтаксис
send-chat-integration-event
--source-id <value>
--destination-id <value>
[--subtype <value>]
--event <value>
[--new-session-details <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-id (строка)
--destination-id (строка)
--subtype (строка)
Классификация канала. Она используется частично для уникальной идентификации чата.
Допустимые значения: ["connect:sms", connect:"WhatsApp"]
--event (структура)
Полезная нагрузка события интеграции чата
Type -> (строка)
ContentType -> (строка)
Тип содержимого. Требуется, когда Type равен MESSAGE или EVENT.
- Допустимые типы содержимого сообщений см. в параметре
ContentTypeв разделе Отправка сообщения в Справочнике по API службы участников Amazon Connect. - Допустимые типы содержимого событий см. в параметре
ContentTypeв разделе Отправка события в Справочнике по API службы участников Amazon Connect.
Content -> (строка)
Содержимое сообщения или события. Требуется, когда Type равен MESSAGE и для определённых ContentTypes, когда Type равен EVENT.
- Допустимое содержимое сообщений см. в параметре
Contentв разделе Отправка сообщения в Справочнике по API службы участников Amazon Connect. - Допустимое содержимое событий см. в параметре
Contentв разделе Отправка события в Справочнике по API службы участников Amazon Connect.
Упрощённый синтаксис:
Type=string,ContentType=string,Content=string
Синтаксис JSON:
{
"Type": "DISCONNECT"|"MESSAGE"|"EVENT",
"ContentType": "string",
"Content": "string"
}
--new-session-details (структура)
Свойства контакта, применяемые при запуске нового чата. Если событие интеграции обрабатывается с существующим чатом, оно игнорируется.
SupportedMessagingContentTypes -> (список)
Поддерживаемые типы содержимого сообщений чата. Поддерживаемые типы: 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].
(строка)
ParticipantDetails -> (структура)
Подробности клиента.
DisplayName -> (строка)
Attributes -> (карта)
Пользовательские пары ключ-значение, использующие карту атрибутов. Атрибуты — стандартные атрибуты Amazon Connect. К ним можно получить доступ в потоках так же, как и к любым другим атрибутам контакта.
Общая длина всех пар ключ-значение не должна превышать 32 768 байт UTF-8 на один контакт. Имена атрибутов могут содержать только буквенно-цифровые символы, дефисы и символы нижнего подчеркивания.
key -> (строка)
value -> (строка)
StreamingConfiguration -> (структура)
Настройка потоковой передачи, например, конечная точка потоковой передачи Amazon SNS.
StreamingEndpointArn -> (строка)
Упрощённый синтаксис:
SupportedMessagingContentTypes=string,string,ParticipantDetails={DisplayName=string},Attributes={KeyName1=string,KeyName2=string},StreamingConfiguration={StreamingEndpointArn=string}
Синтаксис JSON:
{
"SupportedMessagingContentTypes": ["string", ...],
"ParticipantDetails": {
"DisplayName": "string"
},
"Attributes": {"string": "string"
...},
"StreamingConfiguration": {
"StreamingEndpointArn": "string"
}
}
--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.
Вывод
InitialContactId -> (строка)
NewChatCreated -> (булево)
© Copyright 2025, Amazon Web Services. Created using Sphinx.