Query Chat Session List

Query chat session list.

tip

Rate limit:

• Global: 500 QPS
• Per User: 100 requests/second

HTTP Request

POST /v5/p2p/chat/session/list

Request Parameters

Parameter	Required	Type	Comments
size	true	integer	Page size
lastId	false	integer	ID of the last record on the previous page, used as pagination cursor
sessionId	false	string	Encrypted session ID
userMaskId	false	string	Masked user ID, obtained from order details (target_user_mask_id)

Response Parameters

Parameter	Type	Comments
chatSession	array	Object
> sessionName	string	Session display name
> sessionId	string	Session ID
> type	string	Session type. GROUP: Group chat (future version), SINGLE: Direct chat
> id	integer	Session record ID

Request Example

HTTP

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

{
    "lastId": 0,
    "size": 20,
    "userMaskId": "sc696b52c224f42e3b4e572fe3d732464"
}

Python

from bybit_p2p import P2P
api = P2P(
    testnet=True,
    api_key="xxxxxxxxxxxxxxxxxx",
    api_secret="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
)
print(api.query_chat_session_list(
    lastId=0,
    size=20,
    userMaskId="sc696b52c224f42e3b4e572fe3d732464"
))

Node.js

Response Example

{
  "ret_code": 0,
  "ret_msg": "SUCCESS",
  "result": {
    "chatSession": [
      {
        "sessionName": "kolya_3",
        "sessionId": "rl8BAkdDTQC57qWq17gyYWlJ7dOD/seTGnXTTYcKcutJMR40VoMaVRPgrH0mr1+MFFt6QcKZC5RS4g==",
        "type": "SINGLE",
        "id": "1994307488961036288"
      }
    ]
  },
  "ext_code": "",
  "ext_info": {},
  "time_now": "1773864599.696081"
}