Domain name for API request: lcic.tencentcloudapi.com.
This API is used to get the message history of a room (room messages are retained for seven days).
A maximum of 20 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
Parameter Name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common Params. The value used for this API: GetRoomMessage. |
Version | Yes | String | Common Params. The value used for this API: 2022-08-17. |
Region | No | String | Common Params. This parameter is not required. |
SdkAppId | Yes | Integer | The SDKAppID assigned by LCIC. |
RoomId | Yes | Integer | The room ID. |
Seq | No | Integer | The starting message sequence. Messages before this sequence will be returned (not including the message whose sequence is seq ). |
Limit | No | Integer | The maximum number of messages to return. The value of this parameter cannot exceed the maximum message count allowed by your package. |
Parameter Name | Type | Description |
---|---|---|
Messages | Array of MessageList | The message list. |
RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
This example shows you how to get the message history of a room.
POST / HTTP/1.1
Host: lcic.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: GetRoomMessage
<Common request parameters>
{
"SdkAppId": 0,
"RoomId": 1,
"Seq": 0,
"Limit": 1
}
{
"Response": {
"Messages": [
{
"Timestamp": 0,
"FromAccount": "abc",
"Seq": 0,
"MessageBody": [
{
"MessageType": 0,
"TextMessage": "abc",
"ImageMessage": "abc"
}
]
}
],
"RequestId": "abc"
}
}
TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
FailedOperation.ClassEnded | Room status error. The room has ended. |
FailedOperation.ClassExpired | Room status error. The room has expired. |
FailedOperation.ClassStarted | Class status error. The class has already started. |
FailedOperation.RoomNotEnd | The class has not ended. |
InternalError | Internal error. |
InvalidParameter | Invalid parameter. |
InvalidParameter.SdkAppId | SdkAppId is incorrect. |
InvalidParameterValue | Invalid parameter value. |
MissingParameter | Missing parameter. |
ResourceNotFound | The resource doesn’t exist. |
ResourceNotFound.Room | The room does not exist. |
ResourceUnavailable.RoomStatistics | Getting room data. Please wait. |
UnknownParameter | Unknown parameter error. |
UnsupportedOperation | Unsupported operation. |
Was this page helpful?