在线文档

本地可调试接口中心

一个页面内查看接口目录、字段说明、curl 示例和在线调试结果。默认入口就是 https://mobilerpa.wymi.net。

服务地址https://mobilerpa.wymi.net

鉴权头X-Api-Token

接口数量16

规范文件https://mobilerpa.wymi.net/openapi.json

全局约定

这些规则对整套 Hub 接口都成立。

所有接口统一通过同一个 HTTP Header 做鉴权。
请求体和响应体统一使用 JSON。
产物上传仍通过 JSON 内的 Base64 字段完成。

系统接口

用于健康检查和读取系统基线信息。

GET /v1/system/baseline

读取系统基线信息

返回项目名、API 前缀、Android 包名和无障碍服务标识。

系统接口 X-Api-Token 无请求体

字段说明

该接口没有请求字段。

curl -X GET "https://mobilerpa.wymi.net/v1/system/baseline" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token"

{}

{
    "code": 200,
    "success": true,
    "message": "ok",
    "data": {
        "project": "Aegis Hub",
        "api_prefix": "/v1",
        "android_package": "com.aegis.agent",
        "accessibility_service": "com.google.android.accessibility.selecttospeak.SelectToSpeakService",
        "stage": "third-phase-prototype"
    }
}

点击“发送请求”后会在这里显示返回结果。

微信业务接口

面向外部业务系统的正式下单接口。

POST /v1/apps/wechat/private-message

创建微信私聊消息任务

向指定联系人发送一条文本消息。

微信业务接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_id	string	是	目标设备 ID
contact_name	string	是	联系人名称，兼容 recipient_name
message	string	是	消息内容
priority	integer	否	任务优先级，默认 100
timeout_seconds	integer	否	超时时间，默认 120 秒

curl -X POST "https://mobilerpa.wymi.net/v1/apps/wechat/private-message" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "contact_name": "张三",
      "message": "你好，这是一条联调消息。"
  }'

{
    "device_id": "android_001",
    "contact_name": "张三",
    "message": "你好，这是一条联调消息。"
}

