Get Chat Session List

HTTP Request

POST /v5/p2p/chat/session/list_v1

Request Parameters

Parameter	Required	Type	Comments
lastId	true	integer	Cursor for pagination. Pass 0 for the first page
size	true	integer	Page size
readStatus	true	integer	Read status filter 0: unread 1: read 2: all
type	false	string	Session type GROUP: group chat SINGLE: single chat

Response Parameters

Parameter	Type	Comments
chatSession	array<object>	Session list
> sessionName	string	Session name, counterparty nickname
> sessionId	string	Session ID, AES encrypted
> type	string	Session type, SINGLE: single chat
> id	integer	Record ID, used as cursor for next page
> unreadCount	integer	Unread message count

Request Example

HTTP

POST /v5/p2p/chat/session/list_v1 HTTP/1.1
Host: api-testnet.bybit.com
X-BAPI-SIGN: XXXXXX
X-BAPI-API-KEY: xxxxxxxxxxxxxxxxxx
X-BAPI-TIMESTAMP: 1741832094881
X-BAPI-RECV-WINDOW: 5000
Content-Type: application/json

{
    "lastId": 0,
    "size": 10,
    "readStatus": 2
}

Python

from pybit.unified_trading import HTTP
api = HTTP(
    testnet=True,
    api_key="xxxxxxxxxxxxxxxxxx",
    api_secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
)
print(api.query_chat_session_list(
    lastId=0,
    size=10,
    readStatus=2
))

Response Example

{
    "ret_code": 0,
    "ret_msg": "",
    "result": {
        "chatSession": [
            {
                "sessionName": "TestUser",
                "sessionId": "aes_encrypted_session_id",
                "type": "SINGLE",
                "id": "128",
                "unreadCount": "5"
            },
            {
                "sessionName": "AnotherUser",
                "sessionId": "aes_encrypted_session_id_2",
                "type": "SINGLE",
                "id": "96",
                "unreadCount": "0"
            }
        ]
    }
}