claw/docs/_tmp_sgbrowser_ws_api_doc.txt

多核浏览器管道API接口文档
一体化平台项目组
2026年3月
目录
一、API接口概述4
二、API接口定义4
1. 页面加载完成后执行回调接口4
2. 隐藏域页面加载完成后执行回调接口4
3. 执行ajax请求接口（第3种方法）5
4. 指定域执行JS代码接口6
5. 显示文本消息接口6
6. 在隐藏域打开网页接口6
7. 打开新页面接口7
8. 在新页签打开第一个url并等待加载完成后打开第二个url接口（修改）7
9. 使用指定URL打开弹出窗口接口8
10. 设置标题栏样式接口9
11. 设置左侧菜单栏样式接口9
12. 切换隐藏域页面内核接口9
13. 切换页面全屏状态接口10
14. 获取浏览器版本号接口10
15. 关闭文本消息窗接口11
16. 关闭网页弹窗接口11
17. 刷新主界面的指定页面接口11
18. 刷新隐藏域的指定页面接口12
19. 刷新指定的网页弹窗接口12
20. 获取本地服务路径接口12
21. 获取激活辅助服务窗口的页面URL接口13
22. 模拟鼠标事件接口13
23. 模拟键盘字符输入接口14
24. 模拟键盘功能键输入接口14
25. 指定domain网页执行JS代码接口15
26. 获取主界面指定页面的内核类型接口15
27. 获取隐藏域指定页面的内核类型接口16
28. 设置浏览器主题接口16
29. 获取当前浏览器的主题编号接口17
30. 获取用户闲置状态接口17
31. 打开智能体界面接口17
32. 关闭智能体界面接口18
33. 设置智能体界面宽度接口18
34. 获取当前激活标签页的URL接口18
35. 设置用户鉴权信息接口19
36. 打开左侧菜单栏接口19
37. 隐藏左侧菜单栏接口20
38. 执行ajax 请求20
39. 执行ajax 请求 (方式二)20
40. JS 回调函数21
41. 执行JS 代码22
42. 注入JS 方法22
43. 执行JS 方法22
44. 执行sql 语句23
45. 登录初始化23
46. 退出登录24
47. 设置缓存数据24
48. 获取缓存数据25
49. 在新页签打开URL，等第一个url 加载完成后，加载第二个url25
50. 获取所有已经打开的url 地址25
51. 打开本地应用26
52. 激活页签26
53. 打开消息框26
54. 关闭消息框27
55. 消息框隐藏27
56. 消息框显示27
57. 打开新页面28
58. 打开用户信息页面28
59. 隐藏用户信息页面28
60. 显示用户信息页面29
61. 设置登录后用户显示图标和名称29
62. 设置浏览器背景色29
63. 设置登录后浏览器 Logo 图标30
64. 关闭显示的页面30
65. 浏览器最大化30
66. 在隐藏域打开网页31
67. 获取隐藏域所有已经打开的 url31
68. 关闭隐藏域网址31
69. 改变消息框大小32
70. 设置浏览器模式32
71. 设置顶部标题颜色32
72. 设置左侧菜单栏颜色33
73. 修改已设置菜单属性33
74. 新增菜单34
75. 删除菜单34
三、API接口返回值34
一、API接口概述
本文档包含的内容是最新管道通信模式下的API接口说明。
API函数是多核浏览器在内核上实现的内置上下文接口，本文档是针对通过websocket通道方式调用的说明文档，用于替代Web页面在JavaScript中通过函数名称和参数调用执行，部分内置函数可以实现跨核心类型的页面注入和执行JS等操作，请查阅函数的详细说明。
目前浏览器的通信服务地址是：ws://localhost:12345，客户端调用接口必须把作为请求的页面url（requesturl）和调用接口名称及参数以json对象方式组合成json字符串作为消息发送的通道服务端作为传递方式。[requesturl,"sgBrowerserGetUrls", callback]
举例说明，比如浏览器上当前打开的页面url是http://www.baidu.com/test.html, test.html页面需要获取浏览器上所有页面的url，并以函数GetAllUrls(urls)来获取所有的页面url，查看接口列表可知第50个接口sgBrowerserGetUrls能满足这个需求，通过管道访问时，先连接到服务端“ws://localhost:12345”，根据接口【管道消息】所描述格式，要发送的消息是: ["http://www.baidu.com/test.html","sgBrowerserGetUrls", "GetAllUrls"]
二、API接口定义
1. 页面加载完成后执行回调接口
接口名称
页面加载完成后执行回调接口
接口描述
监测指定URL页面加载完成后，执行当前页面中的JS函数，自4.1.0/4.0.42开始可用
接口地址
sgBrowserCallAfterLoaded(targetUrl, callback)
管道消息
[requesturl,"sgBrowserCallAfterLoaded", targetUrl, callback]
传输参数
targetUrl: (不能为空)需要打开并监测的URL地址；callback: (不能为空)指定URL加载完成后需要执行的JS函数，包含括号和参数
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
2. 隐藏域页面加载完成后执行回调接口
接口名称
隐藏域页面加载完成后执行回调接口
接口描述
监测隐藏域中指定URL页面加载完成后，执行当前页面中的JS函数，自4.1.0/4.0.42开始可用
接口地址
sgHideBrowserCallAfterLoaded(targetUrl, callback)
管道消息
[requesturl,"sgHideBrowserCallAfterLoaded", targetUrl, callback]
传输参数
targetUrl: (不能为空)需要打开并监测的隐藏域URL地址；callback: (不能为空)指定URL加载完成后需要执行的JS函数，包含括号和参数
约束条件
1.参数数量必须相符；
2.所有参数不能为空
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
3. 执行ajax请求接口（第3种方法）
接口名称
执行ajax请求接口（第3种方法）
接口描述
根据传入的参数组合成ajax请求并执行，自4.1.7/4.0.51开始可用
接口地址
sgBrowerserJsAjax3(callback,targeturl,actionurl,requesttype,requestHeader,requestparams)
管道消息
[requesturl,"sgBrowerserJsAjax3", callback,targeturl,actionurl,requesttype,requestHeader,requestparams]
传输参数
callback:(不能为空)请求完成后的回调函数名称,请求结果以参数返回,callback(targeturl,actionurl,responseTxt)
targeturl:(不能为空)被操作网页地址
actionurl:(不能为空)调用接口url
requesttype:(不能为空)POST、GET
requestHeader:(不能为空)请求header,一个json对象，包含所有的属性名称和值
requestparams:(可为空)调用接口传入参数
约束条件
1.参数数量必须相符；
2.指定参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
4. 指定域执行JS代码接口
接口名称
在指定域中执行JS代码接口，自4.1.0/4.0.45开始可用，`agent`参数自4.1.25/4.0.71开始可用
接口描述
根据参数指示在主界面还是隐藏域中匹配制定的URL来执行JS代码
接口地址
sgBrowserExcuteJsCodeByArea(targetUrl, jsCode, area)
管道消息
[requesturl,"sgBrowserExcuteJsCodeByArea", targetUrl, jsCode, area]
传输参数
targeturl:(不能为空)注入并执行JS代码的目标页面地址
jsCode:(不能为空)要注入并执行的JS代码
area:(不能为空)指示执行的域，`show`表示在主界面中匹配，`hide`表示在隐藏域中匹配，`agent`表示指定智能体页面
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
5. 显示文本消息接口
接口名称
显示文本消息接口
接口描述
根据参数显示指定的文本消息弹窗，支持多个弹窗显示，自4.1.4/4.0.48开始可用，自4.1.10/4.0.55开始可以使用后2个参数
接口地址
sgBrowserShowTextMessage (message, msgId, seconds)
管道消息
[requesturl,"sgBrowserShowTextMessage", message, msgId, seconds]
传输参数
message: (不能为空)文本消息内容
msgId: (非必传)此消息的唯一标识
seconds: (非必传)此消息显示的时长
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
6. 在隐藏域打开网页接口
接口名称
在隐藏域打开网页接口
接口描述
在隐藏域打开指定的URL地址，并通过参数指定使用的内核，自4.1.5/4.0.49开始可用
接口地址
sgHideBrowerserOpenPage(url, core)
管道消息
[requesturl,"sgHideBrowerserOpenPage", url, core]
传输参数
url:(不能为空)要打开的页面地址
core:(非必传)要使用的内核类型，取值范围：["chromium","ie11","ie10","ie9","ie8","ie7","ie6"]
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
7. 打开新页面接口
接口名称
打开新网页接口
接口描述
在隐藏域打开指定的URL地址，并通过参数指定使用的内核，自4.1.5/4.0.49开始可用
接口地址
sgBrowerserOpenPage(url, core)
管道消息
[requesturl,"sgBrowerserOpenPage", url, core]
传输参数
url:(不能为空)要打开的页面地址
core:(非必传)要使用的内核类型，取值范围：["chromium","ie11","ie10","ie9","ie8","ie7","ie6"]
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
8. 在新页签打开第一个url并等待加载完成后打开第二个url接口（修改）
接口名称
在新页签打开第一个url并等待加载完成后打开第二个url接口
接口描述
在新页签打开第一个url并等待加载完成后打开第二个url，自4.1.5/4.0.49开始可用
接口地址
sgBrowerserOpen(url1, url2, core)
管道消息
[requesturl,"sgBrowerserOpen", url1, url2, core]
传输参数
url1:(不能为空)要打开的第一个页面地址
url2:(不能为空)url1加载完成后在当前页签打开的地址
core:(非必传)要使用的内核类型，取值范围：["chromium","ie11","ie10","ie9","ie8","ie7","ie6"]
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
9. 使用指定URL打开弹出窗口接口
接口名称
使用指定URL打开弹出窗口接口
接口描述
使用指定URL打开弹出窗口，并通过参数指定位置、大小、回调函数，4.1.5/4.0.49扩展了了参数core，4.1.29/4.0.75扩展了参数title
接口地址
sgBrowerserDialog(x,y,width,height,url,callbackFun, core, title)
管道消息
[requesturl,"sgBrowerserDialog", x,y,width,height,url,callbackFun, core, title]
传输参数
x: (不能为空)窗口x轴坐标
y: (不能为空)窗口y轴坐标
width: (不能为空)窗口宽度
height: (不能为空)窗口高度
url:(不能为空)要打开的页面地址
callbackFun: (不能为空)回调函数名称
core:(非必传)要使用的内核类型，取值范围：["chromium","ie11","ie10","ie9","ie8","ie7","ie6"]
title: (非必传)指定弹窗的标题内容
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
10. 设置标题栏样式接口
接口名称
设置标题栏样式接口
接口描述
设置浏览器顶部标题栏的背景色和文字颜色，自4.1.5/4.0.49开始可用
接口地址
sgBroewserSetTopcolor(bgColor, fontColor)
管道消息
[requesturl,"sgBroewserSetTopcolor", bgColor, fontColor]
传输参数
bgColor:(不能为空)背景色值，16进制格式："#ffffff"
fontColor:(非必传)文字颜色值，16进制格式："#ffffff"
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
11. 设置左侧菜单栏样式接口
接口名称
设置左侧菜单栏样式接口
接口描述
设置浏览器左侧菜单栏的背景色和文字颜色，自4.1.5/4.0.49开始可用
接口地址
sgBroewserSetLeftcolor(bgColor, fontColor)
管道消息
[requesturl,"sgBroewserSetLeftcolor", bgColor, fontColor]
传输参数
bgColor:(不能为空)背景色值，16进制格式："#ffffff"
fontColor:(非必传)文字颜色值，16进制格式："#ffffff"
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
12. 切换隐藏域页面内核接口
接口名称
切换隐藏域页面内核接口
接口描述
将隐藏域中指定URL地址的页面通过参数切换为指定的内核，自4.1.6/4.0.50开始可用
接口地址
sgHideBrowerserChangeCore(url, core)
管道消息
[requesturl, "sgHideBrowerserChangeCore", url, core]
传输参数
url:(不能为空)要执行切换内核的页面地址
core:(非必传)要使用的内核类型，取值范围：["chromium","ie11","ie10","ie9","ie8","ie7","ie6"]
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
13. 切换页面全屏状态接口
接口名称
切换页面全屏状态接口
接口描述
根据参数指定当前页面的全屏状态，自4.1.8/4.0.52开始可用
接口地址
sgBrowserShowFullScreen(isFullScreen)
管道消息
[requesturl,"sgBrowserShowFullScreen", isFullScreen]
传输参数
isFullScreen: (不能为空)布尔值，true或false
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
14. 获取浏览器版本号接口
接口名称
获取浏览器版本号接口
接口描述
获取浏览器版本号，并通过传入的回调函数返回，自4.1.8/4.0.52开始可用
接口地址
sgGetBrowserVersion(callback)
管道消息
[requesturl,"sgGetBrowserVersion", callback]
传输参数
callback: (不能为空)回调函数名称，通过其参数返回版本号的值，示例：
callback(version) { console.log(version) }
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
15. 关闭文本消息窗接口
接口名称
关闭文本消息窗接口
接口描述
根据参数匹配文本消息窗的唯一标识并关闭该弹窗，自4.1.10/4.0.55开始可用
接口地址
sgBrowserCloseTextMessage(msgId)
管道消息
[requesturl,"sgBrowserCloseTextMessage", msgId]
传输参数
msgId: (不能为空)此消息的唯一标识
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
16. 关闭网页弹窗接口
接口名称
关闭网页弹窗接口
接口描述
根据参数传入的窗口id关闭指定的网页弹窗，自4.1.10/4.0.55开始可用
接口地址
sgBrowerserDialogClose(dialogId)
管道消息
[requesturl,"sgBrowerserDialogClose", dialogId]
传输参数
dialogId: (不能为空)网页弹窗的窗口id
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
17. 刷新主界面的指定页面接口
接口名称
刷新主界面的指定页面接口
接口描述
根据参数传入的url查找页面并执行刷新，自4.1.10/4.0.55开始可用
接口地址
sgBrowserRefreshPage(url)
管道消息
[requesturl,"sgBrowserRefreshPage", url]
传输参数
url: (不能为空)指定网页的url地址
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
18. 刷新隐藏域的指定页面接口
接口名称
刷新隐藏域的指定页面接口
接口描述
根据参数传入的url查找页面并执行刷新，自4.1.10/4.0.55开始可用
接口地址
sgHideBrowserRefreshPage(url)
管道消息
[requesturl,"sgHideBrowserRefreshPage", url]
传输参数
url: (不能为空)指定网页的url地址
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
19. 刷新指定的网页弹窗接口
接口名称
刷新指定的网页弹窗接口
接口描述
根据参数传入的窗口id刷新指定的网页弹窗，自4.1.10/4.0.55开始可用
接口地址
sgBrowserDialogRefresh(dialogId)
管道消息
[requesturl,"sgBrowserDialogRefresh", dialogId]
传输参数
dialogId: (不能为空)网页弹窗的窗口id
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
20. 获取本地服务路径接口
接口名称
获取本地服务路径接口
接口描述
通过参数传入回调函数的名称，将本地服务的路径通过回调函数的参数返回给前端，自4.1.11/4.0.56开始可用
接口地址
sgGetLocalServicePath(callBack)
管道消息
[requesturl,"sgGetLocalServicePath", callBack]
传输参数
callBack: (不能为空)回调函数的名称
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
21. 获取激活辅助服务窗口的页面URL接口
接口名称
获取激活辅助服务窗口的页面URL接口
接口描述
通过参数传入回调函数的名称，将激活辅助服务窗口的页面URL地址通过回调函数的参数返回给前端，自4.1.12/4.0.57开始可用
接口地址
sgGetActiveUrl(callBack)
管道消息
[requesturl,"sgGetActiveUrl", callBack]
传输参数
callBack: (不能为空)回调函数的名称
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
22. 模拟鼠标事件接口
接口名称
模拟鼠标事件
接口描述
在浏览器主窗体（非屏幕）坐标处，模拟鼠标事件(自4.1.15/4.0.60开始可用)
接口地址
sgBroewserSimulateMouse(x, y, eventType, deltaX, deltay)
管道消息
[requesturl,"sgBroewserSimulateMouse", x, y, eventType, deltaX, deltay]
传输参数
x 表示html页面元素（如button）横坐标，不能为空
y 表示html页面元素（如button）纵坐标，不能为空
eventType 表示鼠标事件类型，不能为空；
left 鼠标左键单击事件
wheel 鼠标滚轮事件
deltaX 表示X方向上的移动增量，事件类型为鼠标左键单击事件时，可以为空；事件类型为滚轮事件时，不能为空
deltay表示Y方向上的移动增量，事件类型为鼠标左键单击事件时，可以为空；事件类型为滚轮事件时，不能为空
约束条件
1.参数数量必须相符；
2.必传参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
23. 模拟键盘字符输入接口
接口名称
模拟键盘字符输入
接口描述
在浏览器主窗体（非屏幕）坐标处，模拟键盘字符输入(自4.1.15/4.0.60开始可用)
接口地址
sgBroewserSimulateKeyborad (x, y, txtStr)
管道消息
[requesturl,"sgBroewserSimulateKeyborad", x, y, txtStr]
传输参数
x 表示html页面元素（如文本框）横坐标，不能为空
y 表示html页面元素（如文本框）纵坐标，不能为空
txtStr: (不能为空)文本消息内容（内容长度不能超过100）
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
24. 模拟键盘功能键输入接口
接口名称
模拟键盘功能键
接口描述
在浏览器主窗体（非屏幕）坐标处，模拟键盘功能键输入(自4.1.15/4.0.60开始可用)
接口地址
sgBroewserSimulateKeyboradFunkeys (eventType)
管道消息
[requesturl,"sgBroewserSimulateKeyboradFunkeys", eventType]
传输参数
eventType 表示键盘功能键类型，不能为空；
UpArrow方向键上
DownArrow方向键下
LeftArrow 方向键左
RightArrow 方向键右
Tab Tab键
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
25. 指定domain网页执行JS代码接口
接口名称
在指定domain中执行JS代码接口(自4.1.17/4.0.63开始可用)
接口描述
根据参数指示在主界面或隐藏域，网页url包含指定domain的页面，注入并执行JS代码
接口地址
sgBrowserExcuteJsCodeByDomain(domain, jsCode, area)
管道消息
[requesturl,"sgBrowserExcuteJsCodeByDomain",domain, jsCode, area]
传输参数
domain:(不能为空) 被注入并执行JS代码网页url的domain
jsCode:(不能为空)要注入并执行的JS代码
area:(不能为空)指示执行的域，`show`表示在主界面中匹配，`hide`表示在隐藏域中匹配，`all`表示在主界面和隐藏域中匹配
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
26. 获取主界面指定页面的内核类型接口
接口名称
获取主界面指定页面的内核类型接口
接口描述
获取主界面中指定URL地址的页面的内核类型，自4.1.19/4.0.65开始可用
接口地址
sgBrowserGetCoreType (url, callback)
管道消息
[requesturl,"sgBrowserGetCoreType",url, callback]
传输参数
url:(不能为空)要获取的页面地址
callback:(不能为空)回调函数的名称，返回值以回调函数参数形式返回，返回值范围：["chromium","ie11","ie10","ie9","ie8","ie7","ie6"]
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
27. 获取隐藏域指定页面的内核类型接口
接口名称
获取隐藏域指定页面的内核类型接口
接口描述
获取隐藏域中指定URL地址的页面的内核类型，自4.1.19/4.0.65开始可用
接口地址
sgHideBrowserGetCoreType (url, callback)
管道消息
[requesturl,"sgHideBrowserGetCoreType",url, callback]
传输参数
url:(不能为空)要获取的页面地址
callback:(不能为空)回调函数的名称，返回值以回调函数参数形式返回，返回值范围：["chromium","ie11","ie10","ie9","ie8","ie7","ie6"]
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
28. 设置浏览器主题接口
接口名称
设置浏览器主题接口
接口描述
根据参数传入的主题id设置浏览器的主题样式，自4.1.23/4.0.69开始可用
接口地址
sgBrowserSetTheme (theme_id)
管道消息
[requesturl,"sgBrowserSetTheme",theme_id]
传输参数
theme_id: (不能为空)浏览器主题id，取值范围：
0: 绿色，1: 金色，2: 蓝色，3: 红色
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
29. 获取当前浏览器的主题编号接口
接口名称
获取当前浏览器的主题编号接口
接口描述
通过参数传入回调函数的名称，将当前浏览器的主题id通过回调函数的参数返回给前端，自4.1.23/4.0.69开始可用
接口地址
sgBrowserGetTheme (callBack)
管道消息
[requesturl,"sgBrowerserJsAjax3", callBack]
传输参数
callBack: (不能为空)回调函数的名称，主题id取值范围：
0: 绿色，1: 金色，2: 蓝色，3: 红色
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
30. 获取用户闲置状态接口
接口名称
获取用户闲置状态接口
接口描述
通过参数传入回调函数的名称，将当前用户的闲置状态通过回调函数的参数返回给前端，自4.1.23/4.0.69开始可用
接口地址
sgGetUserIdleState (callBack)
管道消息
[requesturl,"sgGetUserIdleState", callBack]
传输参数
callBack: (不能为空)回调函数的名称，返回闲置状态值范围：
"true": 用户处于闲置状态，"false": 用户处于非闲置状态
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
31. 打开智能体界面接口
接口名称
打开智能体界面接口
接口描述
打开浏览器智能体界面，可选参数传入指定的智能体url，不传时使用默认配置地址，传入则会覆盖默认配置，自4.1.25/4.0.71开始可用
接口地址
sgOpenAgent (url)
管道消息
[requesturl,"sgOpenAgent", url]
传输参数
url: (可选参数)智能体页面的url地址
约束条件
1.参数数量必须相符；
2.可选不传参，或传入url，传参时参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
32. 关闭智能体界面接口
接口名称
关闭智能体界面接口
接口描述
关闭浏览器智能体界面，自4.1.25/4.0.71开始可用
接口地址
sgCloseAgent ()
管道消息
[requesturl,"sgCloseAgent"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
33. 设置智能体界面宽度接口
接口名称
设置智能体界面宽度接口
接口描述
设置浏览器智能体界面宽度，参数传入宽度值，自4.1.25/4.0.71开始可用
接口地址
sgSetAgentPageWidth (width)
管道消息
[requesturl,"sgSetAgentPageWidth", width]
传输参数
width: (不能为空)智能体页面的宽度
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
34. 获取当前激活标签页的URL接口
接口名称
获取当前激活标签页的URL接口
接口描述
通过参数传入回调函数的名称，将当前激活标签页的URL通过回调函数的参数返回给前端，自4.1.26/4.0.72开始可用
接口地址
sgGetActiveTabUrl (callBack)
管道消息
[requesturl,"sgGetActiveTabUrl", callBack]
传输参数
callBack: (不能为空)回调函数的名称，返回当前激活标签页的URL
约束条件
1.参数数量必须相符；
2.参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
35. 设置用户鉴权信息接口
接口名称
设置用户鉴权信息接口
接口描述
前端通过参数传入用户鉴权信息包括ID和token，自4.1.26/4.0.72开始可用
接口地址
sgSetAuthInfo (user_id, token)
管道消息
[requesturl,"sgSetAuthInfo", user_id, token]
传输参数
user_id:(不能为空)用户鉴权id
token:(不能为空)用户鉴权的token值
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
36. 打开左侧菜单栏接口
接口名称
打开左侧菜单栏接口
接口描述
打开左侧菜单栏（如果可用），自4.1.29/4.0.75开始可用
接口地址
sgBrowserShowLeftMenu ()
管道消息
[requesturl,"sgBrowserShowLeftMenu"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
37. 隐藏左侧菜单栏接口
接口名称
隐藏左侧菜单栏接口
接口描述
隐藏左侧菜单栏（如果可用），自4.1.29/4.0.75开始可用
接口地址
sgBrowserHideLeftMenu ()
管道消息
[requesturl,"sgBrowserHideLeftMenu"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
38. 执行ajax 请求
接口名称
执行ajax 请求
接口描述
执行ajax 请求
接口地址
sgBrowerserJsAjax(callback, targeturl, actionurl, requesttype, contentype, requestparams, accept, xRequestedwith)
管道消息
[requesturl,"sgBrowerserJsAjax", callback, targeturl, actionurl, requesttype, contentype, requestparams, accept, xRequestedwith]
传输参数
callback：不能为空。请求完成后的回调函数名称，请求结果以参数返回。
targeturl：不能为空。被操作网页地址。
actionurl：不能为空。调用接口URL。
requesttype：不能为空。请求类型（如POST、GET）。
contentype：可为空。请求中的Content-Type。
requestparams：可为空。调用接口传入参数。
accept：可为空。请求中的Accept。
xRequestedwith：可为空。请求中的X-Requested-With。
约束条件
1.参数数量必须相符；
2.指定参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
39. 执行ajax 请求 (方式二)
接口名称
执行ajax 请求 (方式二)
接口描述
执行ajax 请求 (方式二)
接口地址
sgBrowerserJsAjax2(callback, targeturl, actionurl, requesttype, requestHeader, requestparams)
管道消息
[requesturl,"sgBrowerserJsAjax3"]
传输参数
callback：(不能为空) 请求完成后的回调函数名称，请求结果以参数返回，callback(targeturl, actionurl, responseTxt)。
targeturl：(不能为空) 被操作网页地址。
actionurl：(不能为空) 调用接口url。
requesttype：(不能为空) POST、GET。
requestHeader：(可为空) 请求header，用分号隔开，如。
requestparams：(可为空) 调用接口传入参数。
约束条件
1.参数数量必须相符；
2.指定参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
40. JS 回调函数
接口名称
JS 回调函数
接口描述
可通过此函数，返回执行js的结果(主要用于目标 URL 执行完成后返回结果)。执行actionurl后将值responseTxt返回给sourceUrl页面的callback函数
接口地址
callBackJsToCpp(param)
管道消息
[requesturl,"callBackJsToCpp",param]
传输参数
参数必须按格式 sourceUrl@_@targetUrl@_@callback@_@actionUrl @_@responseTxt，不能缺省。
代码示例：
// 请求 25.215.192.15 中的某个接口的返回：
var xhr = new XMLHttpRequest();
xhr.open('GET', 'http://25.215.192.15/api/getRoleId');
xhr.setRequestHeader("Content-Type", "application/x-www-form-urlencoded");
xhr.onreadystatechange = function() {
if (xhr.readyState === 4) {
var textRes = xhr.responseText;
callBackJsToCpp("http://127.0.0.1/b.html@_@http://25.215.192.15/f1-szhxgs-main@_@callBackMethod@_@http://25.215.192.15/api/getRoleId@_@" + textRes);
}
}
xhr.send();
约束条件
参数必须符合指定格式
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
41. 执行JS 代码
接口名称
执行JS 代码
接口描述
执行JS 代码
接口地址
sgBrowserExcuteJsCode(targeturl, jsCode)
管道消息
[requesturl,"sgBrowserExcuteJsCode", targeturl, jsCode]
传输参数
targeturl：不能为空。被操作网页地址。
jsCode：不能为空。js 代码
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
42. 注入JS 方法
接口名称
注入JS 方法
接口描述
注入JS 方法
接口地址
sgBrowserRegJsFun(targeturl, funContent)
管道消息
[requesturl,"sgBrowserRegJsFun", targeturl, funContent]
传输参数
targeturl：不能为空。被操作网页地址。
funContent：不能为空。方法内容。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
43. 执行JS 方法
接口名称
执行JS 方法
接口描述
执行JS 方法
接口地址
sgBrowserExcuteJsFun(targeturl, funName)
管道消息
[requesturl,"sgBrowserExcuteJsFun", targeturl, funName]
传输参数
targeturl：不能为空。被操作网页地址。
funName：不能为空。方法名称，不带括号。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
44. 执行sql 语句
接口名称
执行sql 语句
接口描述
执行sql 语句
接口地址
sgBrowserJsSql(callback, sqlStr)
管道消息
[requesturl,"sgBrowserJsSql", callback, sqlStr]
传输参数
callback：回调函数，执行结果通过回调返回。
sqlStr：不能为空。SQL语句。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
45. 登录初始化
接口名称
登录初始化
接口描述
登录初始化
接口地址
sgBrowserLogin(obj)
管道消息
[requesturl,"sgBrowserLogin",obj]
传输参数
Obj为json对象
obj 示例：
{
appName: '*** 一体化平台 ',
userName: ' 张三 ',
orgName: '*** 供电所 ',
menus: [
{
name: ' 我的应用 ',
normalImg: 'AAAAAYlQTkcNChoKA........', // 正常情况下 Base64 编码的图片
activeImg: 'qYOjo29sh7178BXiB........', // 选中状态图片
url: 'http://www.baidu.com'
},
{
name: ' 我的报表 ',
normalImg: 'AAAAAYlQTkcNChoKA........',
activeImg: 'qYOjo29sh7178BXiB........',
url: 'http://www.qq.com'
}
// ...
]
}
约束条件
Obj对象格式是系统内部提供的，如示例
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
46. 退出登录
接口名称
退出登录
接口描述
退出登录
接口地址
sgBrowerserLogout()
管道消息
[requesturl,"sgBrowerserLogout"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
47. 设置缓存数据
接口名称
设置缓存数据
接口描述
浏览器设置本地数据，需要更新时重新调用此方法即可。
接口地址
sgBrowerserSetStorage(key, val)
管道消息
[requesturl,"sgBrowerserJsAjax3"]
传输参数
key：键值。
val：数据。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
48. 获取缓存数据
接口名称
获取缓存数据
接口描述
获取缓存数据
接口地址
sgBrowerserGetStorage(key, callback)
管道消息
[requesturl,"sgBrowerserGetStorage", key, callback]
传输参数
key：键值。
callback：获取值通过此函数回调，包含两个参数。
function getCallBack(key, val) {
console.log(key, val);
document.getElementById("getVal").value = val;
}
function getTest() {
var key = document.getElementById("getKey").value;
sgBrowerserGetStorage(key, "getCallBack");
}
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
49. 在新页签打开URL，等第一个url 加载完成后，加载第二个url
接口名称
在新页签打开URL，等第一个url 加载完成后，加载第二个url
接口描述
在新页签打开URL，等第一个url 加载完成后，加载第二个url
接口地址
sgBrowerserOpen(url1, url2)
管道消息
[requesturl,"sgBrowerserOpen", url1, url2]
传输参数
url1：先打开。
url2：加载完成后在当前页签打开。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
50. 获取所有已经打开的url 地址
接口名称
获取所有已经打开的url 地址
接口描述
获取所有已经打开的url 地址
接口地址
sgBrowerserGetUrls(callback)
管道消息
[requesturl,"sgBrowerserGetUrls", callback]
传输参数
callback：获取值通过此函数回调，包含一个参数，其中urls是通过分号隔开的字符串。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
51. 打开本地应用
接口名称
打开本地应用
接口描述
打开本地应用
接口地址
sgBrowerserOpenEXE(pathExe)
管道消息
[requesturl,"sgBrowerserOpenEXE", pathExe]
传输参数
pathExe：本地应用绝对地址。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
52. 激活页签
接口名称
激活页签
接口描述
激活页签
接口地址
sgBrowerserActiveTab(url, callback)
管道消息
[requesturl,"sgBrowerserActiveTab", url, callback]
传输参数
url:页签地址全路径，此处是全路径匹配才会激活页签，如果未发现匹配项，不做任何处理。
callback：激活后的回调，callBackFun(isActive)参数为激活结果，找到标签为1，未找到未0
代码示例：
function callBackFun(isActive){
//isActive 找到标签为 1 ，未找到为 0
console.log(isActive);
}
function acticeTabTest(){
var url = "https://www.baidu.com";
var res = sgBrowerserActiveTab(url,'callBackFun');
}
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
53. 打开消息框
接口名称
打开消息框
接口描述
打开消息框
接口地址
sgBrowerserOpenMessage(url, width, height)
管道消息
[requesturl,"sgBrowerserOpenMessage", url, width, height]
传输参数
url：消息框打开的网页地址。
width：消息框宽度。
height：消息框高度。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
54. 关闭消息框
接口名称
关闭消息框
接口描述
关闭消息框
接口地址
sgBrowerserMessageClose()
管道消息
[requesturl,"sgBrowerserMessageClose"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
55. 消息框隐藏
接口名称
消息框隐藏
接口描述
消息框隐藏
接口地址
sgBrowerserMessageHide()
管道消息
[requesturl,"sgBrowerserMessageHide"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
56. 消息框显示
接口名称
消息框显示
接口描述
消息框显示
接口地址
sgBrowerserMessageShow()
管道消息
[requesturl,"sgBrowerserMessageShow"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
57. 打开新页面
接口名称
打开新页面
接口描述
打开新页面
接口地址
sgBrowerserOpenPage(url)
管道消息
[requesturl,"sgBrowerserOpenPage",url]
传输参数
url:新页面url地址
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
58. 打开用户信息页面
接口名称
打开用户信息页面
接口描述
打开用户信息页面
接口地址
sgBrowerserOpenUser(url, width, height)
管道消息
[requesturl,"sgBrowerserOpenUser"，url, width, height]
传输参数
url：打开用户信息页面地址。
width：用户信息页面框宽度。
height：用户信息页面框高度。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
59. 隐藏用户信息页面
接口名称
隐藏用户信息页面
接口描述
隐藏用户信息页面
接口地址
sgBrowerserHideUser()
管道消息
[requesturl,"sgBrowerserHideUser"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
60. 显示用户信息页面
接口名称
显示用户信息页面
接口描述
显示用户信息页面
接口地址
sgBrowerserShowUser()
管道消息
[requesturl,"sgBrowerserShowUser"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
61. 设置登录后用户显示图标和名称
接口名称
设置登录后用户显示图标和名称
接口描述
设置登录后用户显示图标和名称
接口地址
sgBrowerserSetUser(userImg, username)
管道消息
[requesturl,"sgBrowerserSetUser"，userImg, username]
传输参数
userImg：图标的 base64 编码。
username：用户名称。
代码示例：
var userImg = " 图标的 base64 编码 ";
var res = sgBrowerserSetUser(userImg, ' 张三 ');
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
62. 设置浏览器背景色
接口名称
设置浏览器背景色
接口描述
设置浏览器背景色
接口地址
sgBrowerserSetBackColor(colorvalue)
管道消息
[requesturl,"sgBrowerserSetBackColor", colorvalue]
传输参数
colorvalue:颜色值。
代码示例：
var res = sgBrowerserSetBackColor('#ffffff');
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
63. 设置登录后浏览器 Logo 图标
接口名称
设置登录后浏览器 Logo 图标
接口描述
设置登录后浏览器 Logo 图标
接口地址
sgBrowerserSetLogoImg(img)
管道消息
[requesturl,"sgBrowerserSetLogoImg",img]
传输参数
Img：图标的 base64 编码
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
64. 关闭显示的页面
接口名称
关闭显示的页面
接口描述
接口地址
sgBrowserClosePage(url)
管道消息
[requesturl,"sgBrowserClosePage", url]
传输参数
url:要关闭的页面的url
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
65. 浏览器最大化
接口名称
浏览器最大化
接口描述
接口地址
sgBrowserMaxShow()
管道消息
[requesturl,"sgBrowserMaxShow"]
传输参数
无
约束条件
无
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
66. 在隐藏域打开网页
接口名称
在隐藏域打开网页
接口描述
接口地址
sgHideBrowerserOpenPage(url)
管道消息
[requesturl,"sgHideBrowerserOpenPage", url]
传输参数
url:要打开的网页的url
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
67. 获取隐藏域所有已经打开的 url
接口名称
获取隐藏域所有已经打开的 url
接口描述
接口地址
sgHideBrowerserGetUrls(callBackFun)
管道消息
[requesturl,"sgHideBrowerserGetUrls",callBackFun]
传输参数
callBackFun：获取值通过此函数回调，包含一个参数，其中urls是通过分号隔开的字符串。
代码示例：
function callBackFun(urls) {
console.log(urls);
}
var res = sgHideBrowerserGetUrls("callBackFun");
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
68. 关闭隐藏域网址
接口名称
关闭隐藏域网址
接口描述
接口地址
sgHideBrowerserClosePage(url)
管道消息
[requesturl,"sgHideBrowerserClosePage", url]
传输参数
url:在隐藏域要关闭的网页的url
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
69. 改变消息框大小
接口名称
改变消息框大小
接口描述
接口地址
sgBrowerserMessageResize(w, h)
管道消息
[requesturl,"sgBrowerserMessageResize", w, h]
传输参数
w:消息框的宽度
h：消息框的高度
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
70. 设置浏览器模式
接口名称
设置浏览器模式
接口描述
接口地址
sgBroewserSetModel(mode)
管道消息
[requesturl,"sgBroewserSetModel",mode]
传输参数
mode: 1 菜单模式，2 原模式。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
3.参数值只能使用1或者2
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
71. 设置顶部标题颜色
接口名称
设置顶部标题颜色
接口描述
接口地址
sgBroewserSetToptcolor(color)
管道消息
[requesturl,"sgBroewserSetToptcolor", color]
传输参数
color: 要设置的颜色值。
示例：sgBroewserSetToptcolor(“#tttt”)
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
72. 设置左侧菜单栏颜色
接口名称
设置左侧菜单栏颜色
接口描述
接口地址
sgBroewserSetLeftcolor(color)
管道消息
[requesturl,"sgBroewserSetLeftcolor", color]
传输参数
color: 要设置的颜色值。
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
73. 修改已设置菜单属性
接口名称
修改已设置菜单属性
接口描述
接口地址
sgBrowerserEditMenu(menuContent)
管道消息
[requesturl,"sgBrowerserEditMenu", menuContent]
传输参数
menuContent:菜单实体对象，结构如下：JSON.stringify({
name: "菜单名字",
normalImg: "图标",
activeImg: "活动图标",
url: "链接地址"
})
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
74. 新增菜单
接口名称
新增菜单
接口描述
新增菜单
接口地址
sgBrowerserAddMenu(menuContent)
管道消息
[requesturl,"sgBrowerserAddMenu", menuContent]
传输参数
menuContent:菜单实体对象，结构如下：JSON.stringify({
name: "菜单名字",
normalImg: "图标",
activeImg: "活动图标",
url: "链接地址"
})
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
75. 删除菜单
接口名称
删除菜单
接口描述
删除菜单
接口地址
sgBrowerserDelMenu(menuName)
管道消息
[requesturl,"sgBrowerserDelMenu", menuName]
传输参数
menuName:菜单名字
约束条件
1.参数数量必须相符；
2.所有参数不能为空；
返回参数
执行成功返回0
异常处理
执行失败返回非0，并记录日志
三、API接口返回值
返回值
执行结果
0
执行成功
-1
执行失败
-10001
参数不能为空
-10011
参数长度超出限制
-20001
参数不符