即时通信

批量删除会话

DELETE

/im/v2/conversations/actions/conversation_ids

请求参数

Query 参数

conversation_ids

string

必需

需要删除的会话 ID 列表。最多操作 100 个会话。如果提供的会话列表中某个会话 ID 不存在，则返回删除成功的会话列表以及删除失败的会话列表。

clear_message

boolean

可选

是否同步删除会话对应的历史消息。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/actions/conversation_ids?conversation_ids=&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

必需

success_list

array[string]

删除成功的会话 ID 列表。

可选

删除成功的会话 ID 列表。

failed_list

array [object {3}]

删除失败的会话信息列表。

可选

删除失败的会话信息列表。

示例

{
  "code": 0,
  "msg": "string",
  "data": {
    "success_list": [
      "string"
    ],
    "failed_list": [
      {
        "conversation_id": "string",
        "error_code": 0,
        "error_msg": "string"
      }
    ]
  }
}

🟢200成功

🟢200请求参数错误

🟢200服务器错误

修改于 2024-02-21 09:44:16

删除会话

查询会话信息