网易云信 IM 服务端支持用户之间的好友关系管理。

添加好友

每个账号的好友数上限为 3000。

API 使用限制

单个应用默认最高调用频率：100 次/秒。如超限，将被屏蔽 10 秒。

URL

POST  https://api.netease.im/nimserver/friend/add.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考接口概述。
• POST 请求中 Body 的设置如下：

参数	类型	字符串长度上限	是否必填	示例	描述
accid	String	32	必填	zhangsan	添加好友的发起者accid
faccid	String	32	必填	lisi	添加好友的接收者accid
type	int	/	必填	1	1 直接加好友（无需对方同意）；2 请求加好友（需要对方同意）；3 同意加好友；4 拒绝加好友
msg	String	256	选填	我是xx	加好友对应的请求消息
serverex	String	256	选填	/	服务器端扩展字段 此字段 client 端只读，server 端读写

返回参数

参数	类型	示例	描述
code	int	200	状态码

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dn***803mgq3" -H "Nonce: 4tgggerg***23t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c***f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&faccid=lisi&type=1' 'https://api.netease.im/nimserver/friend/add.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200
}

更新好友相关信息

功能描述

修改好友相关信息，如添加备注。

API 使用限制

单个应用默认最高调用频率：100 次/秒。如超限，将被屏蔽 10 秒。

URL

POST  https://api.netease.im/nimserver/friend/update.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考接口概述。
• POST 请求中 Body 的设置如下：

参数	类型	字符串长度上限	是否必填	示例	描述
accid	String	32	必填	zhangsan	修改好友信息的用户accid
faccid	String	32	必填	lisi	被更新信息的用户accid
alias	String	128	选填	同事	给好友增加备注名，可设置为空字符串
ex	String	256	选填	/	修改ex字段，可设置为空字符串
serverex	String	256	选填	/	修改serverex字段，可设置为空字符串。此字段 client 端只读，server 端读写

返回参数

参数	类型	示例	描述
code	int	200	状态码

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dn***glw0803mgq3" -H "Nonce: 4tgggergig***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c***cc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&faccid=lisi&alias=lisi' 'https://api.netease.im/nimserver/friend/update.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200
}

删除好友关系

API 使用限制

单个应用默认最高调用频率：100 次/秒。如超限，将被屏蔽 10 秒。

URL

POST  https://api.netease.im/nimserver/friend/delete.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考接口概述。
• POST 请求中 Body 的设置如下：

参数名称	类型	字符串长度上限	是否必填	示例	描述
accid	String	32	必填	zhangsan	删除好友的发起者accid
faccid	String	32	必填	lisi	被删除的好友accid
isDeleteAlias	boolean	/	选填	true	是否需要删除备注信息 false:不需要,true:需要 默认为false

返回参数

参数	类型	示例	描述
code	int	200	状态码

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dnk***03mgq3" -H "Nonce: 4tg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3***55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&faccid=lisi' 'https://api.netease.im/nimserver/friend/delete.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200
}

获取好友列表

功能描述

查询某时间点起到现在有更新的好友列表。

API 使用限制

单个应用默认最高调用频率：100 次/秒。如超限，将被屏蔽 10 秒。

URL

POST  https://api.netease.im/nimserver/friend/get.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考接口概述。
• POST 请求中 Body 的设置如下：

参数	类型	字符串长度上限	是否必填	示例	描述
accid	String	32	必填	zhangsan	查询好友列表的发起者accid
updatetime	Long	64	必填	1440037706987	更新时间戳，接口返回该时间戳之后有更新的好友列表

返回参数

参数	类型	示例	描述
code	int	200	状态码
size	int	2	列表中的好友数量
friends	String	{"createtime":1440037706987, "bidirection":true, "faccid":"t2"}	更新的好友列表

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9dnk***803mgq3" -H "Nonce: 4tg***3t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6***c55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&createtime=1443599631111' 'https://api.netease.im/nimserver/friend/get.action'

返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "size":2,
    "friends":
    [
      {"createtime":1440037706987,"bidirection":true,"faccid":"t2"},
      {"createtime":1440037718190,"bidirection":true,"faccid":"t3","alias":"t3"}
    ]
}

获取好友关系

功能描述

根据用户账号查询好友关系。

API 使用限制

单个应用默认最高调用频率：100 次/秒。如超限，将被屏蔽 10 秒。

URL

POST  https://api.netease.im/nimserver/friend/getByAccid.action  HTTP/1.1
Content-Type: application/x-www-form-urlencoded;charset=utf-8

请求参数

• POST 请求中 Headers 的设置请参考接口概述。
• POST 请求中 Body 的设置如下：

参数	类型	字符串长度上限	是否必填	示例	描述
accid	String	32	必填	zhangsan	查询好友关系的发起者accid
faccid	String	32	必填	lisi	被查询好友关系的用户accid

返回参数

参数	类型	示例	描述
code	int	200	状态码
friend	JASON	{"createtime": 1440037706987,"ex": null,"bidirection": true, "faccid": "t2", "serverex": null,"updatetime": 1440037706987}	好友信息，包括： createtime：好友关系创建时间 ex：扩展字段 bidirection：双向好友标志 faccid：好友的云信IM账号 serverex：服务端扩展字段 updatetime：好友关系更新时间

示例

请求示例（curl）

curlcurl -X POST -H "AppKey: go9d***3mgq3" -H "Nonce: 4tgg***t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b***583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&faccid=lisi' 'https://api.netease.im/nimserver/friend/getByAccid.action'

好友关系存在的返回示例

json"Content-Type": "application/json; charset=utf-8"
{
    "code":200,
    "friend":
      {
        "createtime": 1440037706987,
        "ex": null,
        "bidirection": true,
        "faccid": "t2",
        "serverex": null,
        "updatetime": 1440037706987
      }
}

好友关系不存在的返回示例

如果非好友关系，则返回404状态码。

json"Content-Type": "application/json; charset=utf-8"
{
    "code":404,
}

状态码

上述接口在 HTTPS Body 中返回请求的状态码，状态码详情请参见状态码。