功能描述：用户登入后台，示例：sip/user/login?username=admin&password=md5(123456)

参数定义：无

username：帐号名称

password：帐号密码

type：前端类型，0-pc, 1-手机

功能描述：用户退出登入，后续的api调用将会无效。示例：/sip/user/logout?id=1

id：帐号id

功能描述：获取后台用户列表，示例：sip/user/queryall?page=1&count=10

参数定义：无

page： 获取第几页

count：每页数量

功能描述：获取后台用户角色列表，示例：sip/role/queryall?page=1&count=10

page： 获取第几页

count：每页数量

功能描述：获取所有用户的操作记录，示例：sip/log/queryall?page=1&count=10

参数定义：

page： 获取第几页

count：每页数量

功能描述：获取所有用户的操作记录，示例：sip/log/delete?start_time='2023-01-01 17:00:00'

参数定义：

id：日志记录id,可选参数，删除多条时id必须传0或不传此参数；id不为0时，只删除指定的某一条记录

start_time：可选参数，记录开始时间

end_time：可选参数，记录结束时间

功能描述：删除一个用户角色，示例：sip/role/delete?id=1

id：用户角色id

功能描述：新增或编辑一个用户角色，示例：sip/role/add?id=0&name=amdin

id：用户角色id,0表示新增，不为0则是修改

name：用户角色名字id

authority：用户角色可以操作的分组

功能描述：删除一个后台帐户，示例：sip/user/delete?id=1

id：帐号id

功能描述：修改用户帐户密码，示例：/sip/user/pass?id=1&password=123456&passnew=2345678

id：帐号id

password：帐号旧密码

passnew：帐号新密码

功能描述：修改后台帐户密码，示例：sip/user/edit?id=1&password=md5(123456)&passwordnew=md5(2345678)

id：帐号id

username：帐号名称

password：帐号新密码，为空则不修改

role：帐号角色

功能描述：修改后台帐户密码，示例：sip/user/addnew?id=0&username=admin&password=md5(123456)&role=2

id：帐号id，为0则是新增

username：帐号名称

password：帐号密码

role： 帐号所属的角色,0为管理员

功能描述：获取系统信息，包括cpu使用率，内存使用率，网络使用率，硬盘可用空间；返回最近一分钟的30条记录

参数定义：无

功能描述：获取登入界面的文字描述，示例：/sip/server/system/logo

参数定义：无

功能描述：获取节点负载信息，包括推流速率，拉流速率，网络发送速率，网络接收速率

参数定义：无

功能描述：获取平台接入相关参数，示例：/sip/server/system/getconfig

参数定义：无

功能描述：获取License信息，示例：/sip/system/getlicense

参数定义：无

功能描述：获取平台接入相关参数，示例：/sip/server/system/getkeyinfo

参数定义：无

功能描述：提交授权文件，ssl证书和ssl key文件，示例：/sip/server/system/uploadfile

参数定义：

type：文件类型

content：文件内容

功能描述：提交授权文件，ssl证书和ssl key文件，示例：/sip/server/system/restart

参数定义：无

功能描述：设置平台接入相关参数，示例：/sip/server/system/setconfig

参数定义：

id：SIP ID

extern_ip：公网ip

port： SIP 端口

domain：SIP 域

password：设备统一接入密码

port_range： 收流端口区间

black_id：黑名单ID，以英文逗号分隔

black_ip：黑名单IP，以英文逗号分隔

功能描述：获取平台接入相关参数，示例：/sip/server/system/getconfig

参数定义：无

功能描述：设置平台接入相关参数，示例：/sip/server/system/setconfig

参数定义：

ip： 服务器ip

port： 服务器端口

password：5.0设备接入密码

enable：是否启用：1启用，0-不启用

功能描述：获取平台通用参数，示例：/sip/server/system/getconfig

参数定义：无

功能描述：设置平台通用参数，示例：/sip/server/system/setconfig

参数定义：

listen_ip：绑定机器ip

logon_timer_out：登入Token过期时间(分钟)

streamNoneReader：设备码流断开时间(毫秒)

enable_sound：默认开启声音

enable_token：开启token验证

功能描述：获取播放协议配置参数，示例：/sip/server/system/getstreamconfig

参数定义：无

功能描述：设置播放协议配置参数，示例：/sip/server/system/setstreamconfig

参数定义：

功能描述：获取所有的流媒体服务器信息，示例：/sip/mediaserver/getall

参数定义：无

page： 获取第几页

count：每页数量

功能描述：新增一个流媒体服务器，示例：sip/mediaserver/add

name： 服务器名称

ip： ip或域名

inner_ip： 内网ip或域名

http_port： http端口

https_port：https端口

secret：鉴权码

功能描述：删除一个流媒体服务器，示例：sip/mediaserver/delete?id=1

id：流媒体服务器id

