即时通信

更新好友信息

PATCH/im/v2/friends/{account_id}

请求参数

Path 参数

account_id

string

必需

示例值:

{% mock 'string' %}

friend_account_id

string

需要更新信息的好友账号 ID。

必需

alias

string

好友的备注名

可选

长度上限 128 位字符。

extension

string

扩展字段

可选

客户端和服务端均可读写，长度上限 256 位字符。

server_extension

string

服务端扩展字段

可选

客户端只读，仅服务器可修改，长度上限 256 位字符。

{
  "friend_account_id": "apiv2test2",
  "alias": "name1",
  "extension": "string",
  "server_extension": "string"
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

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

data

object

返回数据

必需

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

friend_account_id

string

好友的云信账号。

可选

alias

string

好友的备注名。

可选

extension

string

扩展字段

可选

客户端和服务端均可读写。

server_extension

string

服务端扩展字段

可选

客户端只读，仅服务器可修改预留给开发者的扩展字段，建议封装成 JSON 格式。

{
  "code": 200,
  "msg": "success",
  "data": {
    "friend_account_id": "accid2",
    "alias": "name",
    "extension": "string",
    "server_extension": "string"
  }
}

最后修改时间： 9 个月前