StarBot
  1. api请求
StarBot
  • 文档必读
    • 文档说明
    • 风控说明
    • 使用说明
    • 版本对比
  • 监听回调事件
    • 登录的机器人->微信启动成功
    • 微信登录成功事件
    • 收到私聊消息事件
    • 收到群聊消息事件
    • 收到公众号消息事件
    • 收到转账事件
    • 收到撤回消息事件
    • 收到好友申请事件
    • 二维码收款事件
  • api请求
    • 获取群聊列表
      POST
    • 获取好友列表
      POST
    • 获取机器人信息
      POST
    • 发送文本消息
      POST
    • 回复引用文本消息
      POST
    • 回复引用文本消息-新
      POST
    • 发送图片消息
      POST
    • 发送xml消息
      POST
    • 发送文件消息
      POST
    • 发送动态表情GIF消息
      POST
    • 发送url卡片消息
      POST
    • 发送小程序消息
      POST
    • 发送音乐分享消息
      POST
    • 发送聊天记录消息
      POST
    • 发送名片消息
      POST
    • 发送名片xml消息
      POST
    • 获取机器人登录状态信息
      POST
    • 获取机器人登录二维码信息(存在bug)请转至买断版本
      POST
    • 同意好友申请
      POST
    • 添加好友
      POST
    • 从群里添加好友
      POST
    • 删除好友
      POST
    • 修改好友/群聊备注
      POST
    • 查询陌生账号信息
      POST
    • 查询好友/群聊信息
      POST
    • 退出群聊
      POST
    • 创建群聊
      POST
    • 查询群聊信息
      POST
    • 添加群成员
      POST
    • 邀请群成员
      POST
    • 移除群成员
      POST
    • 修改机器人群昵称
      POST
    • 查询群聊成员列表
      POST
    • 获取群成员昵称
      POST
    • 确认收款
      POST
    • 退还收款
      POST
    • 打开浏览器
      POST
    • 启动微信
      POST
    • 关闭微信
      POST
    • 获取机器人列表
      POST
    • 删除离线的机器人信息
      POST
    • 根据wxId获取机器人信息
      POST
    • 根据instanceId获取机器人信息
      POST
  1. api请求

获取好友列表

POST
http://localhost:10001/api/processor

请求参数

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
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST 'http://localhost:10001/api/processor' \
--header 'Content-Type: application/json' \
--data-raw '{
    "type": "getFriendList",
    "params": {
        "robotId": "机器人微信id",
        "instanceId": "机器人实例id",
        "cache": 1
    }
}'

返回响应

🟢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
  }
}
修改于 2024-10-16 10:33:25
上一页
获取群聊列表
下一页
获取机器人信息
Built with