[ aws . chime-sdk-messaging ]

send-channel-message

Description

Sends a message to a particular channel that the member is a part of.

Note

The x-amz-chime-bearer request header is mandatory. Use the AppInstanceUserArn of the user that makes the API call as the value in the header.

Also, STANDARD messages can contain 4KB of data and the 1KB of metadata. CONTROL messages can contain 30 bytes of data and no metadata.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  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>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--channel-arn (string)

The ARN of the channel.

--content (string)

The content of the message.

--type (string)

The type of message, STANDARD or CONTROL .

Possible values:

• STANDARD

• CONTROL

--persistence (string)

Boolean that controls whether the message is persisted on the back end. Required.

Possible values:

• PERSISTENT

• NON_PERSISTENT

--metadata (string)

The optional metadata for each message.

--client-request-token (string)

The Idempotency token for each client request.

--chime-bearer (string)

The AppInstanceUserArn of the user that makes the API call.

--push-notification (structure)

The push notification configuration of the message.

Title -> (string)

The title of the push notification.

Body -> (string)

The body of the push notification.

Type -> (string)

Enum value that indicates the type of the push notification for a message. DEFAULT : Normal mobile push notification. VOIP : VOIP mobile push notification.

Shorthand Syntax:

Title=string,Body=string,Type=string

JSON Syntax:

{
  "Title": "string",
  "Body": "string",
  "Type": "DEFAULT"|"VOIP"
}

--message-attributes (map)

The attributes for the message, used for message filtering along with a FilterRule defined in the PushNotificationPreferences .

key -> (string)

value -> (structure)

A list of message attribute values.

StringValues -> (list)

The strings in a message attribute value.

(string)

Shorthand Syntax:

KeyName1=StringValues=string,string,KeyName2=StringValues=string,string

JSON Syntax:

{"string": {
      "StringValues": ["string", ...]
    }
  ...}

--sub-channel-id (string)

The ID of the SubChannel in the request.

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

See ‘aws help’ for descriptions of global parameters.

Output

ChannelArn -> (string)

The ARN of the channel.

MessageId -> (string)

The ID string assigned to each message.

Status -> (structure)

The status of the channel message.

Value -> (string)

The message status value.

Detail -> (string)

Contains more details about the messasge status.

SubChannelId -> (string)

The ID of the SubChannel in the response.