Get IM Contact List

Retrieve the list of buyer IM sessions (contacts) with pagination support.

Basic Information

Property	Value
Method	POST
Path	/seller/im/contact/buyer/list
Authentication	Bearer Token
Content-Type	application/json

Request Headers

Header	Type	Required	Description
Authorization	string	Yes	Bearer <accessToken>

Request Body Parameters

Parameter	Type	Required	Description
startTimeStamp	integer	Yes	Start timestamp of regular sessions. Enter 0 for the first page
startIndex	integer	Yes	Starting position of regular sessions. Enter 0 for the first page
topStartTimeStamp	integer	Yes	Start time of pinned sessions. Enter 0 for the first page
topStartIndex	integer	Yes	Starting position of pinned sessions. Enter 0 for the first page

Request Example

POST /merchant-api/seller/im/contact/buyer/list HTTP/1.1
Host: paas-gateway.imetastore.io
Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...
Content-Type: application/json

{
  "startTimeStamp": 0,
  "startIndex": 0,
  "topStartTimeStamp": 0,
  "topStartIndex": 0
}

Response Parameters

Parameter	Type	Description
data.sessionItems	array	Array of session objects
data.sessionItems[].buyerId	string	Buyer ID
data.sessionItems[].name	string	Buyer name
data.sessionItems[].avatar	string	Buyer avatar URL
data.sessionItems[].msgTime	integer	Last message timestamp
data.sessionItems[].topFlag	integer	Pinned flag
data.completeFlag	integer	1 = all sessions returned; 0 = more remain
data.timeStamp	integer	Start time for next page of regular sessions
data.startIndex	integer	Start position for next page of regular sessions
data.topTimeStamp	integer	Start time for next page of pinned sessions
data.topStartIndex	integer	Start position for next page of pinned sessions

Success Response

{
  "code": "0000",
  "msg": "Success",
  "time": "2025-12-17T13:44:16.000Z",
  "data": {
    "sessionItems": [
      {
        "buyerId": "1907369850568257537",
        "name": "buyer123",
        "avatar": "https://example.com/avatar.png",
        "msgTime": 1734443056,
        "topFlag": 0
      }
    ],
    "completeFlag": 1,
    "timeStamp": 0,
    "startIndex": 0,
    "topTimeStamp": 0,
    "topStartIndex": 0
  }
}