在线文档

本地可调试接口中心

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

查看上报数据
服务地址https://mobilerpa.wymi.net
鉴权头X-Api-Token
接口数量54
规范文件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"

在线调试

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

抖音业务接口

面向外部业务系统的抖音建单入口,当前先开放基础拉起动作。
POST /v1/apps/douyin/open
创建抖音打开任务
拉起抖音 App,验证设备能力声明、任务分发与无障碍链路是否正常。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
startup_wait_ms integer 拉起后等待时长,默认 1500ms
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,默认 90 秒
  • 当前版本先提供 open_douyin 基础动作,后续再叠加评论区、主页、私信等业务能力。
  • 该接口适合用于先验证 Hub -> Android Agent -> 真机 的链路是否正常。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/open" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "startup_wait_ms": 1500
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/close
关闭抖音 App
让 Android Agent 打开系统“抖音应用信息”页,点击“强行停止”并确认,效果对齐手动系统级强制停止;随后回到桌面。用于页面状态异常时彻底清理抖音前台/后台状态,再调用具体业务接口。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
settle_wait_ms integer 强停后回到桌面并等待的时长,默认 1000ms
force_stop_wait_ms integer 等待系统应用信息页出现“强行停止”按钮的时长,默认 6000ms
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,默认 90 秒
  • 该接口不是业务采集接口,只用于清理抖音运行状态。
  • Android action_code 为 close_douyin。
  • Android 端会打开系统应用信息页,点击“强行停止/强制停止/结束运行”并确认,等价于手动在系统设置里强行停止抖音。
  • 如果系统 ROM 不允许无障碍点击强停按钮,会返回 force_stop_clicked=false,并保留 killBackgroundProcesses 作为兜底。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/close" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/group-buy-leads
创建团购商家采集任务
打开抖音,进入团购页,打开搜索页并输入关键词,执行团购商家采集。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
keyword string 搜索关键词,默认火锅
collect_count integer 目标采集商家数,默认 0,当前最大 20
collect_merchant_count integer 目标采集商家数,兼容 collect_count,当前最大 20
collect_store_scheme boolean 是否进入商户详情页复制分享链接,并生成店铺 POI 快捷跳转地址 store_scheme/open_scheme
  • collect_store_scheme=true 时,会逐个进入店铺详情页,点击分享并复制店铺链接,解析 poi_id,生成 snssdk1128://poi/detail?id={poi_id}... 快捷地址。
  • 任务完成后可通过 GET /v1/jobs/{job_id} 查看 result_payload.items / collected_merchant_items;每条包含 store_name、share_url、resolved_url、poi_id、biz_code、store_scheme/open_scheme/poi_scheme、share_status、share_source。
  • 启用 collect_store_scheme 后,服务端会按采集数量自动放大默认超时时间;如需更长时间仍可传 timeout_seconds。
  • 当前版本覆盖首页 -> 团购页 -> 搜索页 -> 输入关键词这段流程。
  • collect_count 大于 0 时,会在结果页继续采集商家名称并随结果返回。
  • Android 端优先使用已验证的 resource-id,同时保留父节点点击兜底策略。
  • 服务端仍兼容 collect_merchant_count;等待、优先级和超时参数保留为高级参数。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/group-buy-leads" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "keyword": "火锅",
      "collect_merchant_count": 10,
      "collect_store_scheme": true
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/group-buy-commenters
创建团购评论人采集任务
搜索目标店铺,进入店铺详情页,打开评论落地页,并采集评论人的抖音号;可选开启 UID 采集开关,在复制抖音号后继续采集主页分享短链并解析 uid/sec_uid。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
store_name string 需要搜索并采集的店铺名称
collect_count integer 目标采集评论人数,默认 10,当前最大 10
collect_uid boolean 可选开关,默认 false;为 true 时在复制抖音号后继续采集 UID
startup_wait_ms integer 打开抖音后的等待时长,默认 1500ms
step_wait_ms integer 步骤之间的等待时长,默认 1200ms
max_result_scrolls integer 搜索结果页最多下滑轮数,默认 4
max_review_scrolls integer 店铺详情页查找评论入口的最多下滑轮数,默认 7
reset_task boolean 执行前是否重置抖音状态并重新拉起
stop_at_store_detail boolean 调试开关:进入店铺详情页后即停止
store_click_mode string 店铺行点击策略,默认 row_probe_grid
store_detail_timeout_ms integer 可选:店铺详情页确认超时时间
store_scheme string 可选:由 group-buy-leads 返回的店铺快捷地址,传入后优先直达门店详情页
open_scheme string 同 store_scheme,兼容字段
poi_scheme string 同 store_scheme,兼容字段
poi_id string 可选:店铺 POI ID;未传 store_scheme 时可由 poi_id 自动生成快捷地址
priority integer 任务优先级,默认 100
  • 默认不传 store_scheme/open_scheme/poi_scheme/poi_id 时,仍保留原来的“进入团购页 -> 搜索店铺 -> 点击店铺”流程。
  • 传入 store_scheme/open_scheme/poi_scheme 或 poi_id 时,会优先用 snssdk1128://poi/detail 快捷打开门店详情页,减少搜索和滑动耗时;快捷打开失败时自动回退原搜索流程。
  • 客户侧业务参数收敛为 store_name + collect_count。
  • 服务端内部会兼容映射 keyword = store_name,兼容旧调用方。
  • collect_uid 为可选开关:不传或传 false 时,完全按原有老逻辑,只采集评论人的抖音号。
  • collect_uid = true 时,会在复制抖音号成功后继续执行“更多 -> 分享名片 -> 复制链接”,并从分享短链解析 uid / sec_uid / share_url。
  • Android 端连续 120 秒未采到新的抖音号时会自动停止任务。
  • 正常调用方不再需要传 timeout_seconds。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/group-buy-commenters" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "store_name": "帽帽家鲜蚝烧烤·精酿吧(光谷店)",
      "collect_count": 10,
      "collect_uid": false,
      "store_scheme": "snssdk1128://poi/detail?id=7411019893632174119&enter_from=homepage_life&show_groupon_model_view=1&biz_code=food"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/comment
创建抖音作品评论任务
搜索目标抖音号,进入主页后随机打开一个作品,进入评论面板并发送一条评论。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
douyin_id string 目标抖音号
comment_content string 评论文案
profile_open_mode string 主页打开方式,可选 search / uid,默认 search
uid string 当 profile_open_mode=uid 时必填,用于直达主页
  • 当前实现会先进入目标主页,再从首屏作品宫格中打开一个可见作品。
  • 发送按钮当前版本需兼容 es1 和 esu/es0 两种发送区结构。
  • 发送成功优先按“新评论出现 / 评论数增加 / 输入框恢复占位”验收。
  • profile_open_mode 默认是 search,不传时完全保持原有搜索进入主页逻辑。
  • 当 profile_open_mode=uid 时,必须额外传 uid,会通过 snssdk1128://user/profile/{uid} 直达主页。
  • 服务端仍兼容 comment / content / message、douyin_ids / target_douyin_id / keyword 等历史字段;等待、重置、优先级和超时参数保留为内部高级参数,普通调用不需要传。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/comment" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "douyin_id": "780121814",
      "comment_content": "支持一下"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/search-follow-user
创建抖音搜索关注任务
搜索目标抖音号,进入目标主页并完成关注。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
douyin_id string 目标抖音号
profile_open_mode string 主页打开方式,可选 search / uid,默认 search
uid string 当 profile_open_mode=uid 时必填,用于直达主页;当前 uid 模式仅支持单个 douyin_id
follow_count integer 计划关注数量,默认 1
  • 服务端会兼容 douyin_ids / target_douyin_id / target_douyin_ids / accounts / keywords 等历史字段。
  • 当前实现会先搜索并校验主页抖音号,再执行关注动作。
  • profile_open_mode 默认是 search,不传时完全保持原有搜索进入主页逻辑。
  • 当 profile_open_mode=uid 时,必须额外传 uid,并且当前仅支持单个 douyin_id。
  • 等待、重置、优先级和超时参数保留为内部高级参数,普通调用不需要传。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/search-follow-user" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "douyin_id": "115325761",
      "follow_count": 1
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/private-message
创建抖音私信任务
搜索目标抖音号,进入主页后打开私信页并发送一条消息。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
douyin_id string 目标抖音号
message string 私信内容
profile_open_mode string 主页打开方式,可选 search / uid,默认 search
uid string 当 profile_open_mode=uid 时必填,用于直达主页
  • 服务端会兼容 douyin_ids / target_douyin_id / target_douyin_ids / accounts / keywords 等历史字段。
  • 当前实现会先搜索并进入目标主页,再根据关注态/未关注态选择私信入口。
  • profile_open_mode 默认是 search,不传时完全保持原有搜索进入主页逻辑。
  • 当 profile_open_mode=uid 时,必须额外传 uid,会通过 snssdk1128://user/profile/{uid} 直达主页。
  • 服务端仍兼容 content 作为私信内容;等待、重置、优先级和超时参数保留为内部高级参数,普通调用不需要传。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/private-message" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "douyin_id": "115325761",
      "message": "你好,方便沟通一下吗?"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/profile-actions
