Skip to main content

Search Message

Brief Description

  • Search message.

Request Method

  • post

Request URL

  • {API_ADDRESS}/msg/search_msg
Header NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global trace tracking, suggested to use a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"sendID": "019825",
"recvID": "464588223",
"contentType": 101,
"sendTime": "2025-04-15",
"sessionType": 3,
"pagination": {
"pageNumber": 1,
"showNumber": 2
}
}
Field NameOptionalTypeDescription
sendIDOptionalstringSender's user ID
recvIDOptionalstringReceiver's user ID
contentTypeOptionalintContent type
sendTimeOptionalstringMessage send time
sessionTypeOptionalintSession type, 1: Single chat, 3: Group chat, 4: System notification
paginationRequiredobjectPagination parameter structure
pagination.pageNumberRequiredintCurrent page number, starting from 1
pagination.showNumberRequiredintNumber of items requested per page

Success Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": "",
"data": {
"chatLogs": [
{
"chatLog": {
"serverMsgID": "df8147686d3d5073e3e25952b7e68f48",
"clientMsgID": "cd2946aa5c3a0780ef145ece226880c6",
"sendID": "019825",
"recvID": "464588223",
"groupID": "464588223",
"recvNickname": "",
"senderPlatformID": 5,
"senderNickname": "xuzhijvn",
"senderFaceURL": "",
"groupName": "Test Group",
"sessionType": 3,
"msgFrom": 100,
"contentType": 101,
"content": "{\"content\":\"dasda\"}",
"status": 2,
"sendTime": 1744676086645,
"createTime": 1744676086155,
"ex": "",
"groupFaceURL": "",
"groupMemberCount": 24,
"seq": 1916,
"groupOwner": "",
"groupType": 2
},
"isRevoked": false
},
{
"chatLog": {
"serverMsgID": "7f5a3528b0f84ac4e15ca203e9a1ac29",
"clientMsgID": "77833db423190b98a2c1fd291c2075f1",
"sendID": "019825",
"recvID": "464588223",
"groupID": "464588223",
"recvNickname": "",
"senderPlatformID": 5,
"senderNickname": "xuzhijvn",
"senderFaceURL": "",
"groupName": "Test Group",
"sessionType": 3,
"msgFrom": 100,
"contentType": 101,
"content": "{\"content\":\"dasdasdasdasd\"}",
"status": 2,
"sendTime": 1744728041741,
"createTime": 1744728041465,
"ex": "",
"groupFaceURL": "",
"groupMemberCount": 24,
"seq": 1925,
"groupOwner": "",
"groupType": 2
},
"isRevoked": false
}
],
"chatLogsNum": 14
}
}

Success Response Parameters Description

Parameter NameTypeDescription
errCodeintError code; 0 indicates success.
errMsgstringBrief error message, empty if none.
errDlterrDltDetailed error information, empty if none.
dataobjectGeneral data object, structure detailed below.
chatLogsarrayList of ChatLog
chatLogs.chatLogobjectChat Log
chatLogs.isRevokedboolWhether the message was revoked.
chatLogsNumintTotal number of ChatLog.

Failure Response Example

{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}

Failure Response Parameters Description

Parameter NameTypeDescription
errCodeintError code, refer to global error code documentation
errMsgstringBrief error message
errDlterrDltDetailed error information