update-contact
Описание
Этот API находится в предварительной версии для Amazon Connect и может быть изменён.
Добавляет или обновляет пользовательские данные контакта, связанные с указанным контактом. В запросе должно быть хотя бы одно обновляемое поле.
Предупреждение
Вы можете добавлять или обновлять пользовательские данные контакта для активных и завершённых контактов.См. также: Документация API AWS
Синопсис
update-contact
--instance-id <value>
--contact-id <value>
[--name <value>]
[--description <value>]
[--references <value>]
[--segment-attributes <value>]
[--queue-info <value>]
[--user-info <value>]
[--customer-endpoint <value>]
[--system-endpoint <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-id (строка)
--name (строка)
--description (строка)
--references (массив)
Структурированные данные о контакте, отображаемые агентам на панели управления контактами (CCP).
ключ -> (строка)
значение -> (структура)
Структурированные данные о контакте, используемые агентами для завершения запроса на контакт. Вы можете использовать до 4096 байт UTF-8 для всех ссылок на контакт.
Значение -> (строка)
Тип -> (строка)
DATE должен быть типа отметки времени эпохи.Статус -> (строка)
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"
}
...}
--segment-attributes (массив)
Набор системных пар ключ-значение, хранящихся в отдельных сегментах контактов (уникальный идентификатор контакта) с помощью карты атрибутов. Атрибуты — стандартные атрибуты Amazon Connect. К ним можно получить доступ в потоках.
Ключи атрибутов могут содержать только буквенно-цифровые символы, -, и _.
Это поле может быть использовано для отображения типа канала, такого как connect:Guide .
В настоящее время атрибут срока действия контакта является единственным атрибутом сегмента, который можно обновить с помощью API UpdateContact.
ключ -> (строка)
значение -> (структура)
Значение атрибута сегмента. Оно структурировано как карта, где ключ — 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
}
...}
--queue-info (структура)
Информация о очереди, связанной с контактом. Этот параметр можно обновить только для внешних аудиоконтактов. Используется при интеграции сторонних систем с Contact Lens для анализа. Более подробную информацию см. в разделе Интеграция Amazon Connect Contact Lens в руководстве администратора Amazon Connect.
Id -> (строка)
Сокращённый синтаксис:
Id=string
Синтаксис JSON:
{
"Id": "string"
}
--user-info (структура)
Информация об агенте, связанном с контактом. Этот параметр можно обновить только для внешних аудиоконтактов. Используется при интеграции сторонних систем с Contact Lens для анализа. Более подробную информацию см. в разделе Интеграция Amazon Connect Contact Lens в руководстве администратора Amazon Connect.
UserId -> (строка)
Сокращённый синтаксис:
UserId=string
Синтаксис JSON:
{
"UserId": "string"
}
--customer-endpoint (структура)
Конечная точка клиента, для которого был инициирован контакт. Для внешних аудиоконтактов это обычно номер телефона конечного клиента. Это значение может быть обновлено только для внешних аудиоконтактов. Для более подробной информации см. Интеграцию Amazon Connect Contact Lens в руководстве администратора Amazon Connect.
Тип -> (строка)
Адрес -> (строка)
Сокращённый синтаксис:
Type=string,Address=string
Синтаксис JSON:
{
"Type": "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
"Address": "string"
}
--system-endpoint (структура)
Внешняя конечная точка системы, для которой был инициирован контакт. Для внешних аудиоконтактов это номер телефона внешней системы, такой как контактный центр. Это значение может быть обновлено только для внешних аудиоконтактов. Для более подробной информации см. Интеграцию Amazon Connect Contact Lens в руководстве администратора Amazon Connect.
Тип -> (строка)
Адрес -> (строка)
Сокращённый синтаксис:
Type=string,Address=string
Синтаксис JSON:
{
"Type": "TELEPHONE_NUMBER"|"VOIP"|"CONTACT_FLOW"|"CONNECT_PHONENUMBER_ARN"|"EMAIL_ADDRESS",
"Address": "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
- таблица
- 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.
Вывод
Нет
© Copyright 2025, Amazon Web Services. Created using Sphinx.