Delete All User Messages
Brief Description
- Deletes all messages for a user on the server. This does not affect messages already synchronized on the client side.
Request Method
post
Request URL
{API_ADDRESS}/msg/user_clear_all_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
{
"userID": "3034068043",
"deleteSyncOpt": {
"isSyncSelf": true,
"isSyncOther": true
}
}
Field Name | Optional | Type | Description |
---|---|---|---|
userID | Required | string | User ID to delete messages for. |
deleteSyncOpt | Required | object | Options for synchronization of deleted messages. |
deleteSyncOpt.isSyncSelf | Optional | boolean | Whether to sync message deletion for the user themselves. |
deleteSyncOpt.isSyncOther | Optional | boolean | Whether to sync message deletion for others (the recipient). |
Success Response Example
{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}
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. |
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 |