render-message-template

Описание

Отображает шаблон сообщения Amazon Q в Connect на основе предоставленных значений атрибутов и генерирует содержимое сообщения. Для любой переменной в шаблоне сообщения, если значение атрибута не предоставлено в параметре запроса атрибута и не является значением по умолчанию атрибута шаблона сообщения, отрендеренное содержимое сообщения сохранит заполнитель переменной в том же виде и вернёт ключи атрибутов, которых не хватает.

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

Синтаксис

  render-message-template
--knowledge-base-id <value>
--message-template-id <value>
--attributes <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]

Параметры

--knowledge-base-id (строка)

Идентификатор базы знаний. Может быть либо ID, либо ARN. URL не могут содержать ARN.

--message-template-id (строка)

Идентификатор шаблона сообщения. Может быть либо ID, либо ARN.

--attributes (структура)

Объект, указывающий значения для использования в переменных шаблона сообщения. Этот объект содержит различные категории пар «ключ-значение». Каждый ключ определяет переменную или заполнитель в шаблоне сообщения. Соответствующее значение определяет значение для этой переменной.

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

Системные атрибуты, используемые с шаблоном сообщения.

name -> (строка)

Имя задачи.

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

Атрибут CustomerEndpoint.

address -> (строка)

Номер телефона клиента, если используется с customerEndpoint, или номер, по которому клиент позвонил в ваш контактный центр, если используется с systemEndpoint.

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

Атрибут SystemEndpoint.

address -> (строка)

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

Агентские атрибуты, используемые с шаблоном сообщения.

firstName -> (строка)

Имя агента, как указано в учетной записи пользователя Amazon Connect.

lastName -> (строка)

Фамилия агента, как указано в учетной записи пользователя Amazon Connect.

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

Атрибуты профиля клиента, используемые с шаблоном сообщения.

profileId -> (строка)

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

profileARN -> (строка)

ARN профиля клиента.

firstName -> (строка)

Имя клиента.

middleName -> (строка)

Отчество клиента.

lastName -> (строка)

Фамилия клиента.

accountNumber -> (строка)

Уникальный номер счета, присвоенный клиенту.

emailAddress -> (строка)

Электронный адрес клиента, не указанный как личный или деловой.

phoneNumber -> (строка)

Номер телефона клиента, не указанный как мобильный, домашний или деловой.

additionalInformation -> (строка)

Любая дополнительная информация, относящаяся к профилю клиента.

partyType -> (строка)

Тип участника клиента.

businessName -> (строка)

Название бизнеса клиента.

birthDate -> (строка)

Дата рождения клиента.

gender -> (строка)

Пол клиента.

mobilePhoneNumber -> (строка)

Мобильный номер телефона клиента.

homePhoneNumber -> (строка)

Домашний номер телефона клиента.

businessPhoneNumber -> (строка)

Деловой номер телефона клиента.

businessEmailAddress -> (строка)

Деловой электронный адрес клиента.

address1 -> (строка)

Первая строка адреса клиента.

address2 -> (строка)

Вторая строка адреса клиента.

address3 -> (строка)

Третья строка адреса клиента.

address4 -> (строка)

Четвёртая строка адреса клиента.

city -> (строка)

Город, в котором живёт клиент.

county -> (строка)

Уезд, в котором живёт клиент.

country -> (строка)

Страна, в которой живёт клиент.

postalCode -> (строка)

Почтовый индекс адреса клиента.

province -> (строка)

Провинция, в которой живёт клиент.

state -> (строка)

Штат, в котором живёт клиент.

shippingAddress1 -> (строка)

Первая строка адреса доставки клиента.

shippingAddress2 -> (строка)

Вторая строка адреса доставки клиента.

shippingAddress3 -> (строка)

Третья строка адреса доставки клиента.

shippingAddress4 -> (строка)

Четвёртая строка адреса доставки клиента.

shippingCity -> (строка)

Город адреса доставки клиента.

shippingCounty -> (строка)

Уезд адреса доставки клиента.

shippingCountry -> (строка)

Страна адреса доставки клиента.

shippingPostalCode -> (строка)

