获取好友列表

POST

https://www.pushplus.plus/api/open/friend/list

请求参数

Header 参数

Content-Type

string

必需

示例值:

application/json

access-key

string

必需

获取到的AccessKey

示例值:

d7b******62f

Body 参数application/json

current

integer

当前所在分页数

可选

pageSize

integer

可选

每页大小，最大值为50

示例

{
  "current": 1,
  "pageSize": 20
}

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://www.pushplus.plus/api/open/friend/list' \
--header 'access-key: d7b******62f' \
--header 'Content-Type: application/json' \
--data-raw '{
  "current": 1,
  "pageSize": 20
}'

返回响应

🟢200成功

application/json

Body

code

integer

响应码

必需

data

object

响应数据

必需

list

array [object {10}]

好友列表

必需

pageNum

integer

当前页码

必需

pageSize

integer

分页大小

必需

pages

integer

总页数

必需

total

integer

总行数

必需

msg

string

响应说明

必需

示例

{
  "code": 200,
  "data": {
    "list": [
      {
        "id": 4,
        "friendId": 1322,
        "token": "f6bd32c07******a076f2e89aed4e92",
        "headImgUrl": "",
        "nickName": "昵称",        
        "emailStatus": 0,        
        "havePhone": 0,               
        "isFollow": 1,        
        "remark": "备注",
        "createTime": "2022-09-06 11:15:32"
      }
    ],
    "pageNum": 1,
    "pageSize": 1,
    "pages": 1,
    "total": 10
  },
  "msg": "执行成功"
}

修改于 2025-06-22 00:48:25

获取个人二维码

删除好友