Delete all messages from a one-to-one conversation user
Description
Call this API to delete all messages from a one-to-one conversation user.
Request method and endpoint
- Request method: POST
- Request endpoint:
https://zim-api.zego.im/?Action=ClearPeerMessage - Protocol: HTTPS
- QPS limit: 20 requests/second
Request parameters
The following request parameter list only shows the interface request parameters and some public parameters. For the complete list of public parameters, please refer to Accessing Server APIs - Public parameters.
| Parameter | Type | Required | Description |
|---|---|---|---|
| FromUserId | String | Yes | Delete all one-to-one messages sent by this user to ToUserId. |
| ToUserId | String | Yes | Message recipient user. |
Note
Example:
For a conversation between user A and B, if you want to delete all one-to-one messages from user A, set FromUserId to A and ToUserId to B; if you want to delete all one-to-one messages from user B, set FromUserId to B and ToUserId to A.
Request example
-
Request URL:
Untitledhttps://zim-api.zego.im/?Action=ClearPeerMessage &<Public request parameters>1 -
Request body:
Untitled{ "FromUserId": "user_a", "ToUserId": "user_b", }1
Response parameters
| Parameter | Type | Description |
|---|---|---|
| Code | Number | Return code. |
| Message | String | Description of the request result. |
| RequestId | String | Request ID. |
Response example
Untitled
{
"Code": 0,
"Message": "success",
"RequestId": "343649807833778782"
}
1
Return codes
Please refer to Return codes.