logo
In-app Chat
ZIMAudio
On this page

DeleteConv

POST

https://zim-api.zego.im/

By calling this API, you can delete a conversation on the server side.

QPS Limit
20 times/s

Request

Query Parameters

    Action stringrequired

    Possible values: [DeleteConv]

    API prototype parameter

    https://zim-api.zego.im/?Action=DeleteConv

    AppId uint32required

    💡Public parameter. Application ID, assigned by ZEGOCLOUD. Get it from the ZEGOCLOUD Admin Console.

    SignatureNonce stringrequired

    💡Public parameter. A 16-character hexadecimal random string (hex encoding of 8-byte random number). Refer to Signature example for how to generate.

    Timestamp int64required

    💡Public parameter. Current Unix timestamp, in seconds. Refer to Signature example for how to generate, with a maximum error of 10 minutes.

    SignatureVersion stringrequired

    Possible values: [2.0]

    Default value: 2.0

    💡Public parameter. Signature version number.

    Signature stringrequired

    💡Public parameter. Signature, used to verify the legitimacy of the request. Refer to Signing the requests for how to generate an API request signature.

Body

required
    FromUserId stringrequired

    Possible values: <= 32 characters

    • One-on-one conversation: Pass in the UserId of 1 one-on-one chat user.
    • Group conversation: Pass in the UserId of 1 group chat member.
    ConvId stringrequired

    Possible values: <= 32 characters

    • One-on-one conversation: Pass in the UserId of the other one-on-one chat user.
    • Group conversation: Pass in the GroupId of the group conversation.
    ConvType numberrequired

    Possible values: [0, 2]

    Conversation type:

    • 0: One-on-one.
    • 2: Group.

Responses

OK
Schema
    Code number

    Return code.

    Return codeDescriptionSuggested Solution
    660000002Input parameter error.Please check the input parameters.
    Message string

    Description of the operation result.

    RequestId string

    Request ID.

Previous

Clear the unread message count of a conversation

Next

Register Bots

On this page

Back to top