Почтовый индекс адреса доставки клиента.

shippingProvince -> (строка)

Провинция адреса доставки клиента.

shippingState -> (строка)

Штат адреса доставки клиента.

mailingAddress1 -> (строка)

Первая строка почтового адреса клиента.

mailingAddress2 -> (строка)

Вторая строка почтового адреса клиента.

mailingAddress3 -> (строка)

Третья строка почтового адреса клиента.

mailingAddress4 -> (строка)

Четвёртая строка почтового адреса клиента.

mailingCity -> (строка)

Город почтового адреса клиента.

mailingCounty -> (строка)

Уезд почтового адреса клиента.

mailingCountry -> (строка)

Страна почтового адреса клиента.

mailingPostalCode -> (строка)

Почтовый индекс почтового адреса клиента.

mailingProvince -> (строка)

Провинция почтового адреса клиента.

mailingState -> (строка)

Штат почтового адреса клиента.

billingAddress1 -> (строка)

Первая строка адреса выставления счёта клиента.

billingAddress2 -> (строка)

Вторая строка адреса выставления счёта клиента.

billingAddress3 -> (строка)

Третья строка адреса выставления счёта клиента.

billingAddress4 -> (строка)

Четвёртая строка адреса выставления счёта клиента.

billingCity -> (строка)

Город адреса выставления счёта клиента.

billingCounty -> (строка)

Уезд адреса выставления счёта клиента.

billingCountry -> (строка)

Страна адреса выставления счёта клиента.

billingPostalCode -> (строка)

Почтовый индекс адреса выставления счёта клиента.

billingProvince -> (строка)

Провинция адреса выставления счёта клиента.

billingState -> (строка)

Штат адреса выставления счёта клиента.

custom -> (карта)

Настраиваемые атрибуты в атрибутах профиля клиента.

key -> (строка)

value -> (строка)

customAttributes -> (карта)

Настраиваемые атрибуты, используемые с шаблоном сообщения.

key -> (строка)

value -> (строка)

Сокращенный синтаксис:

systemAttributes={name=string,customerEndpoint={address=string},systemEndpoint={address=string}},agentAttributes={firstName=string,lastName=string},customerProfileAttributes={profileId=string,profileARN=string,firstName=string,middleName=string,lastName=string,accountNumber=string,emailAddress=string,phoneNumber=string,additionalInformation=string,partyType=string,businessName=string,birthDate=string,gender=string,mobilePhoneNumber=string,homePhoneNumber=string,businessPhoneNumber=string,businessEmailAddress=string,address1=string,address2=string,address3=string,address4=string,city=string,county=string,country=string,postalCode=string,province=string,state=string,shippingAddress1=string,shippingAddress2=string,shippingAddress3=string,shippingAddress4=string,shippingCity=string,shippingCounty=string,shippingCountry=string,shippingPostalCode=string,shippingProvince=string,shippingState=string,mailingAddress1=string,mailingAddress2=string,mailingAddress3=string,mailingAddress4=string,mailingCity=string,mailingCounty=string,mailingCountry=string,mailingPostalCode=string,mailingProvince=string,mailingState=string,billingAddress1=string,billingAddress2=string,billingAddress3=string,billingAddress4=string,billingCity=string,billingCounty=string,billingCountry=string,billingPostalCode=string,billingProvince=string,billingState=string,custom={KeyName1=string,KeyName2=string}},customAttributes={KeyName1=string,KeyName2=string}

Синтаксис JSON:

