即时通信

删除好友

DELETE

/im/v2/friends/{account_id}

请求参数

Path 参数

account_id

string

必需

发起删除好友的云信账号 ID。

示例值:

{% mock 'string' %}

Query 参数

friend_account_id

string

必需

需要删除的好友账号 ID。

delete_alias

boolean

可选

是否删除好友的备注信息。默认为 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 -g --request DELETE 'https://open.yunxinapi.com/im/v2/friends/{% mock '\''string'\'' %}?friend_account_id&delete_alias' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功

application/json

Body

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

请求失败时返回错误信息，请求成功时返回 "success"。

data

object

返回数据

必需

返回的 JSON 数据对象，请求失败则返回空对象。

示例

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

🟢200成功

🟢200请求参数错误

🟢200服务器错误

修改于 2024-02-26 02:27:28

添加好友

更新好友信息