即时通信

删除会话

DELETE

/im/v2/conversations/{conversation_id}

请求参数

Path 参数

conversation_id

string

必需

需要删除的会话 ID。若传入的会话 ID 不存在会返回 414 错误码。

Query 参数

clear_message

boolean

可选

是否同步删除会话对应的历史消息。true：同步删除历史消息。false：只删除会话，保留历史消息。
true：同步删除历史消息。
false：只删除会话，保留历史消息。

Header 参数

AppKey

string

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request DELETE 'https://open.yunxinapi.com/im/v2/conversations/?clear_message=' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

必需

msg

string

必需

data

object

必需

示例

{
  "code": 0,
  "msg": "string",
  "data": {}
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

修改于 2024-02-21 09:37:50

更新会话

批量删除会话