Search Message
Brief Description
- Search message.
Request Method
post
Request URL
{API_ADDRESS}/msg/search_msg
Header
Header Name | Example Value | Optional | Type | Description |
---|---|---|---|---|
operationID | 1646445464564 | Required | string | Used for global trace tracking, suggested to use a unique timestamp per request |
token | eyJhbxxxx3Xs | Required | string | Admin token |
Request Parameters Example
{
"sendID": "019825",
"recvID": "464588223",
"contentType": 101,
"sendTime": "2025-04-15",
"sessionType": 3,
"pagination": {
"pageNumber": 1,
"showNumber": 2
}
}
Field Name | Optional | Type | Description |
---|---|---|---|
sendID | Optional | string | Sender's user ID |
recvID | Optional | string | Receiver's user ID |
contentType | Optional | int | Content type |
sendTime | Optional | string | Message send time |
sessionType | Optional | int | Session type, 1: Single chat, 3: Group chat, 4: System notification |
pagination | Required | object | Pagination parameter structure |
pagination.pageNumber | Required | int | Current page number, starting from 1 |
pagination.showNumber | Required | int | Number 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 Name | Type | Description |
---|---|---|
errCode | int | Error code; 0 indicates success. |
errMsg | string | Brief error message, empty if none. |
errDlt | errDlt | Detailed error information, empty if none. |
data | object | General data object, structure detailed below. |
chatLogs | array | List of ChatLog |
chatLogs.chatLog | object | Chat Log |
chatLogs.isRevoked | bool | Whether the message was revoked. |
chatLogsNum | int | Total number of ChatLog. |
Failure Response Example
{
"errCode": 1004,
"errMsg": "RecordNotFoundError",
"errDlt": ": [1004]RecordNotFoundError"
}
Failure Response Parameters Description
Parameter Name | Type | Description |
---|---|---|
errCode | int | Error code, refer to global error code documentation |
errMsg | string | Brief error message |
errDlt | errDlt | Detailed error information |