Toggle navigation
Toggle navigation
This project
Loading...
Sign in
liuming
/
developer-docs
Go to a project
Toggle navigation
Toggle navigation pinning
Projects
Groups
Snippets
Help
Project
Activity
Repository
Pipelines
Graphs
Issues
0
Merge Requests
0
Wiki
Network
Create a new issue
Builds
Commits
Authored by
jtf
2015-08-06 10:25:27 +0800
Browse Files
Options
Browse Files
Download
Email Patches
Plain Diff
Commit
721b0d5ecafcf03be5cd9ee2aa1987ba32c22a5e
721b0d5e
1 parent
3836e9ab
Created 环信添加好友系列接口 (markdown)
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
with
214 additions
and
0 deletions
环信添加好友系列接口.md
环信添加好友系列接口.md
0 → 100644
View file @
721b0d5
####班级同学建立好友关系接口
接口地址: /buildFriendship/class?access_token=ASLDFKJIWE
请求方式:GET
参数:user_id (用户id)
**返回值:**
1.
该用户没有加入任何班级
```
json
{
"message"
:
"该用户没有加入班级"
}
```
2.
成功建立好友关系
```
json
{
"message"
:
"success"
}
```
----------------------------------
####搜索好友接口
接口地址: /search/friend
请求方式:GET
参数:
|参数 |是否必须 |说明 |
|---------------|--------|--------------|
|keyWord |是 |搜索关键字 |
|currentPage |否 |分页,当前页,从0开始,默认为0|
**返回值:**
```
json
[
{
"easemob_nickname"
:
"愿那些年幸福的预兆只是个玩笑"
,
"user_type"
:
"STUDENT"
,
"nickname"
:
"愿那些年幸福的预兆只是个玩笑"
,
"easemob_username"
:
"5de6f7a36339ef5bedc3dc8741a1e222"
,
"id"
:
12938
,
"username"
:
"447900226@qq.com"
,
"realname"
:
"愿那些年幸福"
,
"figure_url"
:
"http://avatars.boxfish.cn/user/12938/figure/1423708364.jpg"
},
{
"easemob_nickname"
:
"447900227@qq.com"
,
"user_type"
:
"STUDENT"
,
"nickname"
:
null
,
"easemob_username"
:
"0bbeaf0242180c8abffb2b8dada5a9e4"
,
"id"
:
13463
,
"username"
:
"447900227@qq.com"
,
"realname"
:
null
,
"figure_url"
:
"http://avatars.boxfish.cn/user/13463/figure/1411345608.jpg"
},
{
"easemob_nickname"
:
"Fei"
,
"user_type"
:
"STUDENT"
,
"nickname"
:
null
,
"easemob_username"
:
"2b8ed17fbe7858c641d55ca03eb8ace3"
,
"id"
:
13465
,
"username"
:
"447900228@qq.com"
,
"realname"
:
"Fei"
,
"figure_url"
:
"http://avatars.boxfish.cn/user/13465/figure/1411346930.jpg"
}
]
```
-------------------------
####添加单个好友接口
接口地址:/buildFriendship/add
请求方式:POST
参数:
|参数 | 是否必须 |说明 |
|---------|-----------|----------------|
|user_id |是 |被添加好友的用户id|
|message |否 |申请理由 |
**返回值:**
1.
添加自己为好友
```
json
{
"message"
:
"您不能添加自己为好友"
}
```
2.
对方已经是你的好友
```
json
{
"message"
:
"对方已是您的好友"
}
```
3.
发送成功
```
json
{
"message"
:
"申请成功,请等待回复。"
}
```
------------------------
####删除好友接口
接口地址:/buildFriendship/delete
请求方式:DELETE
参数:user_id (被删除的好友的id)
**返回值:**
1.
删除成功
```
json
{
"message"
:
"success"
}
```
2.
删除失败
```
json
{
"message"
:
"failed"
}
```
----------------------
####修改好友备注接口
接口地址:/buildFriendship/alias
请求方式:POST
参数:
|参数 |是否必须 | 说明 |
|-------|-----------|--------------|
|user_id|是 |被修改的用户的id|
|alias |是 |备注名称 |
**返回值:**
1.
设置成功
```
json
{
"message"
:
"success"
}
```
2.
设置失败
```
json
{
"message"
:
"failed"
}
```
--------------------------
####同意添加好友接口
接口地址:/buildFriendship/{user}/{status}
请求方式:POST
参数:
|参数 |是否必须 |说明 |
|-----------|-----------|---------------|
|{user} |是 |用户id |
|{status} |是 |同意或拒绝,只能是accept或reject|
|message |否 |拒绝理由 |
####获取通讯录接口(非新接口)
接口地址:/user/relationship/easemob
请求方式:GET
参数:
|参数 |是否必须 |说明 |
|-------------|-----------------|----------------------|
|type |否 |默认为"STUDENT" |
|flag |否(默认为true) |返回值是否包含班级好友的标志:默认为true,表示返回值包含班级好友|
**返回值:**
```
json
[
{
"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"
}
]
```
...
...
Please
register
or
login
to post a comment