用户关系托管

加好友

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

1.两人保持好友关系

参数说明

参数类型必须说明
accidString 加好友发起者accid
faccidString 加好友接收者accid
typeint 1直接加好友,2请求加好友,3同意加好友,4拒绝加好友
msgString 加好友对应的请求消息,第三方组装,最长256字符

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&faccid=lisi&type=1' 'https://api.netease.im/nimserver/friend/add.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


更新好友相关信息

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

1.更新好友相关信息,如加备注名,必须是好友才可以

参数说明

参数 类型 必须 说明
accid String 发起者accid
faccid String 要修改朋友的accid
alias String 给好友增加备注名,限制长度128
ex String 修改ex字段,限制长度256
serverex String 修改serverex字段,限制长度256
此字段client端只读,server端读写

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&faccid=lisi&alias=lisi' 'https://api.netease.im/nimserver/friend/update.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


删除好友

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

1.删除好友关系

参数说明

参数类型必须说明
accidString 发起者accid
faccidString 要删除朋友的accid

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&faccid=lisi' 'https://api.netease.im/nimserver/friend/delete.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


获取好友关系

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

1.查询某时间点起到现在有更新的双向好友

参数说明

参数类型必须说明
accidString 发起者accid
updatetimeLong 更新时间戳,接口返回该时间戳之后有更新的好友列表
createtimeLong 【Deprecated】定义同updatetime

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&createtime=1443599631111' 'https://api.netease.im/nimserver/friend/get.action'

返回说明

http 响应: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"}
    ]
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


设置黑名单/静音

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

拉黑/取消拉黑;设置静音/取消静音

参数说明

参数类型必须说明
accidString 用户帐号,最大长度32字符,必须保证一个
APP内唯一
targetAccString 被加黑或加静音的帐号
relationTypeint 本次操作的关系类型,1:黑名单操作,2:静音列表操作
valueint 操作值,0:取消黑名单或静音,1:加入黑名单或静音

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan&targetAcc=lisi&relationType=1&value=0' 'https://api.netease.im/nimserver/user/setSpecialRelation.action'

返回说明

http 响应:json

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

主要的返回码

200、403、414、416、431、500

具体请参考code状态表


查看指定用户的黑名单和静音列表

请求说明

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

请求中Headers的设置请参考接口概述

接口描述

查看用户的黑名单和静音列表

参数说明

参数类型必须说明
accidString 用户帐号,最大长度32字符,必须保证一个
APP内唯一

curl请求示例

curl -X POST -H "AppKey: go9dnk49bkd9jd9vmel1kglw0803mgq3" -H "Nonce: 4tgggergigwow323t23t" -H "CurTime: 1443592222" -H "CheckSum: 9e9db3b6c9abb2e1962cf3e6f7316fcc55583f86" -H "Content-Type: application/x-www-form-urlencoded" -d 'accid=zhangsan' 'https://api.netease.im/nimserver/user/listBlackAndMuteList.action'

返回说明

http 响应:json

"Content-Type": "application/json; charset=utf-8"
{
  "mutelist": [    //被静音的帐号列表
    "abc",
    "cde"
  ],
  "blacklist": [    //加黑的帐号列表
    "abc"
  ],
  "code": 200
}

主要的返回码

200、403、414、416、431、500

具体请参考code状态表