文档中心

云手机

API 参考

API 列表

API 列表

Mobile Use Agent OpenAPI 提供了移动端使用的智能代理任务管理接口，包括配置管理、任务执行和回调处理等功能。

API 列表

配置管理接口

API	描述
创建代理运行配置 CreateAgentRunConfig	创建一个新的代理运行配置，用于定义代理任务的执行参数和回调设置。
更新代理运行配置 UpdateAgentRunConfig	更新已存在的代理运行配置。
查询代理运行配置列表 ListAgentRunConfig	查询代理运行配置列表。支持设置条件筛选、支持分页查询。
删除代理运行配置 DeleteAgentRunConfig	删除指定的代理运行配置。

安全策略接口

API	描述
创建安全策略 CreateSecurityPolicy	在指定业务下创建一条安全策略，用于定义特定操作的放行、审批或拒绝等控制规则，配置后将自动应用于该业务下所有实例的任务执行。
删除安全策略 DeleteSecurityPolicy	删除指定的安全策略。删除后，该策略将不再出现在列表及查询结果中，关联的策略版本记录也会同步删除。
更新安全策略 UpdateSecurityPolicy	更新安全策略的配置。更新后，新配置将在下次策略生效时自动应用。
查询安全策略 GetSecurityPolicy	查询安全策略的详细信息，包括策略名称、描述、生效方式、优先级、规则配置及当前状态。
查询安全策略列表 ListSecurityPolicy	查询已创建的安全策略列表，支持分页查询，每条策略返回当前已启用的最新版本详细信息。

任务管理接口

API	描述
一键运行代理任务 RunAgentTaskOneStep	启动一个新的代理任务执行。该接口无需创建代理运行配置，传入请求参数后可直接运行代理任务。
运行代理任务 RunAgentTask	运行指定的代理任务。
取消代理任务 CancelTask	取消指定的正在运行的代理任务。
查询代理任务列表 ListAgentRunTask	查询代理任务列表。支持设置条件筛选、支持分页查询。
查询任务当前步骤 ListAgentRunCurrentStep	查询指定任务当前所执行到的步骤信息。
获取任务运行结果 GetAgentResult	获取指定任务的最终运行结果。
创建定时任务配置 CreateScheduledAgentRunTask	创建定时任务，系统将按照您设定的时间规律自动触发任务执行。
删除定时任务配置 DeleteScheduledAgentRunTask	删除定时任务配置，删除后该定时任务将不再自动触发执行。
更新定时任务配置 UpdateScheduledAgentRunTask	更新已有定时任务的配置信息。
查询定时任务配置列表 ListScheduledAgentRunTask	查询已创建的定时任务配置列表，支持按条件筛选与分页查看。

通用数据结构

本章节提供 Mobile Use Agent OpenAPI 的通用数据结构。

OutputSchema

参数名称	类型	是否必须	描述
Type	String	是	返回数据结构的类型，目前仅支持取值 dict。
Fields	[]FieldSchema	否	定义具体返回结构。详情参见下表 FieldSchema。

FieldSchema

参数名称	类型	是否必须	描述
Name	String	是	字段名称。
Type	String	是	字段类型。
Description	String	否	字段描述。
Required	Boolean	是	字段是否必须。
Fields	[]FieldSchema	否	子字段列表，用于定义嵌套的返回结构。

使用示例

OutputSchema 示例代码如下：

CallbackInfo

参数名称	类型	是否必须	描述
CallbackUrl	String	否	回调 URL 地址，支持 HTTP/HTTPS，代理任务执行期间产生的回调会发送到该地址。回调包括：任务状态更新回调任务执行失败回调任务中断回调
CallbackRetryLimit	Int	否	回调重试次数，例如取值为 3 表示最多回调 3 次。取值范围：1 ~ 5 默认值：3 说明超出取值范围的参数值系统会按默认值处理。
CallbackErrorCode	List[String]	否	自定义错误码，用于服务判断错误情况并决定是否重试。如 CallbackErrorCode 取值为 ["2xx"]，表示服务接收到回调返回在 200~299 间错误码时，会进行重试。重试次数由 CallbackRetryLimit 参数定义。默认值为 ["3xx", "4xx", "5xx"]。可填内容： 2xx：表示错误码 200~299 200：表示错误码 200 200~250：表示错误码 200~250
CallbackTimeout	Int	否	回调超时时间，单位：秒。取值范围：1 ~ 300 默认值：5 说明超出取值范围的参数值系统会按默认值处理。
CallbackHeaders	Dict[String]String	否	自定义回调请求头，默认为 {}，示例值：{"a": "b"}。

最近更新时间：2026.08.18 09:50:32

这个页面对您有帮助吗？

有用

有用

无用

无用