创建抖音组合动作任务
只打开一次目标主页,然后在同一主页上下文里按顺序执行关注、私信、评论;支持选择搜索进主页或通过 uid 直达主页。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
douyin_id string 目标抖音号
profile_open_mode string 主页打开方式,可选 search / uid,默认 search
uid string 当 profile_open_mode=uid 时必填,用于直达主页
follow_enabled boolean 是否执行关注
private_message_content string 私信文案
comment_content string 评论文案
  • 当前版本最少选择一项,最多三项,可只选关注 / 私信 / 评论中的任意组合。
  • 固定执行顺序为:关注 -> 私信 -> 评论。
  • profile_open_mode 默认是 search,不传时完全保持原有搜索进入主页逻辑。
  • 当 profile_open_mode=uid 时,必须额外传 uid,会通过 snssdk1128://user/profile/{uid} 直达主页。
  • 服务端仍兼容 follow / do_follow、private_message / dm_content、comment 等历史字段;等待、重置、优先级和超时参数保留为内部高级参数。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/profile-actions" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "douyin_id": "115325761",
      "follow_enabled": true,
      "private_message_content": "你好,方便沟通一下吗?",
      "comment_content": "支持一下"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/fan-marketing
创建抖音粉丝营销任务
进入自己的抖音主页,打开粉丝列表,对粉丝执行回关;可选在回关后通过三点菜单进入私信页发送消息。遇到“互相关注”时会直接跳过。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
max_fans integer 本次最多处理的粉丝数量,默认 10;兼容 fan_count / count
private_message_content string 可选私信文案;不传时只做回关,兼容 message / content
startup_wait_ms integer 打开抖音后的等待时长,默认 1500ms
step_wait_ms integer 步骤之间的等待时长,默认 1000ms
max_scrolls integer 粉丝列表最多滚动轮数,默认 12
reset_task boolean 执行前是否重置抖音状态并重新拉起
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,默认 300 秒
  • 回关是必选动作;是否私信由 private_message_content 是否非空决定。
  • 执行过程中遇到“互相关注”会直接跳过,不重复处理。
  • 当前实现优先在粉丝列表内完成回关,若配置了私信,则会通过右侧三点菜单进入私信页发送消息。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/fan-marketing" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "max_fans": 10,
      "private_message_content": "你好,方便沟通一下吗?"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/follow-peer-users
创建抖音关注同行采集任务
从抖音首页搜索关键词,切换到用户结果页,按从上到下顺序进入用户主页采集昵称、头像、抖音号、企业号信息、分享名片链接,并解析 uid/sec_uid。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
keyword string 搜索关键词
collect_count integer 采集用户数量,默认 1;0 表示尽量不限,直到到底或达到保护上限
  • 当前 MVP 是“采集同行用户主页身份”,不会默认执行关注动作。
  • 每采集一个用户后会返回用户搜索结果页,重新拉取候选,避免旧节点失效。
  • 主页身份采集复用统一组件,兼容普通号和企业号,并通过分享名片解析 uid/sec_uid。
  • 如果搜索结果到底或连续 3 次滑动后可见用户结果签名不变,会停止任务并上报 stop_reason。
  • 服务端仍兼容 search_keyword / query、user_count / peer_count / count 等历史字段;collect_uid、collect_avatar、follow_enabled、max_result_scrolls、等待和超时参数保留为高级参数,普通调用不需要传。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/follow-peer-users" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "keyword": "烧烤",
      "collect_count": 3
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/unfollow-following
创建抖音取消关注任务
进入自己的抖音主页,打开关注列表,自上而下按数量打开三点菜单并执行取消关注。当前实现会把“已关注”和“互相关注”都视为可取消的关注关系。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
unfollow_count integer 本次最多取消关注的数量,默认 10;兼容 max_unfollows / cancel_count / count
startup_wait_ms integer 打开抖音后的等待时长,默认 1500ms
step_wait_ms integer 步骤之间的等待时长,默认 1000ms
max_scrolls integer 关注列表最多滚动轮数,默认 12
reset_task boolean 执行前是否重置抖音状态并重新拉起
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,默认 300 秒
  • 当前动作会优先复用当前现场;如果已在关注列表页,会直接从当前页继续。
  • 成功判定不是“点击成功”,而是菜单关闭且列表真实发生变化,例如“我的关注(x人)”减少或当前目标行从当前视野中消失。
  • 当前实现假定“已关注”和“互相关注”都允许执行取消关注;如果后续业务需要区分,可再单独加参数控制。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/unfollow-following" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "unfollow_count": 2,
      "max_scrolls": 4
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/search-lead-video-links
创建搜索获客采集视频链接任务
按关键词在抖音综合搜索结果页采集视频链接:逐条进入视频页,先采集详情页标题、发布时间、作者、点赞数、评论数、收藏数、分享数,再复制分享链接,并回退搜索结果页继续批量采集。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
keyword string 搜索关键词
collect_count integer 本次采集的视频链接数量,默认 1,最大 50
sort_by string 排序依据:comprehensive 综合排序、latest 最新发布、most_liked 最多点赞;默认不传保持综合排序
publish_time string 发布时间:unlimited 不限、day 一天内、week 一周内、half_year 半年内
video_duration string 视频时长:unlimited 不限、lt_1_min 1分钟以下、1_5_min 1-5分钟、gt_5_min 5分钟以上
search_scope string 搜索范围:unlimited 不限、following 关注的人、recently_watched 最近看过、not_watched 还未看过
content_form string 内容形式:unlimited 不限、video 视频、image_text 图文
  • 任务完成后,Android 会在 result_payload 中返回 links 和 items。
  • items 会包含视频链接、搜索卡片标题、作者昵称、头像截图路径、封面 bounds、时长、点赞、发布时间等字段。
  • 进入详情页后会额外返回 video_title/video_title_raw/detail_publish_time/author_name/like_count/comment_count/favorite_count/share_count 与对应 *_raw 字段。
  • 如果进入广告视频后弹出快捷私信面板,执行器会先点击上方视频区域收起,再继续分享链路。
  • 如果分享面板中的“分享链接”只露出一部分,执行器会先横向滑动底部分享动作栏,确认完整可见后再点击。
  • 筛选参数全部不传时,Android 端不会打开筛选面板,保持默认综合搜索结果。
  • 任一筛选参数传入非默认值时,Android 端会在确认“综合”后、点击第一个视频前打开筛选面板,选择条件后关闭并校验仍在搜索结果页。
  • 公开文档统一推荐 collect_count;服务端仍兼容 collect_video_count / video_count、search_keyword / query 以及各筛选项历史别名。等待、重置、优先级和超时参数保留为高级参数。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/search-lead-video-links" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "keyword": "装修",
      "collect_count": 2,
      "sort_by": "latest",
      "publish_time": "week",
      "content_form": "video"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/account-video-links
