SendLiveMessageGroup - ApsaraVideo Live - Alibaba Cloud Documentation Center

Sends a message to a group.

Operation description

Before you call this operation, you must call CreateLiveMessageGroup to create an interactive messaging group. You can send messages to a group only if the group is active, which means that one or more users have joined the group. Offline messages are not supported. If you fail to send a message, check whether there are users in the group. If you want to send an offline message, we recommend that you store the message locally and send it after users come online.

QPS limits

You can call this operation up to 50 times per second per account. Requests that exceed this limit are dropped and you may experience service interruptions. We recommend that you consider this limit when calling this operation.

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that support authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

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 that is used to receive the message.	demo
GroupId	string	Yes	The ID of the group that receives the message. Note Make sure that the specified GroupId is available. Otherwise, a ResourceNotExist error is returned.	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. It can be up to 15 KB in length.	hello,group
MsgType	integer	No	The message type. The total number of message types sent within a single group cannot exceed 30.	1
MsgTid	string	No	The unique identifier of the message. This parameter is used to delete the message. The ID can contain only letters and digits and can be up to 64 bytes in length.	169830****
StaticsIncrease	integer	No	The contribution of the message to the increase in the number of messages of this type. Default value: 1.	1
Weight	integer	No	The weight of the message. Default value: 1. For low-priority messages such as likes, you can set the weight to 1. For regular text messages such as bullet comments, you can set the weight to 5. For high-priority messages such as red envelopes and gifts, 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 indicates 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 need to store the message, set this parameter to true.	false
NoCache	boolean	No	Specifies whether to disable message caching to the list of the latest messages in the group. Valid values: true and false. Default value: false, which indicates that the message is cached.	false
DataCenter	string	No	The data center, which must be the same as the data center specified in CreateLiveMessageApp. Valid values: cn-shanghai: Shanghai ap-southeast-1: Singapore	cn-shanghai

Response parameters

Parameter	Type	Description	Example
	object	The returned results.
RequestId	string	The ID of the request.	E4C1245F-597B-1BD1-B9BB-9D220E99****
MsgTid	string	The unique identifier of the message, which can be used to delete the message. The ID can contain only letters and digits and can be up to 64 bytes in length.	169830****

Examples

Success response

JSON format

{
  "RequestId": "E4C1245F-597B-1BD1-B9BB-9D220E99****",
  "MsgTid": "169830****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
400	ErrorTooManyMsgTypes	%s.
500	ServerError	%s.	Unknown error, please try again later or submit a ticket for consultation.
403	NoAuth	%s.	No permission
404	ResourceNotExist	%s.	The requested resource does not exist, please check and try again

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.