Skip to main content

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 NameExample ValueOptionalTypeDescription
operationID1646445464564RequiredstringUsed for global trace tracking, suggested to use a unique timestamp per request
tokeneyJhbxxxx3XsRequiredstringAdmin token

Request Parameters Example

{
"userID": "3034068043",
"deleteSyncOpt": {
"isSyncSelf": true,
"isSyncOther": true
}
}
Field NameOptionalTypeDescription
userIDRequiredstringUser ID to delete messages for.
deleteSyncOptRequiredobjectOptions for synchronization of deleted messages.
deleteSyncOpt.isSyncSelfOptionalbooleanWhether to sync message deletion for the user themselves.
deleteSyncOpt.isSyncOtherOptionalbooleanWhether to sync message deletion for others (the recipient).

Success Response Example

{
"errCode": 0,
"errMsg": "",
"errDlt": ""
}

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.

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