创建账号获客采集主页视频链接任务
进入指定抖音号或 UID 对应主页,遍历该账号发布的视频作品,逐个打开视频,在详情页采集标题、发布时间、作者、点赞数、评论数、收藏数、分享数,再复制分享链接并解析 aweme_id/open_url/open_scheme 后上报。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
douyin_id string 目标抖音号;profile_open_mode=search 时必填
profile_open_mode string 主页打开方式,可选 search / uid,默认 search
uid string 当 profile_open_mode=uid 时必填
collect_count integer 采集视频数,默认 1;传 0 表示不限,直到主页作品列表到底或连续 3 次无变化
  • profile_open_mode=search 时会复用已验证的搜索抖音号进入主页逻辑。
  • profile_open_mode=uid 时会通过 snssdk1128://user/profile/{uid} 直达主页,并用主页身份识别兜底判断是否打开成功。
  • 视频采集动作是点击主页作品 -> 点击视频详情页分享按钮 -> 复制视频分享链接,不是主页右上角“分享名片”。
  • 每条 items 会同时返回主页卡片 title/raw_texts,以及详情页 video_title/video_title_raw/publish_time/author_name/like_count/comment_count/favorite_count/share_count 与对应 *_raw 字段。
  • collect_count=0 表示不限数量;安卓端会持续向下滑动主页作品列表,直到连续 3 次可见作品签名不变或识别到暂无作品。
  • 任务完成后本地“上报数据”事件名为 douyin.account_video_links.completed 或 douyin.account_video_links.failed。
  • 公开文档统一推荐 collect_count;服务端仍兼容 collect_video_count / video_count、target_douyin_id / account / keyword、target_uid / profile_uid 等历史字段。collect_profile、collect_uid、等待、重置、优先级和超时参数保留为高级参数。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/account-video-links" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "profile_open_mode": "uid",
      "uid": "2549098251828516",
      "collect_count": 5
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/search-lead-video-comments
创建搜索获客采集视频评论任务
按视频链接或 aweme_id 直达作品播放页,打开评论面板,按意向词匹配评论内容,进入命中评论人的主页采集抖音号,并可选采集 UID/sec_uid,同时上报主页直联 profile_scheme / profile_open_url。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
video_link string 视频分享链接;和 aweme_id 二选一
aweme_id string 视频 awemeId;和 video_link 二选一
intent_keywords string|array 意向词;传入时只采集命中评论内容;不传或为空时不按关键词过滤,从第一条可采集评论开始顺序采集;字符串可用 ||、|、逗号分隔
collect_count integer 计划采集命中评论人数,默认 0;传 0 表示不限命中数量,直到评论区到底;最大 50
comment_regions string|array 可选评论地区筛选,命中关键词后仅采集指定地区评论人;字符串可用 ||、|、逗号分隔
comment_time_start string 可选评论时间开始日期,格式 YYYY-MM-DD
comment_time_end string 可选评论时间结束日期,格式 YYYY-MM-DD
reply_comment boolean 是否对通过关键词、地区、时间筛选的评论执行回复,默认 false
reply_content string 回复内容;reply_comment=true 时必填,兼容 comment_reply_content / reply_text / comment_reply_text
preflight_mode string 高级参数;可选 none / soft_home / relaunch / force_stop_adb;一般不需要传,真机已在视频详情页或 scheme 可直达但任务回桌面时可传 none 验证
  • 评论按钮优先使用真机确认的 eqe 节点,同时保留播放页右侧评论按钮坐标兜底,避免树 bounds 偶发滞后导致点到点赞。
  • 评论内容节点使用 com.ss.android.ugc.aweme:id/content,命中后在同一 fck 评论卡内绑定 avatar/title/content,点击 avatar 进入用户主页。
  • 可选地区/时间筛选会在关键词命中之后、点击头像之前执行;不符合 comment_regions/comment_time_start/comment_time_end 的评论不会进入主页采集。
  • 开启 reply_comment 后,只会对已通过关键词、地区、时间筛选的评论点击同卡片内“回复”按钮并发送 reply_content;同时开启 collect_profile 时会先采集主页,再返回评论区回复。
  • 评论时间兼容完整日期、无年份月日、刚刚/今天/昨天/前天、xx分钟前、xx小时前;无年份月日按执行当天所在年份解析。
  • collect_count=0 表示不限命中数量;max_comment_scrolls=0 表示不限滚动次数,执行器会持续扫描到评论区出现“暂时没有更多了 / 没有更多了”等底部提示。
  • 主页抖音号和 UID 采集复用团购02采集评论人已验证的“更多 -> 分享名片 -> 复制链接 -> 解析短链”思路。
  • UID 解析成功后会在上报数据中带 profile_scheme=snssdk1128://user/profile/{uid};sec_uid 解析成功后会带 profile_open_url=https://www.douyin.com/user/{sec_uid}。
  • 任务完成后会进入本地“上报数据”查看页,事件名为 douyin.search_lead_video_comments.completed 或 failed。
  • items now include author_name/video_author_name for video author and comment_like_count_raw/comment_like_count for each matched comment.
  • top-level video stats include like_count/comment_count/favorite_count/share_count and *_raw; per-comment likes use comment_like_count/comment_like_count_raw.
  • intent_keywords 非必填:传入时按关键词过滤;不传、空数组或空字符串时不按关键词过滤,从第一条满足地区、时间、去重等条件的评论开始采集。collect_profile、collect_uid 默认开启;max_comment_scrolls 默认不限,preflight_mode、等待、优先级和超时参数保留为高级参数。服务端仍兼容 link / url、awemeId / video_id、keywords / keyword / match_keywords、commenter_count / max_commenters 等历史字段。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/search-lead-video-comments" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "video_link": "https://v.douyin.com/OGY41FLDV3w/",
      "intent_keywords": [
          "求带",
          "怎么做"
      ],
      "collect_count": 10,
      "comment_regions": [
          "湖北",
          "广东"
      ],
      "comment_time_start": "2026-04-01",
      "comment_time_end": "2026-04-30"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/douyin/reply-collected-comment
回复指定抖音评论
打开指定视频,找到指定评论并发送回复。
抖音业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 设备 ID
video_link string 视频分享链接,和 open_scheme / aweme_id 三选一;可直接传抖音完整分享文案
aweme_id string 视频 ID,和 open_scheme / video_link 三选一
comment_text string 要回复的原评论内容
reply_content string 回复内容
nickname string 评论人昵称,建议从采集结果原样传入
open_scheme string 视频快捷打开地址,和 video_link / aweme_id 三选一
  • 推荐使用视频评论采集接口返回的 comment_text、nickname 等字段调用本接口。
  • 任务完成后,reply_status=sent 表示回复已发送。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/douyin/reply-collected-comment" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "open_scheme": "snssdk1128://aweme/detail/7471234567890123456",
      "nickname": "启航麻麻",
      "comment_text": "终于做了这个决定,唱了八百遍没告诉我你做什么决定........终于做了这决定.......[泪奔]",
      "reply_content": "决定这样唱哈哈"
  }'

在线调试

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

小红书业务接口

面向外部业务系统的小红书建单入口,当前开放搜索获客笔记筛选与进入详情能力。
POST /v1/apps/xiaohongshu/open
创建小红书打开任务
拉起小红书 App,用于验证设备链路,或在调用具体小红书业务接口前先恢复到可操作状态。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
startup_wait_ms integer 拉起后等待时长,默认 1500ms
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,默认 90 秒
  • Android action_code 为 open_xiaohongshu。
  • 该接口不采集数据,只负责打开 com.xingin.xhs。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/open" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/close
关闭小红书 App
让 Android Agent 打开系统“小红书应用信息”页,点击“强行停止”并确认,效果对齐手动系统级强制停止;随后回到桌面。用于页面状态异常时彻底清理小红书前台/后台状态,再调用具体业务接口。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
settle_wait_ms integer 强停后回到桌面并等待的时长,默认 1000ms
force_stop_wait_ms integer 等待系统应用信息页出现“强行停止”按钮的时长,默认 6000ms
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,默认 90 秒
  • Android action_code 为 close_xiaohongshu。
  • Android 端会打开系统应用信息页,点击“强行停止/强制停止/结束运行”并确认,等价于手动在系统设置里强行停止小红书。
  • 如果系统 ROM 不允许无障碍点击强停按钮,会返回 force_stop_clicked=false,并保留 killBackgroundProcesses 作为兜底。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/close" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/search-lead-notes
创建小红书搜索获客笔记任务
打开小红书首页,点击搜索,输入关键词并搜索;确认位于“全部”选项卡后按可选筛选条件设置排序、笔记类型、发布时间、搜索范围、位置距离,最后点击第一条搜索结果进入笔记详情页,并上报笔记标题、作者、点赞、收藏、评论等可见信息;默认会点击详情页分享按钮并复制链接,解析 note_id、xsec_token、appuid、share_url、resolved_url、note_open_url、note_scheme。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
keyword string 搜索关键词
collect_count integer 本次采集笔记数量,默认 1,最大 50;传 0 表示尽量不限,直到结果列表到底或连续 3 次无变化
sort_by string 排序依据:comprehensive 综合 / latest 最新 / most_liked 最多点赞 / most_commented 最多评论 / most_collected 最多收藏
note_type string 笔记类型:unlimited 不限 / video 视频 / image_text 图文 / live 直播
publish_time string 发布时间:unlimited 不限 / one_day 一天内 / one_week 一周内 / half_year 半年内
search_scope string 搜索范围:unlimited 不限 / watched 已看过 / not_watched 未看过 / following 已关注
location_distance string 位置距离:unlimited 不限 / same_city 同城 / nearby 附近
  • 该接口已在真机验证:搜索关键词“武汉影楼”,筛选 latest / image_text / half_year / same_city 后可进入第一条笔记详情。
  • 创建接口只负责入队,成功响应只返回 job_id/status;采集完成后的完整数据请用 GET /v1/jobs/{job_id} 查看 data.result_payload,或用 GET /v1/callback-reports/{report_id} 查看 payload.data。
  • 小红书 resource-id 存在大量 0_resource_name_obfuscated,Android 端主要按文本、可见区域、节点 bounds 和坐标兜底组合识别。
  • 选择 same_city / nearby 时可能触发系统定位权限弹窗,Android 端会优先点击“仅在使用该应用时允许”等允许按钮。
  • 筛选面板入口在“全部”选项卡右侧图标区域,执行器会优先点击选项卡节点,失败后用多组坐标兜底。
  • 结果卡片点击优先使用外层可点击卡片节点,失败后再尝试标题/正文区域和图片区域,避免只点图片不进入详情。
  • collect_count 大于 0 时按搜索结果顺序采够指定数量后停止;collect_count=0 时会继续向下滑动采集,直到结果列表连续 3 次无变化或达到保护上限。
  • GET /v1/jobs/{job_id} 的 data.result_payload 会返回 requested_count、collected_count、failed_count、stop_reason、share_urls、note_ids、note_open_urls、note_schemes、items、failed_items;items 中按采集顺序逐条包含 note_id、note_scheme、标题、点赞、收藏、评论等字段。
  • GET /v1/callback-reports/{report_id} 的 payload.data 是归一化上报结果,字段同样包含 collected_count、failed_count、items、failed_items;/v1/callback-reports 列表可先找到 report_id。
  • collect_share_link 默认开启:Android 端会点击右上角“分享” -> “复制链接”,从 xhslink.com 短链 GET 302 Location 中解析 note_id,并生成 note_open_url 与可直接拉起小红书 App 的 note_scheme。
  • note_scheme 格式示例:xhsdiscover://item/{note_id}?xsec_token=...&xsec_source=app_share&type=video;该格式已真机验证可直接打开小红书作品详情页。
  • 小红书作品核心标识字段为 note_id;appuid 先按短链参数原样上报,不直接等同最终用户 uid。
  • 公开文档统一推荐 collect_count;服务端仍兼容 collect_note_count / collect_video_count / note_count / video_count / count、search_keyword / query 以及各筛选项历史别名。collect_share_link 默认开启,等待、重置、优先级和超时参数保留为高级参数。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.search_lead_notes.completed 或 xiaohongshu.search_lead_notes.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/search-lead-notes" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "keyword": "武汉影楼",
      "collect_count": 2,
      "sort_by": "latest",
      "note_type": "image_text",
      "publish_time": "half_year",
      "location_distance": "same_city"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/comment
