Developer Center

开放接口文档

基础域名:https://work.yueqiancloud.com(生产)

接口默认 Content-Type 为 application/json。请求体中的 robotId 为必填。

接口总览

方法 路径 说明
POST/send下发指令到机器人(核心入口)
POST/robot/issue签发机器人 ID(生产环境)
POST/robot/verify校验机器人 ID 是否有效
GET/POST/runtime/config获取当前运行环境配置(Host/端口)

1) 下发指令:POST /send

请求体通用字段

  • robotId:机器人 ID(必填)
  • list:指令数组(必填)
  • encryptType:0 明文,1 AES(可选)
  • messageId:自定义消息 ID(可选)
  • meta:透传信息(可选)

常用 type

type含义用途
201停止并回到首页重置执行状态
202循环接收新消息常驻监听新消息
203发送消息向目标群/人发送文本等
204回复消息对指定消息做回复
227逐条转发消息逐条分发
228合并转发消息合并后分发

示例:开启循环接收新消息(202)

curl -X POST "https://work.yueqiancloud.com/send" \
  -H "Content-Type: application/json" \
  -d '{
    "robotId":"YOUR_ROBOT_ID",
    "list":[{"type":202}]
  }'

示例:停止并回到首页(201)

curl -X POST "https://work.yueqiancloud.com/send" \
  -H "Content-Type: application/json" \
  -d '{
    "robotId":"YOUR_ROBOT_ID",
    "list":[{"type":201}]
  }'

2) 签发机器人 ID:POST /robot/issue

生产环境需要在 Header 传 X-Robot-Secret,并传入未来时间戳 expires_at

curl -X POST "https://work.yueqiancloud.com/robot/issue" \
  -H "Content-Type: application/json" \
  -H "X-Robot-Secret: YOUR_SECRET" \
  -d '{"expires_at":1893456000}'

3) 校验机器人 ID:POST /robot/verify

curl -X POST "https://work.yueqiancloud.com/robot/verify" \
  -H "Content-Type: application/json" \
  -d '{"robotId":"YOUR_ROBOT_ID"}'

4) 运行配置:GET /runtime/config

curl "https://work.yueqiancloud.com/runtime/config"

返回当前环境、WS Host、管理端 URL,可用于客户端自动同步 Host。

如需完整接口枚举,可结合项目内 worktool/docs/apifox_admin_send.apifox.json 做二次生成。