####班级同学建立好友关系接口
接口地址: /friends_recommend/auto?access_token=ASLDFKJIWE
请求方式:POST
参数:user_id (用户id)
返回值:
1.该用户没有加入任何班级
status:403
{
"message": "该用户没有加入班级"
}
2.成功建立好友关系
status:200
{
"message": "success"
}
####老师将学生移动到班级时给该学生建立班级好友关系 接口地址: /friends_recommend/group
参数 | 是否必须 | 说明 |
---|---|---|
user_id | 是 | 学生id |
group_id | 是 | 班级id |
返回值:
1.建立成功:
status:200
{
"message": "success"
}
2.建立失败:
status:400
{
"message": "failed"
}
####搜索好友接口
接口地址: /search/friend
请求方式:GET
参数:
参数 | 是否必须 | 说明 |
---|---|---|
key_word | 是 | 搜索关键字 |
current_page | 否 | 分页,当前页,从0开始,默认为0 |
返回值:
status:200
{
"totalCount": 3,
"users": [
{
"user_type": "STUDENT",
"nickname": "愿那些年幸福的预兆只是个玩笑",
"id": 12938,
"username": "447900226@qq.com",
"realname": "愿那些年幸福",
"figure_url": "http://avatars.boxfish.cn/user/12938/figure/1423708364.jpg"
},
{
"user_type": "STUDENT",
"nickname": null,
"id": 13463,
"username": "447900227@qq.com",
"realname": null,
"figure_url": "http://avatars.boxfish.cn/user/13463/figure/1411345608.jpg"
},
{
"user_type": "STUDENT",
"nickname": null,
"id": 13465,
"username": "447900228@qq.com",
"realname": "Fei",
"figure_url": "http://avatars.boxfish.cn/user/13465/figure/1411346930.jpg"
}
]
}
####添加单个好友接口
接口地址:/friends_recommend/add
请求方式:POST
参数:
参数 | 是否必须 | 说明 |
---|---|---|
user_id | 是 | 被添加好友的用户id |
message | 否 | 申请理由 |
返回值:
1.添加自己为好友
status:403
{
"message": "您不能添加自己为好友"
}
2.对方已经是你的好友
status:304
{
"message": "对方已是您的好友"
}
3.发送成功
status:200
{
"message": "申请成功,请等待回复。"
}
####删除好友接口
接口地址:/friends_recommend/delete
请求方式:DELETE
参数:user_id (被删除的好友的id)
返回值:
1.删除成功
status:200
{
"message": "success"
}
2.删除失败
status:403
{
"message": "failed"
}
####修改好友备注接口
接口地址:/friends_recommend/alias
请求方式:POST
参数:
参数 | 是否必须 | 说明 |
---|---|---|
user_id | 是 | 被修改的用户的id |
alias | 是 | 备注名称 |
返回值: 1.设置成功
status:200
{
"message": "success"
}
2.设置失败
status:403
{
"message": "failed"
}
3.长度过长
status:403
{
"message": "备注长度过长"
}
####同意添加好友接口
接口地址:/friends_recommend/{user}/{status}
请求方式:POST
参数:
参数 | 是否必须 | 说明 |
---|---|---|
{user} | 是 | 用户id |
{status} | 是 | 同意或拒绝,只能是accept或reject |
message | 否 | 拒绝理由 |
status:200
####获取通讯录接口(非新接口)
接口地址:/user/relationship/easemob
请求方式:GET
参数:
参数 | 是否必须 | 说明 |
---|---|---|
type | 否 | 默认为"STUDENT" |
flag | 否(默认为true) | 返回值是否包含班级好友的标志:默认为true,表示返回值包含班级好友 |
返回值:
[
{
"id": 61727,
"username": "544043963@qq.com",
"nickname": "gang",
"easemob_username": "b8c1ca2bded145de5e4533ae4f9b3b35",
"type": "friend",
"user_type": "TEACHER",
"friend_from":"class",
"alias": "jack"
},
{
"id": 2,
"username": "teacher",
"real_name": "老师",
"easemob_username": "c81e728d9d4c2f636f067f89cc14862c",
"type": "friend",
"user_type": "TEACHER",
"friend_from":"class",
"alias": "rose"
}
]
####获取通知接口
接口地址:/notification/list
请求方式:GET
参数:
参数 | 是否必须 | 说明 |
---|---|---|
readed | 否 | (true或false) |
lastDate | 否 | 时间戳 |
返回值:
若不写参数,则返回当前用户所收到的所有未读通知。若写参数,则根据参数过滤结果并将过滤后的结果暴露给调用者。
[
{
"id": "4028804749b2270e0149b22dddd60000",
"source": {
"id": 3145,
"username": "123@q.com",
"realName": "Ji",
"figureUrl": null,
"type": "STUDENT"
},
"target": {
"id": 3144,
"username": "19911218@qq.com",
"realName": null,
"figureUrl": null,
"type": "STUDENT"
},
"type": "USER_RELATIONSHIP_APPLY或USER_RELATIONSHIP_DENY或USER_RELATIONSHIP_PASS或VERIFY_PASS或VERIFY_DENY",
"body": "通过",
"readed": false,
"createAt": "2014-11-15T06:39:51.000+0000",
"updateAt": "2014-11-15T06:39:51.000+0000",
"version": 0
}
]
####通知消费接口
接口地址:/notification/consume
请求方式:POST
参数:id (id为数组)
返回值:
success ok error 用户不存在或指定的消息ID参数不存在