创建小红书指定作品评论任务
打开指定小红书作品详情页,进入评论输入框并发送一条评论。支持 note_scheme / note_open_url / share_url / note_id 直达作品;也支持 profile_scheme / profile_open_url / profile_share_url / profile_user_id 打开主页后选择首个可见作品再评论。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
note_scheme string 小红书 App 内打开作品的 scheme,优先使用搜索获客笔记任务 items.note_scheme
profile_scheme string 主页 App 快捷跳转地址,例如 xhsdiscover://user/{profile_user_id}?xsec_token=...&xsec_source=app_share
profile_open_url string 小红书网页主页地址,例如 https://www.xiaohongshu.com/user/profile/{profile_user_id}?xsec_token=...
profile_user_id string 小红书主页 profile user id,兼容 profileUserId / user_id
comment_content string 评论文案
  • 该接口对标抖音 /v1/apps/douyin/comment 的“发评论”能力:既可以传单篇作品入口直接评论,也可以传主页入口后打开首个可见作品再评论。
  • 如果已有作品入口,推荐优先传 /v1/apps/xiaohongshu/search-lead-notes 采集到的 note_scheme;如果只有主页入口,可传 profile_scheme / profile_open_url / profile_share_url / profile_user_id。
  • 创建接口只负责入队,成功响应只返回 job_id/status;执行完成后的完整结果请用 GET /v1/jobs/{job_id} 查看 data.result_payload,或用 GET /v1/callback-reports/{report_id} 查看 payload.data。
  • 完成结果会返回 note_id、note_scheme、note_open_url、share_url、profile_scheme、profile_open_url、profile_user_id、profile_open_mode、work_select_mode、work_card_bounds、comment_length、comment_content_preview、comment_send_status、verify_method、comment_input_bounds、comment_send_button_bounds、detail_activity、editor_activity。
  • 发送成功验证优先看评论正文是否可见,其次看输入框恢复占位或编辑器关闭;verify_method 会标明 comment_visible / placeholder_restored / editor_dismissed。
  • 主页入口模式会点击主页作品网格中第一个可见作品;如果主页无可见作品或卡片识别失败,任务会失败并返回 xhs_comment_profile_work_open_failed。
  • 公开文档推荐 note_scheme + comment_content 的指定作品评论;主页入口评论属于高级模式。服务端仍兼容 note_open_url / share_url / note_id / xsec_token / note_type、profile_share_url / xhs_user_id / profile_open_mode / work_select_mode 以及 comment / content / message 等历史字段。
  • verify_timeout_ms、等待、重置、优先级和超时参数保留为高级参数,普通调用不需要传。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.comment.completed 或 xiaohongshu.comment.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/comment" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "note_scheme": "xhsdiscover://item/69e0ea08000000001a020826?xsec_token=...&xsec_source=app_share&type=video",
      "comment_content": "支持一下"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/search-follow-user
创建小红书关注用户任务
对标抖音 /v1/apps/douyin/search-follow-user。支持通过小红书主页快捷跳转地址、网页主页地址、主页分享短链或 profile_user_id 直达主页后关注;也支持通过小红书号或关键词搜索用户,切到“用户”Tab 后进入主页关注。第一版优先推荐使用 profile_scheme / profile_open_url / profile_user_id / profile_share_url 直达主页。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
xhs_user_id string 小红书号;用于搜索或主页校验
keyword string 搜索关键词
profile_scheme string 主页 App 快捷跳转地址,例如 xhsdiscover://user/{profile_user_id}?xsec_token=...&xsec_source=app_share
profile_open_url string 小红书网页主页地址,例如 https://www.xiaohongshu.com/user/profile/{profile_user_id}?xsec_token=...
profile_user_id string 小红书主页 profile user id
follow_count integer 计划关注数量,默认按目标数,最小 1
  • 关注按钮按主页头部行动区识别:android.widget.Button、文本精确等于“关注”,并限制在头像/昵称/统计区下方、作品列表上方;不会按混淆 resource-id 单独定位。
  • 如果已经是已关注 / 互相关注 / 仅显示私信入口,会计入成功并返回 follow_status=already_followed 或 mutual_followed。
  • 点击“关注”后如果弹出关注管理相关菜单,会视为已进入关注态,返回 follow_status=follow_management_sheet 并自动返回关闭弹层。
  • 坐标兜底只在关注按钮自身 bounds 内执行,并且会临时关闭 task interaction mode;搜索输入同样会临时关闭 task interaction mode,避免输入法/手势被强制 UI 模式影响。
  • 创建接口只负责入队,成功响应只返回 job_id/status;执行完成后用 GET /v1/jobs/{job_id} 查看 data.result_payload,或用 GET /v1/callback-reports/{report_id} 查看 payload.data。
  • 完成结果会返回 profile_open_mode、requested_follow_count、succeeded_follow_count、requested_xhs_user_ids、requested_keywords、succeeded_targets、failed_targets、stop_reason;succeeded_targets 中包含 actual_xhs_user_id、nickname、profile_user_id、profile_open_url、profile_scheme、follow_status、follow_button_bounds。
  • 第一版推荐优先传 profile_scheme / profile_open_url / profile_user_id / profile_share_url 直达主页;search 模式已接入基础链路,但用户结果卡片结构可能需要按真机日志继续微调。
  • profile_open_mode 会按已传字段自动判断,普通调用不需要传。服务端仍兼容 xhs_user_ids / keywords / profile_share_url、homepage_share_url、share_url、profileUserId / user_id、count 等历史字段。
  • 等待、重置、优先级和超时参数保留为高级参数。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.search_follow_user.completed 或 xiaohongshu.search_follow_user.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/search-follow-user" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "profile_scheme": "xhsdiscover://user/5f12b4bd000000000101cd7c?xsec_token=...&xsec_source=app_share",
      "follow_count": 1
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/private-message
创建小红书私信任务
对标抖音 /v1/apps/douyin/private-message。第一版优先支持通过小红书主页快捷跳转地址、网页主页地址、主页分享短链或 profile_user_id 直达主页,点击主页行动区“私信/发消息”进入聊天页并发送一条私信。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
message string 私信内容
profile_scheme string 主页 App 快捷跳转地址,例如 xhsdiscover://user/{profile_user_id}?xsec_token=...&xsec_source=app_share;第一版推荐优先传
profile_open_url string 小红书网页主页地址,例如 https://www.xiaohongshu.com/user/profile/{profile_user_id}?xsec_token=...
profile_user_id string 小红书主页 profile user id;可用于拼装 xhsdiscover://user/{profile_user_id}
xhs_user_id string 小红书号;用于主页校验或搜索模式
keyword string 搜索关键词;建议优先传主页直达入口
  • 第一版只建议使用 profile_scheme / profile_open_url / profile_user_id / profile_share_url 直达主页后私信;search 模式参数已预留,但 Android 端会明确返回暂未支持,避免误搜误发。
  • 私信入口按主页头部行动区识别“私信/发消息/消息”,不会按混淆 resource-id 单独定位;坐标兜底仅限私信按钮自身 bounds 内。
  • 进入聊天页和输入发送阶段会关闭 task interaction mode,避免强制 UI 模式影响键盘和输入框;输入优先 ACTION_SET_TEXT,失败后再走剪贴板/输入法候选兜底。
  • 发送成功验证会看消息气泡、输入框清空/恢复占位、发送按钮消失等信号;verify_method 会返回 message_bubble / input_cleared / input_dismissed / send_button_disappeared。
  • 创建接口只负责入队,成功响应只返回 job_id/status;执行完成后用 GET /v1/jobs/{job_id} 查看 data.result_payload,或用 GET /v1/callback-reports/{report_id} 查看 payload.data。
  • 完成结果会返回 profile_open_mode、target_xhs_user_id、actual_xhs_user_id、nickname、profile_user_id、profile_scheme、profile_open_url、entry_mode、message_length、message_send_status、verify_method、private_message_button_bounds、chat_input_bounds、chat_send_button_bounds、profile_activity、chat_activity。
  • profile_open_mode 会按已传字段自动判断,普通调用不需要传。服务端仍兼容 content / private_message_content / private_message / dm_content、profile_share_url / homepage_share_url / share_url、profileUserId / user_id、xhsUserId / target_xhs_user_id 等历史字段。
  • verify_timeout_ms、等待、重置、优先级和超时参数保留为高级参数。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.private_message.completed 或 xiaohongshu.private_message.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/private-message" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "profile_scheme": "xhsdiscover://user/5f12b4bd000000000101cd7c?xsec_token=...&xsec_source=app_share",
      "message": "你好,方便沟通一下吗?"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/profile-actions
