Delete a conversation

Overview

You can use this API to delete a conversation on the server side.

Request method and endpoint

Request method: POST
Request URL: https://zim-api.zego.im/?Action=DeleteConv
Protocol: HTTPS
QPS limit: 20 requests/second

Request parameters

The following list only shows the request parameters for this interface and some common parameters. For a complete list of common parameters, please refer to Accessing Server APIs - Common parameters.

Parameter	Type	Required	Description
FromUserId	String	Yes	For one-to-one conversation: Enter the UserId of one conversation user. For group conversation: Enter the UserId of one group member.
ConvId	String	Yes	For one-to-one conversation: Enter the UserId of the other conversation user. For group conversation: Enter the GroupId of the group conversation.
ConvType	ConvType	Yes	Conversation type: 0: One-to-one conversation. 2: Group conversation.

Sample request

Request URL:

https://zim-api.zego.im/?Action=DeleteConv
&<Common request parameters>

https://zim-api.zego.im/?Action=DeleteConv
&<Common request parameters>

Request body:

{
    "ConvId": "userB",
    "ConvType": 0,
    "FromUserId": "userA"   
}

{
    "ConvId": "userB",
    "ConvType": 0,
    "FromUserId": "userA"   
}

Response parameters

Parameter	Type	Description
Code	Number	Return code.
Message	String	Description of the request result.
RequestId	String	Request ID.

Sample response

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "343649807833778782"
}

Return codes

The following list only shows the return codes related to the business logic of the interface. For a complete list of return codes, please refer to Return codes.

Return Code	Description	Solution
660000002	Invalid parameter.	The parameter entered is missing or invalid. Please check the parameters.