Sends a message to a group.
Operation description
Usage notes
Before you call this operation, make sure that you have called the CreateLiveMessageGroup operation to create an interactive messaging group. You can send messages to a group only if the group is active, which requires that one or more users have joined the group. If you fail to send a message, check whether users exist in the group.
QPS limit
You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limits.
Debugging
Authorization information
The following table shows the authorization information corresponding to the API. The authorization information can be used in the Action policy element to grant a RAM user or RAM role the permissions to call this API operation. Description:
- Operation: the value that you can use in the Action element to specify the operation on a resource.
- Access level: the access level of each operation. The levels are read, write, and list.
- Resource type: the type of the resource on which you can authorize the RAM user or the RAM role to perform the operation. Take note of the following items:
- The required resource types are displayed in bold characters.
- If the permissions cannot be granted at the resource level,
All Resourcesis used in the Resource type column of the operation.
- Condition Key: the condition key that is defined by the cloud service.
- Associated operation: other operations that the RAM user or the RAM role must have permissions to perform to complete the operation. To complete the operation, the RAM user or the RAM role must have the permissions to perform the associated operations.
| Operation | Access level | Resource type | Condition key | Associated operation |
|---|---|---|---|---|
| live:SendLiveMessageGroup | none | *Rtc acs:live::{#accountId}:rtc/{#AppId} |
| none |
Request parameters
| Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| AppId | string | Yes | The ID of the interactive messaging application in which the message is received. | demo |
| GroupId | string | Yes | The ID of the interactive messaging group that receives the message. | grouptest |
| SenderId | string | Yes | The ID of the user who sends the message. The ID can be up to 64 bytes in length and can contain letters and digits. | uid1 |
| SenderMetaInfo | string | No | The additional information about the user who sends the message. The value can be up to 512 bytes in length. | uid1meta1 |
| Body | string | No | The message body. The body can be up to 15 KB in length. | hello,group |
| MsgType | long | No | The message type. | 1 |
| MsgTid | string | No | The ID of the message, which is a unique identifier that can be used to delete the message. The ID can be up to 64 bytes in length and can contain letters and digits. | 169830**** |
| StaticsIncrease | long | No | The contribution of the message to the increase in the number of messages of this type. Default value: 1. | 1 |
| Weight | long | No | The weight of the message. Default value: 1. A greater value indicates a higher priority. For a message of the highest priority, you can set the weight to 1000000. | 1 |
| NoStorage | boolean | No | Specifies whether to disable message storage. Valid values: true and false. Default value: false, which specifies that the message is stored for a validity period of 30 days. You can find the message in the response of the ListLiveMessageGroupMessages operation. If you do not want to store the message, set this parameter to true. | false |
| NoCache | boolean | No | Specifies whether to disable message caching. Valid values: true and false. Default value: false, which specifies that the message is cached to the recent message list of the group. | false |
| DataCenter | string | No | The data center in which the interactive messaging application is deployed. The value of this parameter must be the same as the value of DataCenter that you set in the CreateLiveMessageApp operation. Valid values: cn-shanghai (Shanghai) and ap-southeast-1 (Singapore). | cn-shanghai |
Response parameters
Examples
Sample success responses
JSONformat
{
"RequestId": "E4C1245F-597B-1BD1-B9BB-9D220E99****"
}Error codes
| HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | InputInvalid | %s. | Illegal input parameters |
| 403 | NoAuth | %s. | No permission |
| 404 | ResourceNotExist | %s. | The requested resource does not exist, please check and try again |
| 500 | ServerError | %s. | Unknown error, please try again later or submit a ticket for consultation. |
For a list of error codes, visit the Service error codes.
Change history
| Change time | Summary of changes | Operation |
|---|---|---|
| 2024-01-09 | The Error code has changed. The request parameters of the API has changed | View Change Details |
| 2023-12-13 | The Error code has changed. The request parameters of the API has changed | View Change Details |