创建小红书主页组合动作任务
对标抖音 /v1/apps/douyin/profile-actions。只打开一次目标主页,然后在同一主页上下文里按固定顺序执行关注、私信、评论。第一版不包含作品点赞,后续如需再单独接入 like_enabled。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
profile_scheme string 主页 App 快捷跳转地址,推荐优先使用,例如 xhsdiscover://user/{profile_user_id}?xsec_token=...&xsec_source=app_share
profile_open_url string 小红书网页主页地址,例如 https://www.xiaohongshu.com/user/profile/{profile_user_id}?xsec_token=...
profile_user_id string 小红书主页 profile user id
xhs_user_id string 小红书号;用于主页校验或搜索模式
keyword string 搜索关键词;推荐优先传主页直达入口
follow_enabled boolean 是否关注目标
private_message_content string 私信内容
comment_content string 评论内容;传入后会从主页打开一个可见作品并评论
  • 执行顺序固定为:关注 -> 私信 -> 恢复主页 -> 评论。任一步失败会停止,避免误发或在错误页面继续操作。
  • 组合任务不会简单串行创建三个独立任务;Android 端只打开一次主页,关注/私信/评论复用当前主页上下文。
  • 私信后如果还需要评论,会先按返回键恢复目标主页;失败时再用原始 profile_scheme / profile_open_url 等入口重新打开目标主页。
  • 涉及输入、发送、打开作品等真实手势时,Android 端会临时关闭 task interaction mode,避免强制 UI 模式影响键盘和点击。
  • 完成结果会返回 selected_actions、target_xhs_user_id、actual_xhs_user_id、nickname、follow_status、private_message_send_status、comment_send_status、各阶段 verify_method 和 bounds。
  • profile_open_mode 会按已传字段自动判断,work_select_mode 默认 first_visible,普通调用不需要传。服务端仍兼容 profile_share_url / homepage_share_url / share_url、profileUserId / user_id、follow / do_follow、private_message / dm_content / message、comment 等历史字段。
  • verify_timeout_ms、等待、重置、优先级和超时参数保留为高级参数。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.profile_actions.completed 或 xiaohongshu.profile_actions.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/profile-actions" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "profile_scheme": "xhsdiscover://user/5f12b4bd000000000101cd7c?xsec_token=...&xsec_source=app_share",
      "xhs_user_id": "lyfz15588",
      "follow_enabled": true,
      "private_message_content": "你好,方便沟通一下吗?",
      "comment_content": "支持一下"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/fan-marketing
创建小红书粉丝营销任务
对标抖音 /v1/apps/douyin/fan-marketing。进入当前登录账号的小红书主页,打开粉丝列表,按顺序对真实粉丝执行回关;遇到“互相关注”直接跳过。传入私信内容时,回关成功后会进入该粉丝主页并发送私信。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
max_fans integer 最大回关粉丝数量,默认 10,范围 1-50;兼容 fan_count / count
private_message_content string 可选私信内容;不传则只回关,不发私信
  • Android action_code 为 xhs_fan_marketing。
  • 调用方通常只需要传 device_id、max_fans;需要私信时再传 private_message_content。
  • 执行器只处理粉丝列表里的真实粉丝行;遇到“查看全部”“你可能感兴趣的人”等推荐区域会停止向下处理,避免误点推荐用户。
  • 回关动作在粉丝列表内直接完成;传入 private_message_content 时,回关成功后会打开该粉丝主页,并复用主页私信入口发送消息。
  • 服务端仍兼容 private_message / message / content、fan_count / count;滚动、等待、重置、优先级和超时等调试参数为高级参数,正常调用可不传。
  • 结果 payload.data 会返回 target_follow_back_count、followed_back_count、messaged_count、skipped_mutual_count、scanned_row_count、scroll_count、private_message_enabled、stop_reason 和 fans。
  • fans 每条包含 nickname、xhs_user_id、row_meta、fan_status、follow_status、message_status、row_bounds、follow_button_bounds、profile_follow_button_bounds、private_message_button_bounds、profile_activity、failure_reason 等字段。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.fan_marketing.completed 或 xiaohongshu.fan_marketing.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/fan-marketing" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "max_fans": 10,
      "private_message_content": "你好,方便沟通一下吗?"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/account-video-links