功能描述：修改流媒体服务器信息，示例：sip/mediaserver/edit

id： 服务器id

name： 服务器名称

ip： ip或域名

inner_ip： 内网ip或域名

http_port： http端口

https_port：https端口

secret：鉴权码

功能描述：添加一个设备,调用示例：sip/device/query/add?type=1&name=test123&server=0&enable=1&tcp=1

参数定义：

type：设备类型：1-RTSP/RTMP推流,2-RTSP/RTMP拉流,3-海康sdk,4-大华sdk

name：设备名称

server：服务节点：0-默认服务器

ip：设备ip，设备类型为3,4时才需要

port：设备端口，设备类型为3,4时才需要

user：设备登入用户名，设备类型为3,4时才需要

pass：设备登入密码，设备类型为3,4时才需要

enable：是否启用，1-启用，0-禁用

tcp：传输协议,0-tcp; 1-udp

功能描述：修改一个设备的属性，示例：sip/device/query/edit?deviceId=34020000&type=1&name=test123&server=0&enable=1&tcp=1

参数定义：

deviceId：设备id

type：设备类型：1-RTSP/RTMP推流,2-RTSP/RTMP拉流,3-海康sdk,4-大华sdk

name：设备名称

server：服务节点：0-默认服务器

ip：设备ip，设备类型为3,4时才需要

port：设备端口，设备类型为3,4时才需要

user：设备登入用户名，设备类型为3,4时才需要

pass：设备登入密码，设备类型为3,4时才需要

enable：是否启用，1-启用，0-禁用

tcp：传输协议,0-tcp; 1-udp

功能描述：添加一个新的通道，设备类型为 1-RTSP/RTMP推流,2-RTSP/RTMP拉流 时才能添加通道，其它设备类型不能添加

示例：sip/device/channel/add?deviceId=34020000&type=2&name=test123&stream=rtsp://admin:123456abc@192.168.3.166:554/Streaming/channels/101

参数定义：

deviceId：设备id

type：通道协议类型；1-ONVIF,2-RTSP,3-RTMP,4-HTTP,5-RTSP_PUSH,6-RTMP_PUSH

name：通道名称

user：摄像机用户名，协议类型为5、6时不需要此参数

pass：摄像机密码，协议类型为5、6时不需要此参数

stream：接入主码流url，协议类型为5、6时不需要此参数

longitude：位置信息经度

latitude：位置信息纬度

功能描述：修改一个通道的属性

示例：sip/device/channel/edit?deviceId=34020000&type=2&name=test123&stream=rtsp://admin:123456abc@192.168.3.166:554/Streaming/channels/101

参数定义：

deviceId：设备id

channelId：通道id

type：通道协议类型；1-ONVIF,2-RTSP,3-RTMP,4-HTTP,5-RTSP_PUSH,6-RTMP_PUSH

name：通道名称

user：摄像机用户名，协议类型为5、6时不需要此参数

pass：摄像机密码，协议类型为5、6时不需要此参数

stream：接入主码流url，协议类型为5、6时不需要此参数

longitude：位置信息经度

latitude：位置信息纬度

功能描述：删除一个通道

示例：sip/device/channel/delete?deviceId=34020000&channelId=34020000001320000008

参数定义：

deviceId：设备id

channelId：通道id

功能描述：获取状态发生变化的摄像机和通道列表，可能的状态变化包括：添加、删除、上线、离线、改名

示例：sip/device/query/changed

参数定义：无

返回字段的定义：

devices： 状态发生变化的设备列表

channels：状态发生变化的通道列表

changeState：状态变化，以下值的组合：1-上线；2-离线；4-新添加；8-删除；16-重命名；

新添加设备时，前端需要再次获取它下面的所有通道，channels数组中不会包含新添加设备下的通道

功能描述：添加一个新的通道，示例：sip/device/channel/updateoption?deviceId=34020000&channelId=34020000001320000008&deviceId=34020000&channelId=34020000001320000008

参数定义：

deviceId：设备id

channelId：通道id

option：通道选项: 1-是否开启音频，2-是否开启转码，3-是否按需播放，4-开启MP4视频录制，5-是否开启转码，7-大华外网对讲

enable：0-禁用；1-启用

功能描述：获取系统设备列表，只获取设备树中最顶层的设备列表，示例：sip/device/query/devices?page=1&count=15

参数定义：

page：获取第几页

count：每页设备数量

功能描述：获取单个设备的信息，示例：sip/device/query/device?deviceId=34020000001320000008

参数定义：

deviceId：设备id

功能描述：获取某个设备下的所有通道，示例：sip/device/query/channels?deviceId=34020000001320000008

参数定义：

deviceId：设备id

功能描述：拼接指定的通道列表，拼接后可以回放也可以直播，示例：sip/device/record/splice?deviceId=34020000001320000008

