Sends a message to a specified user. The user is 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. We recommend that you take note of this limit when you call this operation.
Try it now
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
live:SendLiveMessageUser |
create |
*Rtc
|
None | 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 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**** |
| DataCenter |
string |
No |
The data center. It must be the same as the data center that was 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 set the message as a highly reliable message. A highly reliable message ensures that 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.
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.
|
false |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
The response parameters. |
||
| RequestId |
string |
The request ID. |
6CFDE7AB-571A-14EA-B072-989FF753**** |
| MsgTid |
string |
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**** |
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.