跳到主要内容

接口概述

本接口可以使用httpwebsocket两种方式进行访问交互
websocket端口号为9911
http访问端口号为9912

http请求方式

  • 接口地址
    服务器地址:9912/api
    例:http://127.0.0.1:9912/api

  • 请求方式
    post

  • 请求内容格式
    json

websocket请求方式

使用websocket的方式请求接口可以获得更快的响应,但比http的请求方式复杂,所有请求结果都在回调函数内.
因为是异步的方式,如果想等待请求结果再进行下一步操作就需要进行异步转同步.
每个接口都会带msgid字段,服务端接收后会原样返回,用来异步转同步用.

  • 接口地址
    ws://服务器地址:9911/clinet
    例:ws://127.0.0.1:9911/clinet

  • 请求内容格式
    json

所有接口调用后都会返回成功与否,status为0代表成功,非0代表失败
失败的信息会在message说明,以下是错误码列表

错误码描述描述
1设备ID不存在
2设备在线
3分组不存在
4设备不在线
5截图失败
6没有绑定USB设备
7没有鼠标参数
8参数不正确
9通用库没有对应的型号
10配置已存在
11通用库没有对应的型号
12没有找到要删除配置
13官方库不允许删除
14USB设备没有连接
15必须竖屏
16发送热键失败
17资源图不存在
18找图失败
19OCR失败
20OCR没有识别到文字
21没有对应的坐标参数
22未知的错误
23没有重启的坐标点
24缺少关键文件
25调用接口失败
26插件未连接,可能没安装
27接口调用超时
28调用接口报错
29AirPlay服务不存在
30未发现AirPlay投屏服务
31已经在投屏中
32投屏失败