[ aws . chime-sdk-messaging ]
отправка-сообщения-в-канал
Описание
Отправляет сообщение в определенный канал, участником которого является член.
Примечание
Заголовок запроса x-amz-chime-bearer обязателен. Используйте ARN AppInstanceUser или AppInstanceBot, выполняющего вызов API, в качестве значения в заголовке.
Кроме того, сообщения STANDARD могут иметь размер до 4 КБ и содержать метаданные. Метаданные произвольные и могут использоваться по-разному, например, для указания ссылки на вложение.
CONTROL ограничены 30 байтами и не содержат метаданных.См. также: Документация API AWS
Синтаксис
send-channel-message
--channel-arn <value>
--content <value>
--type <value>
--persistence <value>
[--metadata <value>]
[--client-request-token <value>]
--chime-bearer <value>
[--push-notification <value>]
[--message-attributes <value>]
[--sub-channel-id <value>]
[--content-type <value>]
[--target <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]
Параметры
--channel-arn (строка)
--content (строка)
--type (строка)
Тип сообщения, STANDARD или CONTROL.
Сообщения STANDARD могут иметь размер до 4 КБ и содержать метаданные. Метаданные произвольные и могут использоваться по-разному, например, для указания ссылки на вложение.
Сообщения CONTROL ограничены 30 байтами и не содержат метаданных.
Возможные значения:
STANDARDCONTROL
--persistence (строка)
Булево значение, определяющее, сохраняется ли сообщение на сервере. Требуется.
Возможные значения:
PERSISTENTNON_PERSISTENT
--metadata (строка)
--client-request-token (строка)
Idempotency токен для каждого клиентского запроса.--chime-bearer (строка)
AppInstanceUser или AppInstanceBot, выполняющего вызов API.--push-notification (структура)
Настройка push-уведомлений для сообщения.
Заголовок -> (строка)
Тело -> (строка)
Тип -> (строка)
DEFAULT : Обычное мобильное push-уведомление. VOIP : Push-уведомление VOIP для мобильных устройств.Сокращённый синтаксис:
Title=string,Body=string,Type=string
Синтаксис JSON:
{
"Title": "string",
"Body": "string",
"Type": "DEFAULT"|"VOIP"
}
--message-attributes (массив)
Атрибуты сообщения, используемые для фильтрации сообщений вместе с FilterRule, определенным в PushNotificationPreferences.
ключ -> (строка)
значение -> (структура)
Список значений атрибутов сообщения.
StringValues -> (список)
Строки в значении атрибута сообщения.
(строка)
Сокращённый синтаксис:
KeyName1=StringValues=string,string,KeyName2=StringValues=string,string
Синтаксис JSON:
{"string": {
"StringValues": ["string", ...]
}
...}
--sub-channel-id (строка)
--content-type (строка)
--target (список)
Целевое значение сообщения. Должен быть членом канала, например, другой пользователь, бот или отправитель. Только целевое значение и отправитель могут просматривать целевые сообщения. Только пользователи, которые могут просматривать целевые сообщения, могут выполнять действия с ними. Однако администраторы могут удалять целевые сообщения, которые они не могут просмотреть.
(структура)
Целевое значение сообщения, отправитель, пользователь или бот. Только целевое значение и отправитель могут просматривать целевые сообщения. Только пользователи, которые могут просматривать целевые сообщения, могут выполнять действия с ними. Однако администраторы могут удалять целевые сообщения, которые они не могут просмотреть.
MemberArn -> (строка)
Сокращённый синтаксис:
MemberArn=string ...
Синтаксис JSON:
[
{
"MemberArn": "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
- текст
- таблица
- 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.
Вывод
ChannelArn -> (строка)
MessageId -> (строка)
Status -> (структура)
Статус сообщения в канале.
Значение -> (строка)
Подробности -> (строка)
SubChannelId -> (строка)
© Copyright 2025, Amazon Web Services. Created using Sphinx.