即时通信

添加好友

POST/im/v2/friends

请求参数

account_id

string

发起好友申请的云信账号 ID。

必需

friend_account_id

string

需要添加为好友的云信账号 ID。

必需

alias

string

好友的备注名

可选

长度上限 128 位字符。

message

string

需要对方验证的添加好友方式（type=2）时的显示文案，该字段需要过反垃圾审核。

可选

默认文案为"申请加好友"

extension

string

扩展字段

可选

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

server_extension

string

服务端扩展字段

可选

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

{
  "account_id": "apiv2test",
  "friend_account_id": "apiv2test2",
  "alias": "zhangsan",
  "message": "申请加好友",
  "extension": "string",
  "server_extension": "string"
}

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

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

data

object

返回数据

必需

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

friend_account_id

string

好友的云信账号 ID。

可选

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 个月前