Share via

az communication chat message receipt

  • Preview

Note

This reference is part of the communication extension for the Azure CLI (version 2.67.0 or higher). The extension will automatically install the first time you run an az communication chat message receipt command. Learn more about extensions.

Command group 'communication chat message' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Commands to manage message read-receipts in a chat thread of a Communication Service resource.

Commands

Name Description Type Status
az communication chat message receipt list

Gets read receipts of a chat thread.

 Extension Preview
az communication chat message receipt send

Posts a read receipt event to a chat thread, on behalf of a user.

 Extension Preview

az communication chat message receipt list

Preview

Command group 'communication chat message receipt' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Gets read receipts of a chat thread.

az communication chat message receipt list --thread
                                           [--access-token]
                                           [--endpoint]
                                           [--skip]

Examples

List read receipts

az communication chat message receipt list --thread "19:a-bcd=xyz" --skip "4"

Required Parameters

--thread -t

Thread id.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

Property Value
Parameter group: Communication Arguments
--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

Property Value
Parameter group: Communication Arguments
--skip

Number of read receipts to skip.

Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False

az communication chat message receipt send

Preview

Command group 'communication chat message receipt' is in preview and under development. Reference and support levels: https://aka.ms/CLI_refstatus

Posts a read receipt event to a chat thread, on behalf of a user.

az communication chat message receipt send --message-id
                                           --thread
                                           [--access-token]
                                           [--endpoint]

Examples

Send read receipt

az communication chat message receipt send --thread "19:a-bcd=xyz" --message-id "12345678"

Required Parameters

--message-id

Message id.

--thread -t

Thread id.

Optional Parameters

The following parameters are optional, but depending on the context, one or more might become required for the command to execute successfully.

--access-token

Communication access token. Environment variable: AZURE_COMMUNICATION_ACCESS_TOKEN.

Property Value
Parameter group: Communication Arguments
--endpoint

Communication endpoint. Environment variable: AZURE_COMMUNICATION_ENDPOINT.

Property Value
Parameter group: Communication Arguments
Global Parameters
--debug

Increase logging verbosity to show all debug logs.

Property Value
Default value: False
--help -h

Show this help message and exit.

--only-show-errors

Only show errors, suppressing warnings.

Property Value
Default value: False
--output -o

Output format.

Property Value
Default value: json
Accepted values: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath query string. See http://jmespath.org/ for more information and examples.

--subscription

Name or ID of subscription. You can configure the default subscription using az account set -s NAME_OR_ID.

--verbose

Increase logging verbosity. Use --debug for full debug logs.

Property Value
Default value: False