Skip to content
💡 Want to test this API interactively? Open API Playground ↗

Get IM Messages ​

Retrieve instant messages with a specific buyer, with pagination support.

Basic Information ​

PropertyValue
MethodPOST
Path/seller/im/msg
AuthenticationBearer Token
Content-Typeapplication/json

Request Headers ​

HeaderTypeRequiredDescription
AuthorizationstringYesBearer <accessToken>

Request Body Parameters ​

ParameterTypeRequiredDescription
buyerIdintegerYesBuyer ID (can be null to fetch all)
minTimeintegerYesMinimum message time (UTC timestamp in seconds)
maxTimeintegerYesMaximum message time (UTC timestamp in seconds). When fetching next page, set to lastMsgTime of previous response
lastMsgKeystringNoMsgKey of the last message from previous fetch (required for pagination)

Request Example ​

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

{
  "buyerId": 1907369850568257537,
  "minTime": 1734400000,
  "maxTime": 1734500000
}

Response Parameters ​

ParameterTypeDescription
data.msgCntintegerNumber of messages returned
data.completeinteger1 = all messages fetched; 0 = more remain
data.lastMsgTimeintegerTimestamp of last message (milliseconds)
data.lastMsgKeystringMsgKey for fetching next page
data.msgListarrayMessage list
data.msgList[].fromAccountstringSender account
data.msgList[].toAccountstringReceiver account
data.msgList[].msgTimestampintegerMessage timestamp
data.msgList[].msgDateTimestringMessage datetime
data.msgList[].msgSeqintegerMessage sequence number
data.msgList[].msgRandomintegerMessage random number
data.msgList[].msgBodyarrayMessage body list
data.msgList[].msgBody[].msgTypestringMessage type
data.msgList[].msgBody[].msgContentstringMessage content

Success Response ​

json
{
  "code": "0000",
  "msg": "Success",
  "time": "2025-12-17T13:44:16.000Z",
  "data": {
    "msgCnt": 2,
    "complete": 1,
    "lastMsgTime": 1734443056000,
    "lastMsgKey": "msg-key-abc123",
    "msgList": [
      {
        "fromAccount": "seller_001",
        "toAccount": "1907369850568257537",
        "msgTimestamp": 1734443056,
        "msgDateTime": "2025-12-17 14:30:56",
        "msgSeq": 1,
        "msgRandom": 123456789,
        "msgBody": [
          {
            "msgType": "TIMTextElem",
            "msgContent": "{\"text\":\"Hello! Your order has been delivered.\"}"
          }
        ]
      }
    ]
  }
}

All game copyrights, trademarks, and service marks belong to their respective owners.