创建小红书账号获客笔记链接采集任务
对外路径沿用抖音 account-video-links 历史命名;小红书实际采集对象是账号主页已发布笔记,包含图文和视频。进入指定小红书账号主页,遍历主页已发布笔记,逐个打开详情页采集标题、发布时间、作者、点赞数、评论数、收藏数、分享数,并复制分享链接解析 note_open_url / note_scheme 后上报。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
profile_scheme string 主页 App 快捷跳转地址,推荐优先使用,例如 xhsdiscover://user/{profile_user_id}?xsec_token=...&xsec_source=app_share
profile_open_url string 小红书网页主页地址,例如 https://www.xiaohongshu.com/user/profile/{profile_user_id}?xsec_token=...
profile_user_id string 小红书主页 profile user id
xhs_user_id string 小红书号;用于主页校验或搜索模式
keyword string 搜索关键词;推荐传主页直达入口
collect_count integer 采集账号主页笔记数量,默认 1;0 表示尽量采到列表到底,当前保护上限 200
  • Android action_code 为 xhs_account_note_links。
  • 结果 payload.data 会包含 target_xhs_user_id、actual_xhs_user_id、nickname、profile_user_id、profile_scheme、profile_open_url、requested_count、collected_count、stop_reason、items、failed_items。
  • items 每条包含 card_key、card_bounds、title、author_nickname、publish_time、like_count_raw/count、comment_count_raw/count、favorite_count_raw/count、share_count_raw/count、share_url、resolved_url、note_id、note_type、xsec_token、note_open_url、note_scheme。
  • 公开文档统一推荐 collect_count;服务端仍兼容 collect_note_count / collect_video_count / note_count / video_count / count、profile_share_url / homepage_share_url / share_url、profileUserId / user_id、xhsUserId / target_xhs_user_id 等历史字段。
  • profile_open_mode 会按已传字段自动判断,collect_share_link 和 collect_profile 默认开启;等待、重置、优先级和超时参数保留为高级参数。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.account_note_links.completed 或 xiaohongshu.account_note_links.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/account-video-links" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "profile_scheme": "xhsdiscover://user/5f12b4bd000000000101cd7c?xsec_token=...&xsec_source=app_share",
      "xhs_user_id": "lyfz15588",
      "collect_count": 3
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/follow-peer-users
创建小红书同行用户采集任务
对标抖音 /v1/apps/douyin/follow-peer-users。当前接口用于采集同行用户资料,不执行真实关注动作。按关键词进入小红书搜索结果的“用户”页,顺序打开同行用户主页,采集主页身份、粉丝/关注状态、头像证据、主页分享链接,并解析 profile_open_url / profile_scheme 后上报。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
keyword string 搜索关键词
collect_count integer 采集用户数量,默认 1;0 表示尽量不限,直到到底或达到保护上限
  • 该接口创建的是同行采集任务,不是默认关注任务;follow_enabled=true 时第一版也只会上报 reserved_not_executed,不点击右侧关注按钮。
  • Android 端会从搜索用户结果卡片左侧头像/昵称区域打开主页,避开右侧“关注/已关注/互相关注”按钮区域。
  • 小红书 resource-id 大量为空或 obfuscated,执行器按文本、content-desc、bounds、Activity 和 selected 状态组合识别。
  • 默认保持强制 UI / task interaction mode 开启;输入、坐标点击、下滑时临时关闭,完成后立即恢复。
  • 结果 payload.data 包含 keyword、requested_count、collected_count、scroll_rounds、stagnant_rounds、processed_result_count、stop_reason 和 items。
  • items 每条包含 nickname、xhs_user_id、profile_user_id、xsec_token、category、follower_count_raw、follow_status、profile_follow_status、profile_share_url、profile_open_url、profile_scheme、result_card_bounds、avatar 等字段。
  • collect_profile_link 和 collect_avatar 默认开启;follow_enabled 当前为预留参数,默认不执行真实关注。服务端仍兼容 search_keyword / query、user_count / peer_count / count、collect_profile_url / collect_homepage_link、max_scrolls 等历史字段。
  • max_result_scrolls、等待、重置、优先级和超时参数保留为高级参数,普通调用不需要传。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.follow_peer_users.completed 或 xiaohongshu.follow_peer_users.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/follow-peer-users" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "keyword": "摄影",
      "collect_count": 5
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/unfollow-following
创建小红书取消关注任务
对标抖音 /v1/apps/douyin/unfollow-following。进入当前登录账号的小红书主页,打开关注列表,在“关注”tab 下取消关注;默认从列表第一个往下取消,也可通过 target_nicknames 指定只取消某些昵称。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
unfollow_count integer 本次最多取消关注数量;未传 target_nicknames 时默认 10,传了 target_nicknames 且未传本字段时默认等于昵称数量;范围 1-50;兼容 max_unfollows / cancel_count / count
target_nicknames array|string 指定要取消关注的昵称,支持数组或用 || / 逗号 / 换行分隔;兼容 target_nickname / nicknames / nickname / user_nicknames / users;不传则按当前旧逻辑从第一个往下取消
  • Android action_code 为 xhs_unfollow_following。
  • 执行路径为“小红书首页 -> 我 -> 关注 -> 关注列表右侧互相关注 -> 不再关注确认框”。
  • 真机确认最终确认按钮文案是“不再关注”;服务端和 Android 端保留“取消关注”兼容。
  • 执行器会排除顶部 tab 的“互相关注”,只处理列表用户行右侧的可点击按钮,避免误切 tab。
  • 传 target_nicknames 时按昵称精确匹配,只会对匹配到的关注用户执行取关;未匹配到的用户只跳过并继续下滑查找。
  • 传 target_nicknames 且同时传 unfollow_count 时,以 unfollow_count 作为最多取关数量;不传 unfollow_count 时默认最多取关 target_nicknames 的数量。
  • 不传 target_nicknames 时行为保持原样:从关注列表第一个用户开始按 unfollow_count 数量依次取关。
  • 默认保持强制 UI / task interaction mode 开启;下滑和坐标兜底点击时临时关闭,完成后立即恢复。
  • max_scrolls / max_following_scrolls、startup_wait_ms、step_wait_ms、reset_task、priority、timeout_seconds 为高级调试参数,正常调用不需要传。
  • 结果 payload.data 会返回 target_unfollow_count、target_nicknames、unfollowed_count、scanned_row_count、scroll_count、starting_following_count、ending_following_count、stop_reason 和 following_users。
  • following_users 每条包含 nickname、row_meta、row_bounds、action_button_bounds、confirm_button_bounds、unfollow_status、failure_reason 等字段。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.unfollow_following.completed 或 xiaohongshu.unfollow_following.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/unfollow-following" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "target_nicknames": [
          "流星雨",
          "小红薯638AA280"
      ]
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/group-buy-products
创建小红书集市商品采集任务
打开小红书底部“市集”,搜索商品关键词,按 collect_count 采集商品;默认复制商品分享链接,解析 product_open_url / product_scheme,供后续评论人采集接口快速打开商品。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
keyword string 商品搜索关键词;兼容 search_keyword / query
collect_count integer 目标采集商品数,默认 3,最大 20;兼容 count
  • Android action_code 为 xhs_group_buy_products。
  • 复制商品链接时复用 search-lead-notes 的策略:先读常规剪贴板和无障碍事件,读不到再拉 Agent 到前台读取剪贴板,然后返回小红书。
  • collect_share_link 默认开启;max_result_scrolls / max_scrolls、startup_wait_ms、step_wait_ms、reset_task、priority、timeout_seconds 为高级调试参数,正常调用不需要传。
  • 结果 payload.data 包含 collected_product_count、product_share_urls、product_resolved_urls、product_open_urls、product_schemes 和 items。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/group-buy-products" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "keyword": "手机支架",
      "collect_count": 3
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/group-buy-product-commenters
创建小红书商品评论人采集任务
通过商品快捷地址直接打开指定商品详情页,进入“商品评价”评论弹层,按评论关键词和评论时间段过滤后,采集命中评论人的主页资料、主页分享链接和 profile_scheme。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
product_share_url string 推荐传商品分享短链;商品入口也可用 product_scheme / product_open_url / product_id
intent_keywords array|string 评论内容关键词;传入时只采集命中关键词的评论;不传或为空时不按关键词过滤,从当前评论列表第一条可采集候选开始按顺序采集;支持数组、逗号、竖线或 || 分隔
collect_count integer 目标采集评论人数,默认 3;传 0 表示不限制数量,直到评论区到底
comment_time_start string 评论开始日期,格式 YYYY-MM-DD
comment_time_end string 评论结束日期,格式 YYYY-MM-DD
  • Android action_code 为 xhs_group_buy_product_commenters。
  • 固定 review_entry_mode=product_review,只处理商品评价评论人,不再负责进入市集搜索商品。
  • collect_count=0 表示不限制采集数量;执行器会持续向下滑动商品评价弹框,直到评论区到底或连续多次列表签名不变。
  • 商品入口四选一即可,推荐传 product_share_url;服务端仍兼容 product_scheme / product_open_url / product_id / share_url / link / url。
  • collect_user_id、collect_profile_link 默认开启;滚动、等待、重置和超时等调试参数为高级参数,正常调用可不传。
  • 结果 payload.data 包含 product_scheme、product_open_url、product_share_url、product_id、intent_keywords、comment_time_start、comment_time_end、collected_count、profile_share_urls、profile_open_urls、profile_schemes 和 items。
  • items 每条会返回 comment_avatar_bounds、avatar_image_file_name、avatar_image_local_path、avatar_image_remote_url;头像图片为评论弹框内头像区域截图裁剪,不依赖小红书头像 URL。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/group-buy-product-commenters" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "product_share_url": "https://xhslink.com/m/23ZRtUO9T99",
      "intent_keywords": [
          "好",
          "用"
      ],
      "collect_count": 0
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/group-buy-shop-reputation-commenters
创建小红书店铺口碑评论人采集任务
进入商品详情页后固定打开“店铺口碑”,按顺序采集一级口碑评论人主页资料、主页分享链接和 profile_scheme。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
product_share_url string 推荐传商品分享短链;商品入口也可用 product_scheme / product_open_url / product_id
intent_keywords array|string 评论内容关键词;传入时只采集命中关键词的评论;不传或为空时不按关键词过滤,从当前评论列表第一条可采集候选开始按顺序采集;支持数组、逗号、竖线或 || 分隔
collect_count integer 目标采集评论人数,默认 3;传 0 表示不限制数量,直到评论区到底
comment_time_start string 评论开始日期,格式 YYYY-MM-DD
comment_time_end string 评论结束日期,格式 YYYY-MM-DD
  • Android action_code 为 xhs_group_buy_shop_reputation_commenters。
  • 固定 review_entry_mode=shop_reputation,只处理店铺口碑评论人。
  • collect_count=0 表示不限制采集数量;执行器会持续向下滑动店铺口碑弹框,直到评论区到底或连续多次列表签名不变。
  • 商品入口四选一即可,推荐传 product_share_url;服务端仍兼容 product_scheme / product_open_url / product_id / share_url / link / url。
  • collect_user_id、collect_profile_link 默认开启;滚动、等待、重置和超时等调试参数为高级参数,正常调用可不传。
  • 结果 payload.data 包含 collected_count、profile_share_urls、profile_open_urls、profile_schemes 和 items。
  • items 每条会返回 comment_avatar_bounds、avatar_image_file_name、avatar_image_local_path、avatar_image_remote_url;头像图片为店铺口碑弹框内头像区域截图裁剪,不依赖小红书头像 URL。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/group-buy-shop-reputation-commenters" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "product_share_url": "https://xhslink.com/m/23ZRtUO9T99",
      "intent_keywords": [
          "好",
          "用"
      ],
      "collect_count": 0
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/profile-liked-video-links
创建小红书赞过笔记链接采集任务
进入当前登录账号的小红书个人主页,打开“赞过”类目,按 video_only 参数决定只采视频笔记,或按赞过页顺序采集图文和视频笔记;逐个打开详情页采集作品快捷跳转地址、点赞数、收藏数、评论数,并复制分享链接解析 note_open_url / note_scheme 后上报。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
collect_count integer 采集赞过笔记数量,默认 1;0 表示尽量采到列表到底,当前保护上限 200
video_only boolean 是否只采视频笔记,默认 true;传 false 时按赞过页顺序采集图文和视频笔记
  • 第一版固定采当前登录账号“我 -> 赞过”,profile_open_mode 为 self,不采他人主页隐藏赞过。
  • video_only=true 时 Android 端只处理 content-desc 以“视频,”开头的赞过卡片,自动跳过“笔记,”图文卡片;video_only=false 时图文和视频都会纳入候选。
  • 打开卡片时会点击封面安全区域,避开右下角已点赞按钮,避免误取消点赞。
  • 默认保持强制 UI / task interaction mode 开启;坐标兜底点击和下滑赞过列表时临时关闭,完成后立即恢复。
  • items 每条包含 source_tab、card_type、card_title、card_author、card_like_count_raw/count、title、author_nickname、like_count_raw/count、comment_count_raw/count、favorite_count_raw/count、share_url、resolved_url、note_id、note_type、xsec_token、note_open_url、note_scheme。
  • 小红书作品详情页当前没有暴露“私信数量”数值,结果会返回 private_message_count_status=not_exposed;如果业务口径实际为评论数,请读取 comment_count_raw/comment_count。
  • 服务端仍兼容 collect_video_count / video_count / count、collect_share_link、等待、重置、优先级和超时参数作为高级参数。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.profile_liked_video_links.completed 或 xiaohongshu.profile_liked_video_links.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/profile-liked-video-links" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "collect_count": 5,
      "video_only": false
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/search-lead-note-comments
创建采集评论人资料任务
消费小红书搜索获客笔记任务已产出的 note_scheme / note_open_url / share_url / note_id,打开指定作品详情页,进入评论区,按意向关键词命中评论正文,可选按评论地区与评论时间过滤,然后点击命中评论人的头像进入主页,采集昵称、小红书号、IP 属地、地区、关注数、粉丝数、获赞与收藏数等资料;可选对命中的评论执行回复。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
note_scheme string 小红书 App 内打开作品的 scheme;优先使用搜索获客笔记任务 items.note_scheme
note_open_url string 小红书网页作品地址;没有 note_scheme 时可用
intent_keywords array|string 意向关键词;传入时只采集命中关键词的评论;不传或为空时不按关键词过滤,从当前评论列表第一条可采集候选开始按顺序采集;支持数组、逗号、竖线或 || 分隔
collect_count integer 目标采集评论人数,默认 0 表示不限,最大 50
exclude_author boolean 是否跳过作者本人评论,默认 false
comment_regions array|string 评论元信息地区过滤,例如 湖北;支持数组、逗号、竖线或 || 分隔
comment_time_start string 评论日期开始,格式 YYYY-MM-DD
comment_time_end string 评论日期结束,格式 YYYY-MM-DD
reply_comment boolean 是否对通过关键词、地区、时间筛选的评论执行回复,默认 false
reply_content string 回复内容;reply_comment=true 时必填,兼容 comment_reply_content / reply_text / comment_reply_text
  • 该接口与 /v1/apps/douyin/search-lead-video-comments 的定位一致:都需要先传入作品入口(小红书 note_scheme / note_open_url / share_url / note_id;抖音 video_link / aweme_id),接口本身不负责搜索作品。
  • 该接口依赖作品入口,推荐先调用 /v1/apps/xiaohongshu/search-lead-notes 采集 note_scheme / note_open_url / share_url / note_id,再把其中一条作品传入本接口。
  • 公开文档推荐 note_scheme;note_open_url 作为次选兜底。服务端仍兼容 share_url / note_id / xsec_token / note_type、open_scheme / open_url / link / url、keywords / keyword / match_keywords、commenter_count / max_commenters 等历史字段。
  • collect_profile、collect_user_id、collect_profile_link 默认开启;max_comment_scrolls 默认不限,等待、优先级和超时参数保留为高级参数。
  • 开启 reply_comment 后,只会对已通过关键词、地区、时间筛选的评论点击同卡片内“回复”按钮并发送 reply_content;同时开启 collect_profile 时会先采集主页,再返回评论区回复。
  • 创建接口只负责入队,成功响应只返回 job_id/status;采集完成后的完整数据请用 GET /v1/jobs/{job_id} 查看 data.result_payload,或用 GET /v1/callback-reports/{report_id} 查看 payload.data。
  • GET /v1/jobs/{job_id} 的 data.result_payload 会返回 note_id、note_scheme、intent_keywords、requested_count、collected_count、failed_count、processed_comment_count、scroll_rounds、stagnant_rounds、stop_reason、items、failed_items。
  • items 中每条评论人资料包含 nickname、xhs_user_id、profile_ip_location、profile_region、following_count_raw、follower_count_raw、liked_favorite_count_raw、profile_url、profile_open_url、profile_scheme、profile_link_status、matched_keyword、comment_text、comment_time_raw、comment_date、comment_region、comment_level、is_author、comment_avatar_bounds、comment_card_bounds、avatar_image_file_name、avatar_image_local_path、avatar_image_remote_url、reply_status、reply_content、reply_error、reply_button_bounds、reply_send_button_bounds。
  • avatar_image_* 为评论区头像区域截图裁剪文件信息;头像裁剪发生在点击评论头像进入主页之前,不改变原有主页采集逻辑。
  • collect_profile_link 默认开启:进入评论人主页后会点击右上角“更多”并复制主页链接,解析 https://www.xiaohongshu.com/user/profile/{profile_user_id},同时生成候选快捷跳转 profile_scheme=xhsdiscover://user/{profile_user_id}?xsec_token=...&xsec_source=app_share;如果 scheme 受版本影响不可用,profile_open_url 可作为兜底入口。
  • failed_items 会记录已命中但头像点击失败或主页未进入的评论,failure_reason 常见 avatar_click_failed / profile_not_entered。
  • 评论区识别以真机 UI 为准:评论入口 content-desc 类似“评论 2958”,评论区标题类似“共 2958 条评论”,评论卡片由昵称、评论正文、“日期 地区 回复”等元信息组合识别。
  • 评论区下滑会临时关闭 task interaction mode,并通过评论区签名变化判断是否真实翻页;到达底部、连续签名不变或达到 max_comment_scrolls 时停止。
  • 任务完成后本地“上报数据”事件名为 xiaohongshu.search_lead_note_comments.completed 或 xiaohongshu.search_lead_note_comments.failed。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/search-lead-note-comments" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "note_scheme": "xhsdiscover://item/69e0ea08000000001a020826?xsec_token=...&xsec_source=app_share&type=video",
      "intent_keywords": [
          "价",
          "价格",
          "报价",
          "多少钱"
      ],
      "collect_count": 10,
      "exclude_author": true
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/xiaohongshu/reply-collected-comment
回复已采集的小红书评论
根据之前采集到的笔记入口和评论内容,重新打开小红书笔记,从评论区查找指定评论并发送回复。适合客户先采集评论,再对某一条评论单独下发回复。
小红书业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
note_scheme string 小红书 App 内打开笔记的 scheme,推荐优先传;兼容 open_scheme / scheme
note_open_url string 小红书网页笔记地址;兼容 open_url
share_url string 小红书分享短链;兼容 link / url
note_id string 笔记 ID;没有 scheme/open_url/share_url 时可传
comment_text string 要回复的原评论内容;兼容 target_comment_text / content
reply_content string 要发送的回复内容;兼容 comment_reply_content / reply_text / comment_reply_text
nickname string 原评论昵称,用于同内容评论辅助校验;兼容 commenter_nickname / target_nickname
comment_time_raw string 原评论时间原文,用于辅助校验;兼容 comment_time / target_comment_time_raw
comment_date string 原评论日期 YYYY-MM-DD,用于辅助校验
comment_region string 原评论地区,用于辅助校验;兼容 region / target_comment_region
max_comment_scrolls integer 最多下滑查找评论轮数,默认 60;评论较多时可调大
  • 入口参数 note_scheme / note_open_url / share_url / note_id 至少传一个;推荐直接使用采集接口返回的 note_scheme。
  • 匹配策略以 comment_text 精确归一化匹配为主,不依赖历史坐标;nickname、时间、地区用于辅助排查同内容评论。
  • 任务完成后可通过 GET /v1/jobs/{job_id} 查看 data.result_payload,核心字段包含 matched、matched_comment_text、reply_status、reply_error、reply_button_bounds、reply_send_button_bounds。
  • 如果原评论被删除、折叠或 max_comment_scrolls 内未找到,会返回失败并在 result_payload 中体现 matched=false / target_comment_not_found。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/xiaohongshu/reply-collected-comment" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001",
      "note_scheme": "xhsdiscover://item/6912dc820000000007017f4a?xsec_token=...&xsec_source=app_share&type=normal",
      "nickname": "用户已注销",
      "comment_text": "请问下客厅摆这个镜子 如果不开灯路过镜子会被吓到吗[皱眉R]",
      "comment_time_raw": "2025-11-14 ",
      "comment_date": "2025-11-14",
      "comment_region": "贵州",
      "reply_content": "您好,稍后私信您",
      "max_comment_scrolls": 60
  }'

