human: 如何处理七牛云的即时通讯好友管理接口

gpt: [即时通讯](https://developer.qiniu.com/IM) > API 文档 >
[服务端API](https://developer.qiniu.com/IM/api/8094/im-server-api-reference) >
好友管理接口

#  好友管理接口

最近更新时间: 2021-06-29 09:48:15

# 好友管理接口

## 拒绝好友申请

### 基本信息

**Path：** /roster/decline

**Method：** PUT

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Body**

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
reason| string| 非必须| | 拒绝的原因|   
user_id| integer| 必须| | 拒绝的用户ID| format: int64  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 从黑名单移除

### 基本信息

**Path：** /roster/unblock

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 删除好友

### 基本信息

**Path：** /roster/delete

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 删除好友

### 基本信息

**Path：** /roster/delete

**Method：** DELETE

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 同意好友申请

### 基本信息

**Path：** /roster/accept

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 同意好友申请

### 基本信息

**Path：** /roster/accept

**Method：** PUT

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 好友列表

### 基本信息

**Path：** /roster/list

**Method：** GET

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
cursor | 否 |  | cursor  
limit | 否 |  | limit  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
cursor| string| 非必须| | 游标，返回结果中缺失 cursor，表示已经返回最后一页|   
data| integer []| 非必须| | 结果数据| item 类型: integer  
├─ | | 非必须| | |   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
version| integer| 非必须| | 版本| format: int64  
  
## 好友申请列表

### 基本信息

**Path：** /roster/apply/list

**Method：** GET

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
cursor | 否 |  | cursor  
limit | 否 |  | limit  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
cursor| string| 非必须| | 游标，返回结果中缺失 cursor，表示已经返回最后一页|   
data| object []| 非必须| | 结果数据| item 类型: object  
├─ expired_time| integer| 非必须| | 过期时间| format: int64  
├─ reason| string| 非必须| | 申请描述|   
├─ status| integer| 非必须| | | format: int32  
├─ user_id| integer| 非必须| | 发起加好友申请的用户ID| format: int64  
message| string| 非必须| | 错误信息，如果成功，该项为null|   
version| integer| 非必须| | 版本| format: int64  
  
## 好友详情列表

### 基本信息

**Path：** /roster/list

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Body**

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
list| integer []| 非必须| | | item 类型: integer  
├─ | | 非必须| | |   
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| object []| 非必须| | 结果数据| item 类型: object  
├─ alias| string| 非必须| | |   
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32  
├─ auth_question| string| 非必须| | 验证问题|   
├─ avatar| string| 非必须| | 头像|   
├─ description| string| 非必须| | 描述信息|   
├─ ext| string| 非必须| | |   
├─ mute_notification| boolean| 非必须| | |   
├─ nick_name| string| 非必须| | 昵称或名称|   
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|   
├─ relation| integer| 非必须| | | format: int32  
├─ user_id| integer| 非必须| | 好友用户ID| format: int64  
├─ username| string| 非必须| | 用户名|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 批量添加好友

### 基本信息

**Path：** /roster/apply/batch

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Body**

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
| object []| 非必须| | | item 类型: object  
├─ alias| string| 非必须| | 备注名称|   
├─ reason| string| 非必须| | 申请描述|   
├─ user_id| integer| 必须| | 被申请用户 ID| format: int64  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| object| 非必须| | 批量添加好友返回结果|   
├─ fails| object []| 非必须| | | item 类型: object  
├─ reason| string| 非必须| | 失败原因|   
├─ user_id| integer| 非必须| | 用户ID| format: int64  
├─ success| integer []| 非必须| | | item 类型: integer  
├─ | | 非必须| | |   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 拒绝好友申请

### 基本信息

**Path：** /roster/decline

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Body**

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
reason| string| 非必须| | 拒绝的原因|   
user_id| integer| 必须| | 拒绝的用户ID| format: int64  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 从黑名单移除

### 基本信息

**Path：** /roster/unblock

**Method：** DELETE

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 是否允许发消息

### 基本信息

**Path：** /roster/may_message

**Method：** GET

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
roster_id | 是 |  | roster_id  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 更新好友扩展信息

### 基本信息

**Path：** /roster/ext

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Body**

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
alias| string| 非必须| | 备注名称|   
ext| string| 非必须| | 扩展信息|   
mute_notification| boolean| 非必须| | 是否接收消息提醒|   
user_id| integer| 必须| | 好友用户ID| format: int64  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 更新好友扩展信息

### 基本信息

**Path：** /roster/ext

**Method：** PUT

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Body**

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
alias| string| 非必须| | 备注名称|   
ext| string| 非必须| | 扩展信息|   
mute_notification| boolean| 非必须| | 是否接收消息提醒|   
user_id| integer| 必须| | 好友用户ID| format: int64  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 添加黑名单

### 基本信息

**Path：** /roster/block

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 添加黑名单

### 基本信息

**Path：** /roster/block

**Method：** PUT

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | user_id  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 用ID搜索用户

### 基本信息

**Path：** /roster/id

**Method：** GET

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
user_id | 是 |  | 用户ID  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| object| 非必须| | 好友列表|   
├─ alias| string| 非必须| | |   
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32  
├─ auth_question| string| 非必须| | 验证问题|   
├─ avatar| string| 非必须| | 头像|   
├─ description| string| 非必须| | 描述信息|   
├─ ext| string| 非必须| | |   
├─ mute_notification| boolean| 非必须| | |   
├─ nick_name| string| 非必须| | 昵称或名称|   
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|   
├─ relation| integer| 非必须| | | format: int32  
├─ user_id| integer| 非必须| | 好友用户ID| format: int64  
├─ username| string| 非必须| | 用户名|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 用手机号搜索用户

### 基本信息

**Path：** /roster/mobile

**Method：** GET

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
mobile | 是 |  | mobile  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| object| 非必须| | 好友列表|   
├─ alias| string| 非必须| | |   
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32  
├─ auth_question| string| 非必须| | 验证问题|   
├─ avatar| string| 非必须| | 头像|   
├─ description| string| 非必须| | 描述信息|   
├─ ext| string| 非必须| | |   
├─ mute_notification| boolean| 非必须| | |   
├─ nick_name| string| 非必须| | 昵称或名称|   
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|   
├─ relation| integer| 非必须| | | format: int32  
├─ user_id| integer| 非必须| | 好友用户ID| format: int64  
├─ username| string| 非必须| | 用户名|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 用用户名搜索用户

### 基本信息

**Path：** /roster/name

**Method：** GET

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Query**

参数名称 | 是否必须 | 示例 | 备注  
---|---|---|---  
username | 是 |  | username  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| object| 非必须| | 好友列表|   
├─ alias| string| 非必须| | |   
├─ auth_mode| integer| 非必须| | 验证方式, 0 - 无需验证，任何人可以加为好友, 1 - 需要同意方可加为好友, 2 - 需要回答问题正确方可加为好友, 3 - 拒绝所有加好友申请| format: int32  
├─ auth_question| string| 非必须| | 验证问题|   
├─ avatar| string| 非必须| | 头像|   
├─ description| string| 非必须| | 描述信息|   
├─ ext| string| 非必须| | |   
├─ mute_notification| boolean| 非必须| | |   
├─ nick_name| string| 非必须| | 昵称或名称|   
├─ public_info| string| 非必须| | 公开信息，好友和陌生人可见|   
├─ relation| integer| 非必须| | | format: int32  
├─ user_id| integer| 非必须| | 好友用户ID| format: int64  
├─ username| string| 非必须| | 用户名|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 申请加好友

### 基本信息

**Path：** /roster/apply

**Method：** POST

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
Content-Type | application/json | 是 |  |   
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
**Body**

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
alias| string| 非必须| | 备注名称|   
auth_answer| string| 非必须| | 问题答案|   
reason| string| 非必须| | 申请描述|   
user_id| integer| 必须| | 被申请用户 ID| format: int64  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| boolean| 非必须| | 结果数据|   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
## 黑名单列表

### 基本信息

**Path：** /roster/blocked_list

**Method：** GET

**接口描述：**

### 请求参数

**Headers**

参数名称 | 参数值 | 是否必须 | 示例 | 备注  
---|---|---|---|---  
access-token |  | 否 |  | 令牌  
app_id |  | 是 |  | 应用ID  
group_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此群ID的管理员身份来调用此接口  
user_id |  | 否 |  | 仅当access-token为管理员token时，可以设置此字段，表示以此用户ID的身份来调用此接口  
  
### 返回数据

名称| 类型| 是否必须| 默认值| 备注| 其他信息  
---|---|---|---|---|---  
code| integer| 非必须| | 返回码，200是成功| format: int32  
data| integer []| 非必须| | 结果数据| item 类型: integer  
├─ | | 非必须| | |   
message| string| 非必须| | 错误信息，如果成功，该项为null|   
  
以上内容是否对您有帮助？