Target Live Stream Users with Precise Messaging - ApsaraVideo Live - Alibaba Cloud - ApsaraVideo Live

Sends a message to a specified user, identified by ReceiverId.

Operation description

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.

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 supports 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:SendLiveMessageUser

create

*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 sent.	demo
ReceiverId	string	Yes	The ID of the user who receives the message. The ID can be up to 64 bytes in length and can contain letters and digits. Note Make sure that the user who receives the message is online. You can call the CheckLiveMessageUsersOnline operation to query whether the user is online.	uid2
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
SenderInfo	string	No	The additional information about the user who sends the message. It 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, user
MsgType	integer	No	The message type.	2
MsgTid	string	No	The unique message ID, which can be used to delete the message. The ID can be up to 64 bytes in length and can contain letters and digits.	169830****
DataCenter	string	No	The data center. Must match the data center specified when you called the CreateLiveMessageApp operation to create the interactive messaging application. Valid values: cn-shanghai and ap-southeast-1 (Singapore).	cn-shanghai
HighReliability	boolean	No	Specifies whether to enable high-reliability mode for the message. When enabled, success is returned only after the receiver has received the message and responded. If the receiver does not respond within 3 seconds, failure is returned. true: enables high-reliability mode. false (default): disables high-reliability mode. Note This parameter is supported only by the client SDK V1.5.1 and later. When you send a message to a client with an earlier SDK version, the message can be successfully sent without waiting for an acknowledgement (ACK) response.	false
Storage	boolean	No	Specifies whether to store the message. true: stores the message. false (default): does not store the message.	false

Response elements

Element	Type	Description	Example
	object	The response parameters.
RequestId	string	The request ID.	6CFDE7AB-571A-14EA-B072-989FF753****
MsgTid	string	The unique message ID, which can be used to delete the message. The ID can be up to 64 bytes in length and can contain letters and digits.	169830****

Examples

Success response

JSON format

{
  "RequestId": "6CFDE7AB-571A-14EA-B072-989FF753****",
  "MsgTid": "169830****"
}

Error codes

HTTP status code	Error code	Error message	Description
400	InputInvalid	%s.	Illegal input parameters
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
408	UserNotAck	%s.	Send a highly reliable message to the user, but the user does not respond.

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.