在线调试

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

微信业务接口

面向外部业务系统的正式下单接口。
POST /v1/apps/wechat/private-message
创建微信私聊消息任务
向指定联系人发送一条私聊消息。支持文本、图片、视频和多文件;图片/视频走聊天相册发送,文件走聊天文件入口发送。
微信业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
contact_name string 联系人名称,兼容 recipient_name
message_type string 消息类型:text | image | video | file;不传时按媒体字段自动推断,默认 text
message string 文本内容;text 模式必填,image/video/file 模式可选,传入后会在素材发送后再发送文字
material_ids array<string>|string 图片/视频素材 ID 列表,支持 JSON 数组或 || / | 分隔字符串
image_urls array<string>|string 图片 URL 列表,支持 JSON 数组或 || / | 分隔字符串
image_paths array<string>|string 预留:本地图片路径模式
image_count integer 图片发送数量,最多 9
video_urls array<string>|string 视频 URL 列表
video_url string video_urls 的单条兼容写法
video_paths array<string>|string 预留:本地视频路径模式
video_material_ids array<string>|string 视频发送时 material_ids 的兼容字段
video_count integer 视频发送数量,最多 1
file_urls array<string>|string 文件 URL 列表,当前最多 9 个
file_url string file_urls 的单条兼容写法
file_paths array<string>|string 本地文件路径列表,当前最多 9 个
file_material_ids array<string>|string 文件发送时 material_ids 的兼容字段
file_count integer 文件发送数量,当前最多 9
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,文本默认 120 秒,图片/视频/文件默认 240 秒
  • 纯文本调用保持兼容:只传 device_id、contact_name、message 即可。
  • 传 video_urls / video_url / video_paths / video_material_ids 时会自动推断 message_type=video。
  • 传 image_urls / image_paths / image_material_ids / material_ids / media_urls 时会自动推断 message_type=image。
  • 传 file_urls / file_url / file_paths / file_material_ids 时会自动推断 message_type=file,当前最多发送 9 个文件。
  • 若提供 material_ids,Android 端优先按本地缓存素材解析;若提供 URL,Android 端会先下载并写入相册,再从聊天相册发送。
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_type": "image",
      "image_urls": [
          "https://example.com/a.jpg"
      ],
      "message": "你好,这是一条图片联调消息。"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/wechat/group-message