{
    "code": 201,
    "success": true,
    "message": "wechat job created",
    "data": {
        "job_id": "job_20260409113000_ab12cd34",
        "status": "queued"
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/apps/wechat/group-message

创建微信群消息任务

向指定群聊发送一条文本消息。

微信业务接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_id	string	是	目标设备 ID
group_name	string	是	群名称，兼容 recipient_name
message	string	是	消息内容
priority	integer	否	任务优先级，默认 100
timeout_seconds	integer	否	超时时间，默认 120 秒

curl -X POST "https://mobilerpa.wymi.net/v1/apps/wechat/group-message" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "group_name": "项目同步群",
      "message": "今晚 8 点开始测试。"
  }'

{
    "device_id": "android_001",
    "group_name": "项目同步群",
    "message": "今晚 8 点开始测试。"
}

{
    "code": 201,
    "success": true,
    "message": "wechat job created",
    "data": {
        "job_id": "job_20260409113200_ef56ab78",
        "status": "queued"
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/apps/wechat/add-friend

创建微信加好友任务

通过手机号发起一次加好友请求。

微信业务接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_id	string	是	目标设备 ID
phone_number	string	是	手机号，兼容 phone / account
greeting_message	string	否	招呼语，默认 hello
remark_name	string	否	备注名
tag_name	string	否	标签名
priority	integer	否	任务优先级，默认 100
timeout_seconds	integer	否	超时时间，默认 180 秒

curl -X POST "https://mobilerpa.wymi.net/v1/apps/wechat/add-friend" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "phone_number": "13800138000",
      "greeting_message": "你好，我是小王。",
      "remark_name": "线索-小王",
      "tag_name": "follow-up"
  }'

{
    "device_id": "android_001",
    "phone_number": "13800138000",
    "greeting_message": "你好，我是小王。",
    "remark_name": "线索-小王",
    "tag_name": "follow-up"
}

{
    "code": 201,
    "success": true,
    "message": "wechat job created",
    "data": {
        "job_id": "job_20260409113400_2f7a93bd",
        "status": "queued"
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/apps/wechat/moments

创建朋友圈浏览点赞评论任务

执行朋友圈浏览、点赞和评论。当前正式接口固定按 like_then_comment 顺序执行双动作。

微信业务接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_id	string	是	目标设备 ID
browse_count	integer	否	处理的朋友圈条数，默认 1，最大 20；兼容 moments_count / count
like_enabled	boolean	否	是否开启点赞，兼容 should_like
like_probability	integer	否	点赞概率，范围 0-100
comment_enabled	boolean	否	是否开启评论，兼容 should_comment
comment_probability	integer	否	评论概率，范围 0-100
comment_content	string	否	单条评论文案，兼容 comment
comment_contents	string	否	多条评论文案，使用 \|\| 分隔，兼容 comment_templates
comment_template_pool	string	否	JSON 字符串形式的评论模板池
wechat_account	string	否	账号维度去重
comment_scene	string	否	场景维度去重
comment_dedupe_minutes	integer	否	去重窗口分钟数
priority	integer	否	任务优先级，默认 100
timeout_seconds	integer	否	超时时间，默认 180 秒

当 comment_enabled=true 时，comment_content、comment_contents、comment_template_pool 至少提供一个。
服务端会固定写入 action_order=like_then_comment。

curl -X POST "https://mobilerpa.wymi.net/v1/apps/wechat/moments" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "browse_count": 2,
      "like_enabled": true,
      "like_probability": 100,
      "comment_enabled": true,
      "comment_probability": 100,
      "comment_contents": "1||收到||支持",
      "wechat_account": "wx_demo_a",
      "comment_scene": "default",
      "comment_dedupe_minutes": 30
  }'

{
    "device_id": "android_001",
    "browse_count": 2,
    "like_enabled": true,
    "like_probability": 100,
    "comment_enabled": true,
    "comment_probability": 100,
    "comment_contents": "1||收到||支持",
    "wechat_account": "wx_demo_a",
    "comment_scene": "default",
    "comment_dedupe_minutes": 30
}

{
    "code": 201,
    "success": true,
    "message": "wechat job created",
    "data": {
        "job_id": "job_20260409113600_a91e7c22",
        "status": "queued"
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/apps/wechat/moments/publish

创建微信朋友圈发布任务

创建微信朋友圈发布任务，支持 text_images / text_video / text_channel / text_article。

微信业务接口 X-Api-Token JSON 请求体

字段说明

文字+图片

publish_type text_images

必填：device_id、text、image_urls(或 material_ids/image_paths)

{
    "device_id": "android_001",
    "publish_type": "text_images",
    "text": "图文发布示例",
    "image_urls": [
        "https://example.com/a.jpg"
    ]
}

文字+视频

publish_type text_video

必填：device_id、text、video_urls(或 material_ids/video_paths)

{
    "device_id": "android_001",
    "publish_type": "text_video",
    "text": "视频发布示例",
    "video_urls": [
        "https://example.com/demo.mp4"
    ]
}

文字+视频号

publish_type text_channel

必填：device_id、text、channel_url

{
    "device_id": "android_001",
    "publish_type": "text_channel",
    "text": "视频号发布示例",
    "channel_url": "https://weixin.qq.com/sph/ApHUPRglE"
}

文字+公众号文章链接

publish_type text_article

必填：device_id、text、article_url

{
    "device_id": "android_001",
    "publish_type": "text_article",
    "text": "公众号文章发布示例",
    "article_url": "https://mp.weixin.qq.com/s/mZHMZ7NoSDN3_q3JOT5Tfw"
}

字段	类型	必填	说明
device_id	string	是	目标设备 ID
publish_type	string	否	支持 text_images \| text_video \| text_channel \| text_article
text	string	是	朋友圈文案
material_ids	array<string>\|string	否	素材 ID 列表，支持 JSON 数组或 \|\| / \| 分隔字符串
image_urls	array<string>\|string	否	图片 URL 列表，支持 JSON 数组或 \|\| / \| 分隔字符串
image_paths	array<string>\|string	否	预留：本地图片路径模式
video_urls	array<string>\|string	否	视频 URL 列表（text_video 模式）
video_url	string	否	video_urls 的单条兼容写法
video_paths	array<string>\|string	否	预留：本地视频路径模式
video_material_ids	array<string>\|string	否	video 发布时 material_ids 的兼容字段
channel_url	string	否	视频号链接（text_channel 模式）
video_channel_url	string	否	channel_url 的兼容字段
article_url	string	否	公众号文章链接（text_article 模式）
article_link	string	否	article_url 的兼容字段
mp_article_url	string	否	article_url 的兼容字段
public_article_url	string	否	article_url 的兼容字段
image_count	integer	否	图片数量，默认 3，最大 9
video_count	integer	否	视频数量，text_video 模式固定按 1 生效
priority	integer	否	任务优先级，默认 100
timeout_seconds	integer	否	任务超时时间，默认 300 秒
verify_publish_result	boolean	否	发布后是否回到朋友圈页面复验；默认 false，仅传 true 时启用

若提供 material_ids，Android 端优先按本地缓存素材解析。
若未提供 material_ids 但提供 image_urls，Hub 会尝试根据同设备历史成功记录映射 URL -> material_id。
提供 image_urls 时，Android 端会先下载到相册再进入微信。
text_video 当前支持单条视频 URL/路径/素材。
text_channel 必须提供 channel_url，走微信内视频号分享朋友圈链路。
text_article 必须提供 article_url，走微信内公众号文章分享朋友圈链路。
verify_publish_result 默认 false：发布后不再回朋友圈复验；仅传 true 时才执行发布结果复验。
兼容字段：video_url -> video_urls，video_material_ids -> material_ids，video_channel_url -> channel_url，article_link/mp_article_url/public_article_url -> article_url。
校验规则：text_images 需 material_ids/image_urls/image_paths 其一；text_video 需 material_ids/video_urls/video_paths 其一；text_channel 需 channel_url；text_article 需 article_url。
当前发布动作仍基于微信相册“最近可见项”选择，后续可在不改接口的情况下增强精确匹配。

curl -X POST "https://mobilerpa.wymi.net/v1/apps/wechat/moments/publish" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "publish_type": "text_article",
      "text": "text_article验收_文件传输助手中转",
      "article_url": "https://mp.weixin.qq.com/s/mZHMZ7NoSDN3_q3JOT5Tfw"
  }'

{
    "device_id": "android_001",
    "publish_type": "text_article",
    "text": "text_article验收_文件传输助手中转",
    "article_url": "https://mp.weixin.qq.com/s/mZHMZ7NoSDN3_q3JOT5Tfw"
}

{
    "code": 201,
    "success": true,
    "message": "微信任务创建成功",
    "data": {
        "job_id": "job_20260410103000_abc12345",
        "status": "queued"
    }
}

点击“发送请求”后会在这里显示返回结果。

GET /v1/jobs/{job_id}

查询任务详情

查询单个任务当前状态、最终页面、结果载荷和截图列表。

微信业务接口 X-Api-Token 无请求体

字段说明

字段	类型	必填	说明
job_id	string	是	任务 ID（路径参数）

加好友任务成功后可通过 data.result_payload.add_friend_result 判断最终业务结果。
当前 add_friend_result 可能返回 invalid_number / already_friend / request_sent。

curl -X GET "https://mobilerpa.wymi.net/v1/jobs/{job_id}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token"

{}

{
    "code": 200,
    "success": true,
    "message": "ok",
    "data": {
        "job_id": "job_20260410084216_326eabf5",
        "status": "succeeded",
        "success": true,
        "final_page": "已向 '15171438780' 发送好友申请",
        "result_payload": {
            "add_friend_result": "request_sent",
            "add_friend_result_label": "发起加好友成功",
            "target_phone_number": "15171438780",
            "greeting_message": "你好，我是小王",
            "remark_name": "线索-小王",
            "tag_name": "follow-up"
        },
        "screenshots": []
    }
}

点击“发送请求”后会在这里显示返回结果。

GET /v1/jobs/{job_id}/logs

查询任务日志

按任务 ID 查询结构化执行日志，默认返回最近 200 条。

微信业务接口 X-Api-Token 无请求体

字段说明

字段	类型	必填	说明
job_id	string	是	任务 ID（路径参数）
limit	integer	否	返回日志条数，默认 200，最大 2000

curl -X GET "https://mobilerpa.wymi.net/v1/jobs/{job_id}/logs" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token"

{}

{
    "code": 200,
    "success": true,
    "message": "ok",
    "data": {
        "job_id": "job_20260410084216_326eabf5",
        "status": "succeeded",
        "total": 5,
        "limit": 5,
        "logs": []
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/jobs/cancel

请求取消任务

把排队中或执行中的任务标记为待取消，设备稍后通过 pull-cancel 拉取。

微信业务接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
job_id	string	是	待取消任务 ID

curl -X POST "https://mobilerpa.wymi.net/v1/jobs/cancel" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "job_id": "job_20260409113600_a91e7c22"
  }'

{
    "job_id": "job_20260409113600_a91e7c22"
}

{
    "code": 200,
    "success": true,
    "message": "cancel request accepted",
    "data": {
        "job_id": "job_20260409113600_a91e7c22",
        "status": "queued",
        "cancel_requested": true,
        "cancel_requested_at": "2026-04-09T11:40:00+08:00"
    }
}

点击“发送请求”后会在这里显示返回结果。

设备同步接口

仅供 Android Agent 与 Hub 同步状态、拉任务和回传结果使用。

POST /v1/terminals/register

设备注册

登记设备实例并保存基础硬件信息。

设备同步接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_secret	string	是	设备密钥
device_info.device_id	string	是	设备 ID
device_info.install_id	string	是	安装实例 ID
device_info.brand	string	否	品牌
device_info.model	string	否	型号
device_info.android_version	string	否	Android 版本

curl -X POST "https://mobilerpa.wymi.net/v1/terminals/register" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_secret": "secret_001",
      "device_info": {
          "device_id": "android_001",
          "install_id": "install_001",
          "brand": "Xiaomi",
          "model": "Mi 14",
          "android_version": "15"
      }
  }'

{
    "device_secret": "secret_001",
    "device_info": {
        "device_id": "android_001",
        "install_id": "install_001",
        "brand": "Xiaomi",
        "model": "Mi 14",
        "android_version": "15"
    }
}

{
    "code": 201,
    "success": true,
    "message": "terminal registered",
    "data": {
        "device_id": "android_001",
        "registered": true
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/terminals/heartbeat

设备心跳

上报设备在线状态、当前页面和无障碍开关状态。

设备同步接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_secret	string	是	设备密钥
device_id	string	是	设备 ID
accessibility_enabled	boolean	否	无障碍状态
current_screen	string	否	当前页面描述

curl -X POST "https://mobilerpa.wymi.net/v1/terminals/heartbeat" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_secret": "secret_001",
      "device_id": "android_001",
      "accessibility_enabled": true,
      "current_screen": "wechat_moments"
  }'

{
    "device_secret": "secret_001",
    "device_id": "android_001",
    "accessibility_enabled": true,
    "current_screen": "wechat_moments"
}

{
    "code": 200,
    "success": true,
    "message": "heartbeat accepted",
    "data": {
        "device_id": "android_001",
        "server_time": "2026-04-09T12:00:00+08:00"
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/terminals/pull-job

拉取任务

设备主动拉取下一条待执行任务。

设备同步接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_secret	string	是	设备密钥
device_id	string	是	设备 ID

curl -X POST "https://mobilerpa.wymi.net/v1/terminals/pull-job" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_secret": "secret_001",
      "device_id": "android_001"
  }'

{
    "device_secret": "secret_001",
    "device_id": "android_001"
}

{
    "code": 200,
    "success": true,
    "message": "job dispatched",
    "data": {
        "job_id": "job_20260409113600_a91e7c22",
        "action_code": "browse_moments",
        "payload": {
            "browse_count": "2",
            "like_enabled": "true",
            "like_probability": "100"
        }
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/terminals/pull-cancel

拉取取消任务

设备查询是否存在待取消任务。

设备同步接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_secret	string	是	设备密钥
device_id	string	是	设备 ID

curl -X POST "https://mobilerpa.wymi.net/v1/terminals/pull-cancel" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_secret": "secret_001",
      "device_id": "android_001"
  }'

{
    "device_secret": "secret_001",
    "device_id": "android_001"
}

{
    "code": 200,
    "success": true,
    "message": "cancel list",
    "data": {
        "items": [
            {
                "job_id": "job_20260409113600_a91e7c22"
            }
        ]
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/terminals/report-job

回传任务结果

设备在任务完成、失败或取消后回传最终状态。

设备同步接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_secret	string	是	设备密钥
job_id	string	是	任务 ID
status	string	是	任务状态
success	boolean	否	是否成功
error_code	string	否	错误码
error_message	string	否	错误信息

curl -X POST "https://mobilerpa.wymi.net/v1/terminals/report-job" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_secret": "secret_001",
      "job_id": "job_20260409113600_a91e7c22",
      "status": "succeeded",
      "success": true
  }'

{
    "device_secret": "secret_001",
    "job_id": "job_20260409113600_a91e7c22",
    "status": "succeeded",
    "success": true
}

{
    "code": 200,
    "success": true,
    "message": "job report accepted",
    "data": {
        "job_id": "job_20260409113600_a91e7c22",
        "stored": true
    }
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/terminals/report-log

回传运行日志

设备回传结构化日志，供排障和审计使用。

设备同步接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_secret	string	是	设备密钥
device_id	string	是	设备 ID
level	string	是	日志级别
message	string	是	日志内容
context	object	否	附加上下文

curl -X POST "https://mobilerpa.wymi.net/v1/terminals/report-log" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_secret": "secret_001",
      "device_id": "android_001",
      "level": "info",
      "message": "moments task started",
      "context": {
          "job_id": "job_20260409113600_a91e7c22"
      }
  }'

{
    "device_secret": "secret_001",
    "device_id": "android_001",
    "level": "info",
    "message": "moments task started",
    "context": {
        "job_id": "job_20260409113600_a91e7c22"
    }
}

{
    "code": 200,
    "success": true,
    "message": "log accepted",
    "data": []
}

点击“发送请求”后会在这里显示返回结果。

POST /v1/terminals/upload-artifact

上传任务产物

上传截图、结构树或报告等调试产物。

设备同步接口 X-Api-Token JSON 请求体

字段说明

字段	类型	必填	说明
device_secret	string	是	设备密钥
device_id	string	是	设备 ID
job_id	string	是	任务 ID
file_name	string	是	文件名
mime_type	string	是	MIME 类型
content_base64	string	是	Base64 内容

curl -X POST "https://mobilerpa.wymi.net/v1/terminals/upload-artifact" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_secret": "secret_001",
      "device_id": "android_001",
      "job_id": "job_20260409113600_a91e7c22",
      "file_name": "succ.png",
      "mime_type": "image/png",
      "content_base64": "<base64>"
  }'

{
    "device_secret": "secret_001",
    "device_id": "android_001",
    "job_id": "job_20260409113600_a91e7c22",
    "file_name": "succ.png",
    "mime_type": "image/png",
    "content_base64": "<base64>"
}

{
    "code": 201,
    "success": true,
    "message": "artifact stored",
    "data": {
        "artifact_id": "artifact_20260409120500_93af"
    }
}

点击“发送请求”后会在这里显示返回结果。