参数定义：

deviceId：设备id，所有的录像必须与此设备在同一个服务器

width： 合成后的视频宽度，默认值2560

height：合成后的视频高度，默认值1440

row： 合成通道的行数，默认值2

col： 合成通道的列数，默认值2

channels：json格式的通道数组，例如：["rtsp2757","485CH1","34020000001320000107"]

功能描述：把录像合成通道快进到某个时间点，示例：sip/device/record/splice?deviceId=34020000001320000008

参数定义：

streamId：合成通道ID

time：定位到录像的某个时间点，单位是毫秒

功能描述：获取所有通道，示例：sip/device/query/allchannels?page=1&count=15

参数定义：

page：获取第几页

count：每页设备数量

online：0-获取全部通道；1-只获取在线通道

功能描述：获取所有带经纬度的通道，默认只获取在线和启用的设备。示例：sip/device/query/mapchannels

参数定义：

offline： 1-包括离线的,0-不包括离线的

disabled： 1-包括禁用的,0-不包括禁用的

功能描述：获取某个设备下一个通道的信息，示例：sip/device/query/channels?deviceId=34020000001320000008&channelId=34020000001329000008

参数定义：

deviceId：设备id

channelId：通道id(可选)，没有此参数则返回设备下面的所有通道列表

功能描述：获取所有设备和设备下的所有通道列表，返回的信息经过简化，用于编辑分组时的设备列表。示例：sip/device/query/all

参数定义：无

参见：/device/query/subChannels/p>

功能描述：获取某个通道下面的所有子通道/p>

调用示例：sip/device/query/sub_channels?channelId=34020000001329000008

参数定义：

channelId：通道id

功能描述：修改设备下面一个通道的信息,调用示例：sip/device/query/channels?deviceId=34020000001320000008&channelId=34020000001329000008

参数定义：

deviceId：设备id

channelId：通道id

name：通道名称

coord：位置信息

enableSound：开启音频

功能描述：删除一个设备,调用示例：sip/device/query/delete?deviceId=34020000001320000008

参数定义：

deviceId：设备id

功能描述：设置设备的流传输模式,调用示例：sip/device/query/transport?deviceId=34020000001320000008&streamMode=0

参数定义：

deviceId：设备id

streamMode：流传输模式，可能的值为【0,1,2】；0-UDP模式，1-TCP被动，2-TCP主动

功能描述：获取一个设备下的所有通道结点，包括所有通道下面的子通道

调用示例：sip/device/query/channeltree?deviceId=34020000001320000008

参数定义：

deviceId：设备id

功能描述：获取一个设备的直接子通道，不包括通道下面的子通道，示例：sip/device/query/children?deviceId=34020000001320000008

参数定义：

deviceId：设备id

功能描述：开启通道的水印功能，并设置水印参数，下次播放才会生效，调用示例：sip/channel/waterMark?deviceId=xxx&channelId=11&type=1¶m

参数定义：

deviceId： 设备ID

channelId：通道ID

type： 水印类型：0-无水印，1-前端静态图片，2-动态硬字幕，3-动态硬图片，4-动态软字幕

param：水印参数(可选)；各参数以|分隔，格式如：fontcolor=#ff00ff|fontsize=32|x=100|y=100|text=测试字体水印

功能描述：设置播放中的视频流的字体水印参数,播放前必须在通道设置中启用类型为2的动态硬字幕水印，调用示例：sip/video/waterMark?streamId=xxx

参数定义：

streamId：播放中的视频流id

x：水印x坐标

y：水印y坐标

text：水印文本字符串，支持换行符

fontcolor：水印字体颜色(可选)

fontsize：水印字体大小(可选)

功能描述：获取某个分组下的所有设备ID和通道ID，没有通道详细信息，用于编辑分组

调用示例：sip/device/tree/query?id=34020000001320000008

参数定义：

id：父结点ID

功能描述：获取一个设备分组下的设备和通道

调用示例：sip/device/tree/query?parentId=15

参数定义：

parentId：父结点ID,0表示获取所有顶层结点

参见：/catalog/device/detail

功能描述：获取收藏夹的所有设备和通道

调用示例：sip/device/tree/query?userId=15

参数定义：

userId：用父ID

功能描述：获取指定页和页大小对应的设备分组

调用示例：sip/device/tree/querycatalog?page=1&num=10

参数定义：

page：当前请求的页

num：每页显示多少个分组

功能描述：添加设备到分组下面，或添加通道到设备下面

调用示例：sip/device/tree/additem?parentId=110106&deviceId=34020000001320000008&channelId=34020000001328000008

参数定义：

parentId： 分组ID

deviceId： 添加分组下面的设备ID

channelId：添加分组下面的通道ID

功能描述：添加设备和通道到收藏夹下面

