List room's IM chat messages

1 Description

Lists all IM chat messages of a room.

2 Request method and endpoint

• Request method: POST

• Request address:

  Service environment	Rate limit	Endpoint
  Production	1 request/second	https://roomkit-api.zego.im/im/v2/list_history_records

• Transmission protocol: HTTPS

3 Request parameters

4 Sample request

{
    "secret_id": 1000001,
    "access_token": "access_token",
    "pid": 1200,
    "room_id": "19949235175",
    "offset": 2680
}

5 Response parameters

5.1 Text message object

5.2 Custom message object

6 Sample response

{
    "ret": {
        "code": 0,
        "message": "succeed",
        "version": ""
    },
    "data": {
        "size": 2694,
        "msgs": [
            {
                "sender": {
                    "uid": 100062163,
                    "nickname": "Elias",
                    "role": 32
                },
                "seq": 80567,
                "timestamp": 1617072080000,
                "body": {
                    "msg_type": "text",
                    "content": {
                        "text": "test 0_80567"
                    }
                }
            },
            {
                "sender": {
                    "uid": 100062163,
                    "nickname": "Elias",
                    "role": 32
                },
                "seq": 80568,
                "timestamp": 1617072081000,
                "body": {
                    "msg_type": "text",
                    "content": {
                        "text": "test 1_80568"}
                 }
             }
         ]
     }
}