jtf

Updated 环信添加好友系列接口 (markdown)

@@ -10,6 +10,8 @@ @@ -10,6 +10,8 @@
10 10
11 1.该用户没有加入任何班级 11 1.该用户没有加入任何班级
12 12
  13 +status:403
  14 +
13 ```json 15 ```json
14 { 16 {
15 "message": "该用户没有加入班级" 17 "message": "该用户没有加入班级"
@@ -17,6 +19,9 @@ @@ -17,6 +19,9 @@
17 ``` 19 ```
18 20
19 2.成功建立好友关系 21 2.成功建立好友关系
  22 +
  23 +status:200
  24 +
20 ```json 25 ```json
21 { 26 {
22 "message": "success" 27 "message": "success"
@@ -39,6 +44,9 @@ @@ -39,6 +44,9 @@
39 |currentPage |否 |分页,当前页,从0开始,默认为0| 44 |currentPage |否 |分页,当前页,从0开始,默认为0|
40 45
41 **返回值:** 46 **返回值:**
  47 +
  48 +status:200
  49 +
42 ```json 50 ```json
43 { 51 {
44 "totalCount": 3, 52 "totalCount": 3,
@@ -90,6 +98,9 @@ @@ -90,6 +98,9 @@
90 **返回值:** 98 **返回值:**
91 99
92 1.添加自己为好友 100 1.添加自己为好友
  101 +
  102 +status:403
  103 +
93 ```json 104 ```json
94 { 105 {
95 "message": "您不能添加自己为好友" 106 "message": "您不能添加自己为好友"
@@ -97,12 +108,18 @@ @@ -97,12 +108,18 @@
97 ``` 108 ```
98 109
99 2.对方已经是你的好友 110 2.对方已经是你的好友
  111 +
  112 +status:304
  113 +
100 ```json 114 ```json
101 { 115 {
102 "message": "对方已是您的好友" 116 "message": "对方已是您的好友"
103 } 117 }
104 ``` 118 ```
105 3.发送成功 119 3.发送成功
  120 +
  121 +status:200
  122 +
106 ```json 123 ```json
107 { 124 {
108 "message": "申请成功,请等待回复。" 125 "message": "申请成功,请等待回复。"
@@ -122,12 +139,18 @@ @@ -122,12 +139,18 @@
122 **返回值:** 139 **返回值:**
123 140
124 1.删除成功 141 1.删除成功
  142 +
  143 +status:200
  144 +
125 ```json 145 ```json
126 { 146 {
127 "message": "success" 147 "message": "success"
128 } 148 }
129 ``` 149 ```
130 2.删除失败 150 2.删除失败
  151 +
  152 +status:403
  153 +
131 ```json 154 ```json
132 { 155 {
133 "message": "failed" 156 "message": "failed"
@@ -143,24 +166,40 @@ @@ -143,24 +166,40 @@
143 166
144 参数: 167 参数:
145 168
146 -|参数 |是否必须 | 说明 | 169 +|参数 |是否必须 | 说明 |
147 |-------|-----------|--------------| 170 |-------|-----------|--------------|
148 |user_id|是 |被修改的用户的id| 171 |user_id|是 |被修改的用户的id|
149 |alias |是 |备注名称 | 172 |alias |是 |备注名称 |
150 **返回值:** 173 **返回值:**
151 1.设置成功 174 1.设置成功
  175 +
  176 +status:200
  177 +
152 ```json 178 ```json
153 { 179 {
154 "message": "success" 180 "message": "success"
155 } 181 }
156 ``` 182 ```
157 2.设置失败 183 2.设置失败
  184 +
  185 +status:403
  186 +
158 ```json 187 ```json
159 { 188 {
160 "message": "failed" 189 "message": "failed"
161 } 190 }
162 ``` 191 ```
  192 +3.长度过长
  193 +
  194 +status:403
163 195
  196 +```json
  197 +
  198 +{
  199 + "message": "备注长度过长"
  200 +}
  201 +
  202 +```
164 -------------------------- 203 --------------------------
165 ####同意添加好友接口 204 ####同意添加好友接口
166 205
@@ -176,6 +215,8 @@ @@ -176,6 +215,8 @@
176 |{status} |是 |同意或拒绝,只能是accept或reject| 215 |{status} |是 |同意或拒绝,只能是accept或reject|
177 |message |否 |拒绝理由 | 216 |message |否 |拒绝理由 |
178 217
  218 +status:200
  219 +
179 220
180 ####获取通讯录接口(非新接口) 221 ####获取通讯录接口(非新接口)
181 222