调用示例：sip/device/tree/additem?userId=12&deviceId=34020000001320000008&channelId=34020000001328000008

参数定义：

userId： 用户ID

deviceId： 添加分组下面的设备ID

channelId：添加分组下面的通道ID

功能描述：只创建设备分组，无法携带设备和通道数据

调用示例：sip/device/tree/createitemonly?parentId=17&code=581000&name=test8888&sort=6

参数定义：

parentId：父结点ID,0表示顶层结点

code：节点编码

name：节点名称

sort：排序数，越小排在越前

功能描述：创建设备分组

调用示例：sip/device/tree/createitem

参数定义：

parentId：父结点ID,0表示顶层结点

code：节点编码

name：节点名称

sort：排序数，越小排在越前

功能描述：修改设备分组

调用示例：sip/device/tree/edititem

参数定义：

id：被修改的结点ID

code：节点编码

name：节点名称

sort：排序数，越小排在越前

功能描述：删除设备分组

调用示例：sip/device/tree/delitem?id=2

参数定义：

id：分组ID

功能描述：删除favorites下面的设备和通道

调用示例：sip/device/tree/delitem?userId=2&deviceId=34020000001320000008&channelId=34020000001329700000

参数定义：

userId：用户ID

deviceId：设备ID

channelId：设备下面的通道ID

功能描述：删除设备分组下面的设备，一个设备可能被添加到多个分组

调用示例：sip/device/tree/delitem?parentId=2&deviceId=34020000001320000008&channelId=34020000001329700000

参数定义：

parentId：分组ID

deviceId：设备ID

channelId：设备下面的通道ID

功能描述：获取设备分组共享的上级平台列表信息

调用示例：sip/device/tree/queryshare?id=52

参数定义：

id：分组ID

功能描述：预置位设置,调用示例：sip/ptz?deviceid=34020000001320000008&channelid=34020000001329000008&command=set&index=1

参数定义：

deviceid：设备id

channelid：通道id

command：控制命令：set,goto,del

index：预置位序号，01H~FFH

功能描述：预置位查询,调用示例：sip/preset/query?deviceid=34020000001320000008&channelid=34020000001329000008

参数定义：

deviceid：设备id

channelid：通道id

功能描述：添加预置位,调用示例：sip/preset/add?deviceid=34020000001320000008&channelid=34020000001329000008&name=test1&index=10

参数定义：

deviceid：设备id

channelid：通道id

name：预置位名称

index：预置位序号，取值1-255/p>

功能描述：云台控制,调用示例：sip/ptz/control?deviceid=34020000001320000008&channelid=34020000001329000008&command=left&speed=10

参数定义：

deviceid：设备id

channelid：通道id

command：控制命令：left,right,up,down,zoomin,zoomout,upleft,upright,downleft,downright

speed：速度控制,水平/垂直方向速度范围为00H~FFH;变焦速度范围由慢到快为0H~FH

isstart：1-开始云台控制，0-停止云台控制

功能描述：通过播放中的流进行云台控制,调用示例：sip/ptz/streamctrl?streamId=xxx&command=left&speed=10

参数定义：

streamId：当前播放的流id

command：控制命令：left,right,up,down,zoomin,zoomout,upleft,upright,downleft,downright

speed：速度控制,水平/垂直方向速度范围为00H~FFH;变焦速度范围由慢到快为0H~FH

isstart：1-开始云台控制，0-停止云台控制

功能描述：向目标设备发起来语音对讲请求,调用示例：sip/ptz/talk?deviceid=34020000001320000008&channelid=34020000001329000008

参数定义：

deviceid：设备id

channelid：通道id

file：可选参数，需要发送到设备的声音文件名

repeat：播放文件时重复次数,-1：无限循环

delay： 文件重复播放时的间隔，多少秒

功能描述：当前已经播放视频成功，再向目标设备发起来语音对讲请求,调用示例：sip/ptz/streamtalk?streamId={streamid}&file={file}

参数定义：

streamId：当前播放的流id

file：可选参数，需要发送到设备的声音文件名

repeat：播放文件时重复次数,-1：无限循环

delay： 文件重复播放时的间隔，多少秒

功能描述：停止语音对讲,调用示例：sip/stoptalk?streamId=xxx

参数定义：

streamId：apiOnTalkByStream返回的data

id：apiOnTalkByStream返回的id

功能描述：liveWeb服务器重新启动了：sip/on_server_started

参数定义：

功能描述：播放设备下面一个通道的视频流,调用示例：sip/play/start?deviceid=34020000001320000008&channelid=34020000001329000008

参数定义：

deviceid：设备id

channelid：通道id

substream：0-使用主码流，1-使用子码流，默认为主码流

option：播放选项：8-启用水印，32-另存为MP4文件

返回值定义：

-3：需要继续等，过2秒再请求一下；0-是表示取流成功了；其它值直接退出，表示播放失败，比如设备不在线