创建微信群消息任务
向指定群聊发送消息。支持文本、图片、视频和多文件;图片/视频走聊天相册发送,文件走聊天文件入口发送。
微信业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
group_name string 群名称,兼容 recipient_name
message_type string 消息类型:text | image | video | file;不传时按媒体字段自动推断,默认 text
message string 文本内容;text 模式必填,image/video/file 模式可选,传入后会在素材发送后再发送文字
material_ids array<string>|string 图片/视频素材 ID 列表,支持 JSON 数组或 || / | 分隔字符串
image_urls array<string>|string 图片 URL 列表,支持 JSON 数组或 || / | 分隔字符串
image_paths array<string>|string 预留:本地图片路径模式
image_count integer 图片发送数量,最多 9
video_urls array<string>|string 视频 URL 列表
video_url string video_urls 的单条兼容写法
video_paths array<string>|string 预留:本地视频路径模式
video_material_ids array<string>|string 视频发送时 material_ids 的兼容字段
video_count integer 视频发送数量,最多 1
file_urls array<string>|string 文件 URL 列表,当前最多 9 个
file_url string file_urls 的单条兼容写法
file_paths array<string>|string 本地文件路径列表,当前最多 9 个
file_material_ids array<string>|string 文件发送时 material_ids 的兼容字段
file_count integer 文件发送数量,当前最多 9
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,文本默认 120 秒,图片/视频/文件默认 240 秒
  • 纯文本调用保持兼容:只传 device_id、group_name、message 即可。
  • 传 video_urls / video_url / video_paths / video_material_ids 时会自动推断 message_type=video。
  • 传 image_urls / image_paths / image_material_ids / material_ids / media_urls 时会自动推断 message_type=image。
  • 传 file_urls / file_url / file_paths / file_material_ids 时会自动推断 message_type=file,当前最多发送 9 个文件。
  • image/video/file 模式允许只发素材不带 message;若传 message,会先发素材再发文字。
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_type": "video",
      "video_urls": [
          "https://example.com/demo.mp4"
      ],
      "message": "这是群聊视频联调消息。"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/apps/wechat/account-info
创建微信账号信息采集任务
打开微信并切到“我”页,提取当前登录账号的昵称、微信号和头像节点信息。
微信业务接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
priority integer 任务优先级,默认 100
timeout_seconds integer 超时时间,默认 90 秒
  • 该接口只负责下发任务,账号信息会在 Android 端执行完成后,通过 /v1/terminals/report-job 的 result_payload 回传。
  • 当前 result_payload 会返回 nickname、wechat_id、wechat_id_text、avatar_base64,以及 avatar_node 节点信息。
curl -X POST "https://mobilerpa.wymi.net/v1/apps/wechat/account-info" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "android_001"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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"
  }'

在线调试

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

任务查询与控制接口

面向外部业务系统查询任务状态、读取采集结果和取消任务。创建类接口只返回 job_id,最终采集数据以这里的 result_payload 或上报数据为准。
GET /v1/jobs/{job_id}
查询任务详情与采集结果
按任务 ID 返回完整任务记录。任务完成后,采集数据位于 data.result_payload;小红书搜索获客会包含 items、failed_items、note_ids、note_schemes 等字段。
任务查询与控制接口 X-Api-Token 无请求体

字段说明

字段类型必填说明
job_id string 任务 ID,路径参数
  • 创建任务接口不会同步等待真机执行,所以不会直接返回采集数据;外部系统应轮询本接口直到 status 为 succeeded/failed/cancelled/timeout。
  • 小红书搜索获客验收重点字段:data.result_payload.collected_count、failed_count、items、failed_items、note_ids、note_schemes、stop_reason。
  • items 内每条有效采集必须有 note_id 和 note_scheme;复制或解析失败的候选会进入 failed_items,并计入 failed_count。
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"

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
GET /v1/jobs/{job_id}/logs
查询任务运行日志
按任务 ID 返回结构化运行日志,便于排查真机页面、滑动、复制链接和停止原因。
任务查询与控制接口 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"

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/jobs/clear-active
清空设备进行中任务
按设备清理未结束任务。排队中的任务会直接标记 cancelled;已拉取或执行中的任务会标记 cancel_requested,设备稍后通过 pull-cancel 拉取并中断。
任务查询与控制接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
device_id string 目标设备 ID
  • 该接口用于客户设备状态异常、准备重新跑任务前清场。
  • 该接口只处理 queued/pulled/running 等未结束任务,不会改动 succeeded/failed/cancelled/timeout 历史任务。
  • 如果任务正在真机执行,取消生效速度取决于手机端下一次拉取取消指令和执行器检查取消点。
curl -X POST "https://mobilerpa.wymi.net/v1/jobs/clear-active" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "device_id": "dev_063aae2c2bfea4f70f27d3d6"
  }'

在线调试

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

设备同步接口

仅供 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"
      }
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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"
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/terminals/report-job-item
增量回传采集条目
设备在长任务执行过程中,每采集到一条评论或用户资料就先回传一条,避免任务中途卡死导致已采集数据丢失。
设备同步接口 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
job_id string 任务 ID
app_code string 应用编码,例如 douyin / xiaohongshu
action_code string 任务动作编码
item_type string 条目类型,例如 commenter
item_index integer 当前条目序号
item_key string 去重键,建议由平台、用户、评论内容、时间等字段组成
item object 单条采集结果原始内容
  • 后端按 job_id + item_key 去重保存,重复上报会覆盖同一条。
  • GET /v1/jobs/{job_id} 会返回 incremental_item_count 和 incremental_items;任务没结束也能查询已采集数据。
  • 最终 /v1/terminals/report-job 仍保留,用于回传任务最终状态和完整汇总。
curl -X POST "https://mobilerpa.wymi.net/v1/terminals/report-job-item" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "job_id": "job_20260709061642_8975f88a",
      "app_code": "douyin",
      "action_code": "search_lead_video_comments",
      "item_type": "commenter",
      "item_index": 1,
      "item_key": "douyin_video_comment|nickname|comment_text|time",
      "item": {
          "nickname": "测试用户",
          "comment_text": "增量上报测试"
      }
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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"
      }
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
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>"
  }'

在线调试

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

上报数据

本地接收任务结果,上报地址未确定前先保存标准 JSON 供查看。
GET /v1/callback-reports
查看上报数据列表
返回最近保存的统一上报格式 JSON。浏览器页面入口为 /reports。
上报数据 X-Api-Token 无请求体

字段说明

字段类型必填说明
limit integer 返回数量,默认 100,最大 500
curl -X GET "https://mobilerpa.wymi.net/v1/callback-reports" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token"

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
POST /v1/callback-reports
本地接收上报数据
用于调试:按统一上报格式 POST JSON,Hub 会保存到 callback_reports.json。
上报数据 X-Api-Token JSON 请求体

字段说明

字段类型必填说明
event string 事件类型
job_id string 任务 ID
action_code string 动作编码
success boolean 是否成功
params object 任务参数
data object 业务结果
curl -X POST "https://mobilerpa.wymi.net/v1/callback-reports" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token" \
  -d '{
      "event": "douyin.search_lead_video_links.completed",
      "job_id": "job_demo",
      "device_id": "dev_demo",
      "app_code": "douyin",
      "action_code": "search_lead_video_links",
      "success": true,
      "error_code": "",
      "error_message": "",
      "timestamp": "2026-04-28 12:10:22",
      "params": {
          "keyword": "美容",
          "collect_video_count": 1,
          "filters": {
              "sort_by": "most_liked",
              "publish_time": "half_year",
              "video_duration": "gt_5_min",
              "search_scope": "not_watched",
              "content_form": "video"
          }
      },
      "data": {
          "collected_count": 1,
          "items": [
              {
                  "index": 1,
                  "link": "https://v.douyin.com/cctGfeWlnEk/",
                  "aweme_id": "7602579529424555290",
                  "resolved_video_url": "https://www.iesdouyin.com/share/video/7602579529424555290/",
                  "open_url": "https://www.douyin.com/video/7602579529424555290",
                  "open_scheme": "snssdk1128://aweme/detail/7602579529424555290",
                  "resolve_status": "redirect_1_id",
                  "title": "本地上报测试数据",
                  "nickname": "测试账号",
                  "publish_time": "",
                  "duration": "",
                  "like_text": "",
                  "candidate_type": "video",
                  "is_ad": false,
                  "raw_texts": [],
                  "avatar": {
                      "type": "screenshot_crop",
                      "format": "png",
                      "file_name": "avatar.png",
                      "base64": "",
                      "bounds": "30,2220,90,2280"
                  }
              }
          ]
      }
  }'

在线调试

请求体
响应结果 空闲
点击“发送请求”后会在这里显示返回结果。
GET /v1/callback-reports/{report_id}
查看单条上报数据
按 report_id 返回完整上报记录。
上报数据 X-Api-Token 无请求体

字段说明

字段类型必填说明
report_id string 上报记录 ID
  • 列表接口 GET /v1/callback-reports 只返回摘要,可先用 event/job_id 找到 report_id。
  • 详情接口返回完整 payload;小红书搜索获客采集数据在 payload.data.items,失败候选在 payload.data.failed_items。
curl -X GET "https://mobilerpa.wymi.net/v1/callback-reports/{report_id}" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -H "X-Api-Token: aegis-dev-token"

在线调试

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