获取好友列表 - StarBot 标准版本买断

请求参数

Body 参数application/json

type

string

事件类型

必需

示例值:

getFriendList

params

object

必需

robotId

string

机器人微信ID

必需

示例值:

机器人微信id

instanceId

string

必需

实例Id，robotId和instanceId任意填写一个就可以

示例值:

机器人实例id

cache

integer

必需

是否从缓存中获取，1=从缓存中获取，0=重新遍历二叉树并刷新缓存

示例值:

1

示例

{
  "type": "getFriendList",
  "params": {
    "robotId": "机器人微信id",
    "instanceId": "机器人实例id",
    "cache": 1
  }
}

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'http://localhost:10001/api/processor' \
--header 'Content-Type: application/json' \
--data-raw ''

返回响应

🟢200成功

application/json

Body

code

integer

事件类型

必需

示例值:

200

data

object

必需

robotId

string

机器人微信ID

必需

示例值:

机器人微信id

instanceId

string

必需

实例Id，robotId和instanceId任意填写一个就可以

示例值:

机器人实例id

wxId

string

好友微信id

必需

示例值:

好友微信id

wxNum

string

好友微信号

必需

示例值:

好友微信号

nickname

string

好友昵称

必需

remark

string

好友备注

必需

示例值:

好友备注

v3

string

V3数据

必需

sex

integer

性别

必需

0=未知，1=男，2=女

示例值:

0

示例

{
  "code": 200,
  "data": {
    "robotId": "机器人微信id",
    "instanceId": "机器人实例id",
    "wxId": "好友微信id",
    "wxNum": "好友微信号",
    "nickname": "string",
    "remark": "好友备注",
    "v3": "string",
    "sex": 0
  }
}