tencent cloud

All product documents
Low-code Interactive Classroom
GetRoomMessage
Last updated: 2024-04-01 19:34:21
GetRoomMessage
Last updated: 2024-04-01 19:34:21

1. API Description

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.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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.

3. Output Parameters

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.

4. Example

Example1 Getting the message history of a room

This example shows you how to get the message history of a room.

Input Example

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
}

Output Example

{
    "Response": {
        "Messages": [
            {
                "Timestamp": 0,
                "FromAccount": "abc",
                "Seq": 0,
                "MessageBody": [
                    {
                        "MessageType": 0,
                        "TextMessage": "abc",
                        "ImageMessage": "abc"
                    }
                ]
            }
        ],
        "RequestId": "abc"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

7x24 Phone Support