功能描述：停止播放通道的视频流,调用示例：sip/play/stop?deviceid=34020000001320000005&channelid=34020000001329700005

参数定义：

streamId：/play/start返回的stream值

功能描述：播放设备录像文件,调用示例：sip/replay/start?deviceid=34020000001110000297&channelid=34020000001320000002&file=1701912126_1701914458

参数定义：

deviceid：设备id

channelid：通道id

file： 文件id，按文件回放时才需要

start：回放的开始时间，GMT标准时间，单位秒

stop： 回放的结束时间，GMT标准时间，单位秒

speed：播放速度，取值为：0.5，1.0，2.0，4.0

option：回放的选项,可同时设置多个选项：1-反序回放，2-回放云端录像，不设置此位则回放设备录像，4-按时间回放，不设置此位则按文件回放，8-启用水印，16-只下载MP4文件，没有流信息返回；32-另存为MP4文件，有流信息返回

功能描述：停止播放设备录像文件,调用示例：sip/replay/stop?deviceid=34020000001110000297&channelid=34020000001320000002&file=1701912126_1701914458

参数定义：

streamId：/replay/start返回的stream值

功能描述：设置设备录像文件的播放速度,调用示例：/sip/replay/setspeed?streamId=34020000001320000002&speed=2.0

参数定义：

streamId：流id

speed：播放速度,取值必须为:0.5 1.0 2.0 4.0

功能描述：暂停播放设备录像文件,调用示例：sip/replay/pause?streamId=1701912126_1701914458

参数定义：

streamId：流id

state：1-暂停播放，0-继续播放

功能描述：大华AI摄像机的回调接口

参数定义：

无

功能描述：获取系统所有告警信息，调用示例：sip/alarm/query/list?page=1&count=15

参数定义：

page：获取第几页

num：每页数量

功能描述：删除一条告警信息，调用示例：sip/alarm/query/delete?id=1

参数定义：

id：告警id

功能描述：获取系统所有告警信息，调用示例：sip/alarm/query/deleteall

参数定义：无

功能描述：获取所有告警预案，调用示例：sip/alarmplan/query/list?page=1&count=15

参数定义：

page：获取第几页

num：每页数量

功能描述：新增告警预案，调用示例：sip/alarmplan/query/add

参数定义：json格式的参数

name：告警预案名称

snap_interval：拍照间隔，单位是秒

record_time：录像时长，单位是秒

alarm_level：告警等级

alarm_type：告警类型

alarm_method：告警方式

event_type：事件类型

enable：是否启用：0-不启用，1-启用

功能描述：添加告警预案，调用示例：sip/alarmplan/query/edit

参数定义：json格式的参数

id：告警预案id

name：告警预案名称

snap_interval：拍照间隔，单位是秒

record_time：录像时长，单位是秒

alarm_level：告警等级

alarm_type：告警类型

alarm_method：告警方式

event_type：事件类型

enable：是否启用：0-不启用，1-启用

功能描述：删除一条告警预案，调用示例：sip/alarmplan/query/delete?id=1

参数定义：

id：告警id

功能描述：获取系统所有告警预案，调用示例：sip/alarmplan/query/deleteall

参数定义：无

功能描述：绑定告警预案到通道列表，调用示例：sip/alarmplan/bind/channel

id：告警预案id

bind：绑定的通道列表,格式为json数组

unbind：取消绑定的通道列表,格式为json数组

功能描述：获取录像计划，每个通道可以绑定一个录像计划。调用示例：sip/record/plan/query?deviceid=34020000001320000008&channelid=34020000001329000008&id=1

参数定义：

deviceid：设备id

channelid：通道id

id：录像计划id

功能描述：启用录像计划，每个通道可以绑定一个录像计划。调用示例：sip/record/plan/enable?deviceid=34020000001320000008&channelid=34020000001329000008&id=1

参数定义：

deviceid：设备id

channelid：通道id

id：录像计划id

enable：是否启用录像计划，1-启用,0-禁用

功能描述：修改录像计划，每个通道可以绑定一个录像计划。此接口必须用POST

调用示例：sip/record/plan/update?id=1

参数定义：

deviceid：设备id

channelid：通道id

id：录像计划id,0表示新增，否则表示修改

enable：是否启用录像计划，1-启用,0-禁用

data：[ sunday=[ starttime="02:00:00",endtime="02:30:00"],monday=[],tuesday=[],wednesday=[],thursday=[],friday=[],saturday=[] ]

功能描述：新增录像计划，每个通道可以绑定一个录像计划。此接口必须用POST

调用示例：sip/record/plan/add?id=1

参数定义：

deviceid：设备id

channelid：通道id

id：录像计划id,0表示新增，否则表示修改

enable：是否启用录像计划，1-启用,0-禁用

