即时通信

分页查询好友列表

GET/im/v2/friends

请求参数

Query 参数

account_id

string

可选

发起分页查询操作的云信账号 ID。

示例值:

accid1

page_token

string

可选

分页标识符（标识查询位置索引的字符串值），如果为空，则默认从第一条记录开始查询。对应上次分页查询返回的 next_token 值。

limit

string

可选

单页查询的数量上限，默认和最大值都为 100。

示例值:

100

示例代码

返回响应

成功(200)

HTTP 状态码: 200

内容格式: JSONapplication/json

code

integer

状态码

必需

200 表示请求成功。

msg

string

提示信息

必需

请求失败时返回错误信息，请求成功时返回 "success"。

data

object

返回数据

必需

返回的 JSON 数据对象，请求失败则返回空对象。

has_more

boolean

是否还有更多数据。

可选

next_token

string

分页标识符。

可选

items

array [object {4}]

返回的好友列表信息。

可选

{
  "code": 200,
  "msg": "success",
  "data": {
    "has_more": true,
    "next_token": "asdfrqwewqe",
    "items": [
      {
        "friend_account_id": "accid1",
        "alias": "name",
        "extension": "string",
        "server_extension": "string"
      },
      {
        "friend_account_id": "accid2",
        "alias": "name",
        "extension": "string",
        "server_extension": "string"
      }
    ]
  }
}

最后修改时间： 10 个月前