外观
获取好友列表
约 181 字小于 1 分钟
2025-05-29
1. 接口地址
{$host}/im/friend/getList
2. 请求方式
GET
3. 请求参数
3.1 Header 参数
X-Token: 授权码
3.2 Query 参数
参数名 | 必填 | 类型 | 说明 |
---|---|---|---|
keywords | 否 | string | 关键词,搜索用户名 |
page | 否 | number | 当前页码,默认1 |
pageSize | 否 | number | 每页条数,默认20 |
4. 返回结果
参数名 | 类型 | 说明 |
---|---|---|
list | Array | 好友列表数组,数组元素为对象,格式如下 |
isComplete | Number | 是否请求完毕,1-请求完毕,0-未请求完毕 |
4.1 list 数组元素对象格式
参数名 | 类型 | 说明 |
---|---|---|
userId | string | 好友ID |
avatar | string | 好友头像 |
name | string | 好友名称 |
phone | string | 手机号 |
string | 邮箱地址 |