data：[ sunday=[ starttime="02:00:00",endtime="02:30:00"],monday=[],tuesday=[],wednesday=[],thursday=[],friday=[],saturday=[] ]

功能描述：请求设备上传录像记录

调用示例：/record/device/upload?deviceid=34020000001320000008&channelid=34020000001329000008&time=2023-11-01

参数定义：

deviceid：设备id

channelid：通道id

time：查询时间，哪一天

功能描述：查询设备录像记录

调用示例：/record/device/query?deviceid=34020000001320000008&channelid=34020000001329000008&page=1&count=15&time=2023-11-01

参数定义：

deviceid：设备id

channelid：通道id

page：获取第几页

count：每页数量

time：查询时间，哪一天

功能描述：从服务器端查询录像记录

调用示例：sip/record/server/query?deviceid=34020000001320000008&channelid=34020000001329000008&time=2023-11-01

参数定义：

deviceid：设备id

channelid：通道id

time：查询时间，哪一天

page：获取第几页

count：每页数量

功能描述：下载设备录像文件,调用示例：sip/record/device/download?deviceid=34020000001110000297&channelid=34020000001320000002&file=1701912126_1701914458

参数定义：

deviceid：设备id

channelid：通道id

start：下载的开始时间

stop： 下载的结束时间，默认为文件的结束

speed：下载速度，取值为：0.5、1.0、2.0、4.0、8.0

功能描述：停止下载设备录像文件,调用示例：sip/record/device/stopdownload?streamId=1701912126_1701914458

参数定义：

streamId：download接口返回的流id

功能描述：从服务器端删除某个通道的录像记录

调用示例：sip/record/server/query?id=1&time=11223334

参数定义：

deviceid：设备id

channelid：通道id

time：删除哪一天的录像,不带这个参数将删除所有录像记录

功能描述：从服务器端查询加水印后的录像记录

调用示例：sip/record/saveas/query?channelId=1&start=11223334&stop=11253334

参数定义：

channelId：通道id

start：录像开始时间

stop：录像结束时间

功能描述：从服务器端删除加水印后的录像记录

调用示例：sip/record/saveas/delete?channelId=1&start=11223334&stop=11253334

参数定义：

channelId：通道id

start：录像开始时间

stop：录像结束时间

功能描述：向上级平台注册

调用示例：/sip/server/reg?id=34020000002220000001

参数定义：

id：上级平台id

功能描述：获取所有国标级联的上级相关信息，示例：/sip/server/up/getall?page=1&count=10

参数定义：

page：获取第几页

count：每页数量

online：是否在线，0-查询全部记录，1-仅仅查询在线的

功能描述：添加国标级联的上级，示例：/sip/server/up/add

参数定义：

id：数据库编号,新增时设置为0

name：名称

server_id： SIP国标编码

domain：SIP国标域

server_ip：SIP服务IP

port： SIP服务端口

username：SIP认证用户

password：SIP认证密码

local_ip：本地IP

local_port：本地端口

local_ip：注册有效期

reg_time：注册周期

reg_overdate：注册有效期

keep_alive：心跳周期

use_tcp：信令传输, 0-UDP；1-TCP

use_utf8：字符集, 0-GB2312；1-UTF8

online：是否在线，仅显示作用，不能修改

enable：是否启用，1-启用；0-未启用

功能描述：删除国标级联的上级，示例：/sip/server/up/delete

参数定义：

id：数据库产生的id编号

功能描述：共享通道给上级查看，示例：/sip/server/up/addchannel

参数定义：

id：上级平台id

data: {2,3,4,5} json data,里面每一项为通道dbid

功能描述：移除共享的通道，示例：/sip/server/up/removechannel

参数定义：

id：上级平台id

data: {2,3,4,5} json data,里面每一项为通道dbid

功能描述：共享分组给级联的上级平台查看，示例：/sip/server/up/addgroup?id=2&group=52&share=1&child=1

参数定义：

id：上级平台id

group: 分组id

share: 是否共享：1-共享，0-取消共享

child: 是否共享子结点，1-共享，0-不共享

功能描述：移除共享的分组，示例：/sip/server/up/removegroup?id=2&group=52

参数定义：

id：上级平台id

group: 分组id

功能描述：获取某个设备下的所有通道，示例：/sip/server/up/allchannels?id=2&page=1&count=15

参数定义：

id：上级平台id编号

page：获取第几页

count：每页设备数量

online：0-所有通道，1-仅仅显示在线通道

custom：自定义通道id选项，0-清除自定义通道id,1-自动生成自定义通道id，2-保持现有的自定义通道id

功能描述：获取系统中的设备总数/在线数量，推流总数/在线数量，拉流代理总数/在线数量

参数定义：无

功能描述：获取算法列表,调用示例：sip/algorithm/all?page=1&count=50