{
  "systemAttributes": {
    "name": "string",
    "customerEndpoint": {
      "address": "string"
    },
    "systemEndpoint": {
      "address": "string"
    }
  },
  "agentAttributes": {
    "firstName": "string",
    "lastName": "string"
  },
  "customerProfileAttributes": {
    "profileId": "string",
    "profileARN": "string",
    "firstName": "string",
    "middleName": "string",
    "lastName": "string",
    "accountNumber": "string",
    "emailAddress": "string",
    "phoneNumber": "string",
    "additionalInformation": "string",
    "partyType": "string",
    "businessName": "string",
    "birthDate": "string",
    "gender": "string",
    "mobilePhoneNumber": "string",
    "homePhoneNumber": "string",
    "businessPhoneNumber": "string",
    "businessEmailAddress": "string",
    "address1": "string",
    "address2": "string",
    "address3": "string",
    "address4": "string",
    "city": "string",
    "county": "string",
    "country": "string",
    "postalCode": "string",
    "province": "string",
    "state": "string",
    "shippingAddress1": "string",
    "shippingAddress2": "string",
    "shippingAddress3": "string",
    "shippingAddress4": "string",
    "shippingCity": "string",
    "shippingCounty": "string",
    "shippingCountry": "string",
    "shippingPostalCode": "string",
    "shippingProvince": "string",
    "shippingState": "string",
    "mailingAddress1": "string",
    "mailingAddress2": "string",
    "mailingAddress3": "string",
    "mailingAddress4": "string",
    "mailingCity": "string",
    "mailingCounty": "string",
    "mailingCountry": "string",
    "mailingPostalCode": "string",
    "mailingProvince": "string",
    "mailingState": "string",
    "billingAddress1": "string",
    "billingAddress2": "string",
    "billingAddress3": "string",
    "billingAddress4": "string",
    "billingCity": "string",
    "billingCounty": "string",
    "billingCountry": "string",
    "billingPostalCode": "string",
    "billingProvince": "string",
    "billingState": "string",
    "custom": {"string": "string"
      ...}
  },
  "customAttributes": {"string": "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 (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-auto-prompt (boolean)

Автоматически запросить параметры ввода CLI.

--no-cli-auto-prompt (boolean)

Отключить автоматический запрос параметров ввода CLI.

Вывод

content -> (структура помеченного объединения)

Содержимое шаблона сообщения.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: email, sms.

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

Содержимое шаблона сообщения, применимое к типу подтипа канала электронной почты.

subject -> (строка)

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

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

Тело для использования в сообщениях электронной почты.

plainText -> (структура помеченного объединения)

Тело сообщения в формате простого текста для использования в сообщениях электронной почты, основанных на шаблоне сообщения. Рекомендуется использовать формат простого текста для почтовых клиентов, которые не отображают HTML-содержимое, и клиентов, подключённых к сетям с высокой задержкой, таким как мобильные устройства.

Примечание

Это структура помеченного объединения. Только один из следующих верхнеуровневых ключей может быть установлен: content.

content -> (строка)

Содержимое шаблона сообщения.

html -> (структура помеченного объединения)

Тело сообщения в формате HTML для использования в сообщениях электронной почты, основанных на шаблоне сообщения. Рекомендуется использовать формат HTML для почтовых клиентов, которые отображают HTML-содержимое. Вы можете включать ссылки, форматированный текст и многое другое в HTML-сообщение.

Примечание

content -> (строка)

Содержимое шаблона сообщения.

headers -> (список)

Заголовки электронной почты, которые нужно включить в сообщения электронной почты.

(структура)

Заголовок электронной почты для включения в сообщения электронной почты.

name -> (строка)

Имя заголовка электронной почты.

value -> (строка)

Значение заголовка электронной почты.

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

Содержимое шаблона сообщения, применимое к подтипу канала SMS.

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

Тело для использования в сообщениях SMS.

plainText -> (структура помеченного объединения)

Тело сообщения для использования в сообщениях SMS.

Примечание

content -> (строка)

Содержимое шаблона сообщения.

attributesNotInterpolated -> (список)

Ключи атрибутов, которые не разрешены.

(строка)

attachments -> (список)

Вложения шаблона сообщения.

(структура)

Информация о вложении шаблона сообщения.

contentDisposition -> (строка)

Информация о представлении файла вложения.

name -> (строка)

Имя файла вложения, загружаемого. Имя должно включать расширение файла.

uploadedTime -> (метка времени)

Отметка времени загрузки файла вложения.

url -> (строка)

Предзарегистрированный URL Amazon S3, который можно использовать для загрузки файла вложения.

urlExpiry -> (метка времени)

Время истечения срока действия предзарегистрированного URL Amazon S3.

attachmentId -> (строка)

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