参数定义：

page：获取第几页

count：每页数量

功能描述：删除某个算法，调用示例：sip/algorithm/del?id=100

参数定义：

id：算法id

功能描述：添加一个算法

参数定义：

id：算法类型id

alarm_level：算法的告警级别

name：算法中文名称

name_en：算法英文名称

model：算法模型文件

sound：算法告警声音文件，为空时播放默认的告警声音

功能描述：修改一个算法的信息

参数定义：

id：算法类型id

alarm_level：算法的告警级别

name：算法中文名称

name_en：算法英文名称

model：算法模型文件

sound：算法告警声音文件，为空时播放默认的告警声音

功能描述：获取AI任务列表,调用示例：sip/aitask/all?page=1&count=50

参数定义：

page：获取第几页

count：每页数量

返回项的值定义：

id：任务id

type：任务类型：0-视频分析,1-图片分析

planId：配置的任务计划id，任务计划配置任务的执行时间

name：任务名称

enable：是否启用：0-未启用,1-启用

state：任务的运行状态：0-停止运行,1-运行中，2-运行后异常退出

deviceId： 任务配置的设备ID

channelId：任务配置的通道ID

channelName：通道的名称

callback：发生告警时的回调接口url

algorithm：任务关联的算法列表

功能描述：删除某个任务，调用示例：sip/aitask/del?id=100

参数定义：

id：任务id

功能描述：停止执行或开始执行一个AI任务

参数定义：

id：任务id

state：任务的状态：0-停止运行,1-开始运行

功能描述：添加一个AI任务

参数定义：

type：任务类型：0-视频分析,1-图片分析

planId：配置的任务计划id，任务计划配置任务的执行时间

name：任务名称

enable：是否启用：0-未启用,1-启用

deviceId： 任务配置的设备ID

channelId：任务配置的通道ID

callback：发生告警时的回调接口url

algorithm：任务关联的算法列表

功能描述：修改一个AI任务的信息

参数定义：

id：任务id

type：任务类型：0-视频分析,1-图片分析

planId：配置的任务计划id，任务计划配置任务的执行时间

name：任务名称

enable：是否启用：0-未启用,1-启用

deviceId：任务配置的设备ID

channelId：任务配置的通道ID

callback：发生告警时的回调接口url

algorithm：任务关联的算法列表

功能描述：获取算法列表,调用示例：sip/gamekind/all?page=1&count=50

参数定义：

page：获取第几页

count：每页数量

功能描述：获取算法列表,调用示例：sip/gamevip/all?page=1&count=50

参数定义：

无

功能描述：用户登入后台，示例：sip/game/login?username=admin&password=md5(22222)

参数定义：无

username：帐号名称

password：帐号密码

type：前端类型，0-pc, 1-手机

功能描述：用户登入后台，示例：sip/game/login?username=admin&password=md5(22222)

参数定义：无

username：帐号名称

password：帐号密码

type：前端类型，0-pc, 1-手机

功能描述：用户坐下，示例：sip/game/sitdown

参数定义：无

功能描述：用户起立，示例：sip/game/standup

参数定义：无

功能描述：用户起立，示例：sip/game/cmd?type=1¶m=10

参数定义：无

功能描述：用户起立，示例：sip/game/tableuser?KindID=1&UserID=10

参数定义：无

功能描述：用户起立，示例：sip/game/rank?type=1

参数定义：无

功能描述：用户起立，示例：sip/game/exchange?gold=100

参数定义：无

功能描述：用户起立，示例：sip/game/maillist?dwUserId=1

参数定义：无

功能描述：用户起立，示例：sip/game/inviteAward?dwUserId=1

参数定义：无

功能描述：用户起立，示例：sip/game/getAgentID?dwUserId=1

参数定义：无

功能描述：用户起立，示例：sip/game/inviteDetail?dwUserId=1

参数定义：无

功能描述：用户起立，示例：sip/game/setIDCard?dwUserId=1

参数定义：无

功能描述：用户起立，示例：sip/game/setInviteCode?dwUserId=1

参数定义：无

功能描述：用户起立，示例：sip/game/SendSms?account=1&to

参数定义：无

功能描述：获取所有注册用户列表，示例：sip/game/userlist?page=1&num=20

参数定义：无

page：获取第几页

count：每页数量

返回的数据定义：

Account：帐号

NickName：昵称

UserID：用户ID

GameID：游戏ID

Score：积分

Gold：金币

Diamond：钻石

FaceID：头像ID

VipLevel：VIP等级,1-30

Phone：电话号码

IDCard：身份证

RealName：姓名

TotalPay：累计充值

LogonIP：登入IP

HeaderUrl：头像链接地址

功能描述：获取所有在线用户列表，示例：sip/game/onlineuser?page=1&num=20

参数定义：无

page：获取第几页

count：每页数量

返回的数据定义：

Account：帐号

NickName：昵称

UserID：用户ID

GameID：游戏ID

Score：积分

Gold：金币

Diamond：钻石

FaceID：头像ID

VipLevel：VIP等级,1-30

Phone：电话号码

IDCard：身份证

RealName：姓名

TotalPay：累计充值

LogonIP：登入IP

HeaderUrl：头像链接地址

KindName：房间名称

KindID：房间ID

ChairID：座位

功能描述：获取游戏房间列表,调用示例：sip/gamekind/all?page=1&count=50

参数定义：

page：获取第几页

count：每页数量

返回的数据定义：

KindID：房间ID，每个房间唯一值

TypeID：房间的类型，可以获取房间的类型列表：1-推币机，2-游乐机，3-娃娃机

SortID：房间的排序ID

KindName：房间的名称

KindNameEng：房间的英文名称

IconID：房间的Icon ID

Enabled：房间是否启用

CellScore：房间的倍数

MinScore： 进入房间最低分数

MiniVip： 进入房间VIP等级

GameFlag： 房间的状态，用多个标志位组成的整数: 0-正常但是离线，2-设备故障，4-设备并且在线

TableID： 房间桌子模板

MaxChair： 房间坐位数

MachineId：控制板机器码

AutoPaoSpeed：自动发炮速度

channelId：房间摄像机的通道编号

deviceId：房间摄像机的设备编号

ControlChair：控制器的座位数，如果一个机器有4个坐位，每个控制器的座位数是2个，则需要2个控制器，对应会有2个机器码

功能描述：获取所有游戏记录列表，示例：sip/game/record?page=1&num=20

参数定义：无

UserId：用户ID,0-查询所有用户的，否则查询指定用户的记录

page：获取第几页

count：每页数量

返回的数据定义：

ID：记录编号

NickName：昵称

UserID：用户ID

GameID：游戏ID

ChangeScore：积分变化

NewScore：积分余额

ChangeGold：金币变化

NewGold：金币余额

KindName：房间名称

KindID：房间ID

ChairID：座位号

IP：记录IP

Descible：描述

RecordDate：时间

功能描述：获取游戏分类列表,调用示例：sip/gametype/all?page=1&count=50

参数定义：

无

返回的数据定义：

TypeID： 游戏分类ID

KindName：游戏分类名称

KindNameEng：游戏分类英文名称

SortID： 游戏分类排序ID

功能描述：删除一个游戏分类，调用示例：sip/gametype/del?id=1

参数定义：

TypeID：游戏分类ID

功能描述：删除一个游戏房间，调用示例：sip/gamekind/del?id=100

参数定义：

KindID：游戏KindID

功能描述：添加一个游戏分类列表,调用示例：sip/gametype/add?TypeID=1&SortID=10

参数定义：

TypeID： 游戏分类ID

KindName：游戏分类名称

KindNameEng：游戏分类英文名称

SortID： 游戏分类排序ID

功能描述：添加一个游戏房间

参数定义：

KindID：房间ID，每个房间唯一值

TypeID：房间的类型，可以获取房间的类型列表：1-推币机，2-游乐机，3-娃娃机

SortID：房间的排序ID

KindName：房间的名称

KindNameEng：房间的英文名称

IconID：房间的Icon ID

Enabled：房间是否启用

CellScore：房间的倍数

MinScore： 进入房间最低分数

MiniVip： 进入房间VIP等级

GameFlag： 房间的状态，用多个标志位组成的整数: 0-正常但是离线，2-设备故障，4-设备并且在线

TableID： 房间桌子模板

MaxChair： 房间坐位数

MachineId：控制板机器码

AutoPaoSpeed：自动发炮速度

channelId：房间摄像机的通道编号

deviceId：房间摄像机的设备编号

ControlChair：控制器的座位数

功能描述：修改一个游戏房间的信息

参数定义：

KindID：房间ID，每个房间唯一值

TypeID：房间的类型，可以获取房间的类型列表：1-推币机，2-游乐机，3-娃娃机

SortID：房间的排序ID

KindName：房间的名称

KindNameEng：房间的英文名称

IconID：房间的Icon ID

Enabled：房间是否启用

CellScore：房间的倍数

MinScore： 进入房间最低分数

MiniVip： 进入房间VIP等级

GameFlag： 房间的状态，用多个标志位组成的整数: 0-正常但是离线，2-设备故障，4-设备并且在线

TableID： 房间桌子模板

MaxChair： 房间坐位数

MachineId：控制板机器码

AutoPaoSpeed：自动发炮速度

channelId：房间摄像机的通道编号

deviceId：房间摄像机的设备编号

ControlChair：控制器的座位数

功能描述：获取所有API的列表和帮助

参数定义：无

功能描述：获取所有API的列表和帮助

参数定义：无