视频会议H323和SIP相关接口协议.docx
《视频会议H323和SIP相关接口协议.docx》由会员分享，可在线阅读，更多相关《视频会议H323和SIP相关接口协议.docx（52页珍藏版）》请在冰豆网上搜索。
视频会议H323和SIP相关接口协议
EPSS接口协议EPSSIP1.0
EPSSInterfaceProtocol
时间
版本
说明
作者
2008-03-11
1.0
创建
2008-03-28
1.0
评审后修改，修订设备相关操作
2008-04-03
1.0
评审后修改
二〇〇八年三月
目录
1引言7
1.1目的7
1.2范围7
1.3定义7
1.4资料7
2内部协议7
2.1总体机制7
2.2HTTP扩展头定义8
2.3PDU格式8
2.4HTTPURL格式8
2.5示例8
2.5.1一般控制8
2.6文件或数据流读取9
2.6.2文件上载保存10
3协议操作11
3.1用户登录11
3.1.1请求包11
3.1.2应答包12
3.1.3返回码12
3.2登出12
3.2.1请求包12
3.2.2应答包12
3.2.3返回码12
3.3心跳12
3.3.1请求包13
3.3.2应答包13
3.3.3返回码13
3.3.4说明13
3.4请求配置文件13
3.4.1请求包13
3.4.2应答包13
3.4.3返回码14
3.4.4说明14
3.5请求保存配置14
3.5.1请求包14
3.5.2应答包14
3.5.3返回码14
3.5.4说明14
3.6请求信息数据15
3.6.1请求包15
3.6.2应答包15
3.6.3返回码15
3.6.4说明15
3.7查询设备配置15
3.7.1请求包15
3.7.2应答包16
3.7.3返回码16
3.7.4说明16
3.8保存设备配置16
3.8.1请求包16
3.8.2应答包16
3.8.3返回码16
3.8.4说明16
3.9CU向NCMC登录设备17
3.9.1请求包17
3.9.2应答包17
3.9.3返回码17
3.10NCMC登录设备17
3.10.1请求包17
3.10.2应答包18
3.10.3返回码18
3.11CU向NTDC登录设备18
3.11.1请求包18
3.11.2应答包18
3.11.3返回码19
3.11.4说明19
3.12设备登出19
3.12.1请求包19
3.12.2应答包19
3.12.3返回码19
3.13设备连接状态通知20
3.13.1请求包20
3.13.2应答包20
3.13.3返回码20
3.13.4说明20
3.14查询权限20
3.14.1请求包20
3.14.2应答包21
3.14.3返回码21
3.15开始实时监视21
3.15.1请求包21
3.15.2应答包21
3.15.3返回码22
3.15.4说明22
3.16媒体数据通道验证22
3.16.1请求包22
3.16.2应答包22
3.16.3返回码22
3.16.4说明22
3.17关闭实时监视23
3.17.1请求包23
3.17.2应答包23
3.17.3返回码23
3.18多画面预览23
3.18.1请求包23
3.18.2应答包24
3.18.3返回码24
3.19关闭多画面预览24
3.19.1请求包24
3.19.2应答包24
3.19.3返回码24
3.20录像查询25
3.20.1请求包25
3.20.2应答包25
3.20.3返回码25
3.21网络回放25
3.21.1请求包25
3.21.2应答包26
3.21.3返回码26
3.21.4说明26
3.22关闭回放26
3.22.1请求包26
3.22.2应答包27
3.22.3返回码27
3.23回放暂停27
3.23.1请求包27
3.23.2应答包27
3.23.3返回码27
3.24回放定位28
3.24.1请求包28
3.24.2应答包28
3.24.3返回码28
3.25回放进度28
3.25.1请求包28
3.25.2应答包29
3.25.3返回码29
3.25.4说明29
3.26设备重启29
3.26.1请求包29
3.26.2应答包29
3.26.3返回码29
3.27开始设备语音对讲30
3.27.1请求包30
3.27.2应答包30
3.27.3返回码30
3.28停止设备语音对讲30
3.28.1请求包30
3.28.2应答包30
3.28.3返回码31
3.29设备12V控制31
3.29.1请求包31
3.29.2应答包31
3.29.3返回码31
3.30云台控制31
3.30.1请求包31
3.30.2应答包32
3.30.3返回码32
3.31报警信息上报32
3.31.1请求包32
3.31.2应答包32
3.31.3返回码32
3.31.4说明32
3.32新建会议33
3.32.1请求包33
3.32.2应答包33
3.32.3返回码33
3.33参加会议33
3.33.1请求包33
3.33.2应答包34
3.33.3返回码34
3.34退出会议34
3.34.1请求包34
3.34.2应答包34
3.34.3返回码34
3.35会议信息通知34
3.35.1请求包34
3.35.2应答包35
3.35.3返回码35
3.35.4说明35
3.36日志系统目录信息查询35
3.36.1请求包35
3.36.2应答包35
3.36.3返回码35
3.37日志文件信息查询35
3.37.1请求包35
3.37.2应答包36
3.37.3返回码36
3.38实时监视解码卡上墙36
3.38.1请求包36
3.38.2应答包36
3.38.3返回码37
3.39多画面预览解码卡上墙37
3.39.1请求包37
3.39.2应答包37
3.39.3返回码37
4全局资源37
4.1单元类型37
4.2配置文件类型定义38
4.3请求信息类型定义38
4.4权限类型定义38
4.5会议消息类型39
4.6设备登录返回码39
1引言
1.1目的
本协议用于指导专业网络视频监控平台的开发，定义了平台所支持的操作。
1.2范围
本协议适用于专业网络视频监控平台中各单元之间的通讯。
1.3定义
名称
描述
CU
客户端
PU
前端设备
NCMC
中心控制核心
NTDC
流媒体转发核心
NRU
存储管理单元
NMU
配置管理单元
CARD_SVR
解码卡上墙服务
1.4资料
《中心管理平台3.0－用户接入协议0.3.doc》
2内部协议
2.1总体机制
Ø协议采用HTTP协议承载
Ø传输层使用TCP的长连接
Ø协议采用应答机制
Ø使用HTTP的GET和POST方法
Ø协议头部信息包含在HTTP的扩展头部
Ø请求包数据单元采用HTTPURL格式封装
Ø应答包数据单元PDU，采用XML封装
ØContent-type在content为xml的情况下为text/xml，二进制流的情况下为octet-stream
Ø单条记录数据单元的数据项顺序无关
Ø忽略不认识的数据域
2.2HTTP扩展头定义
名称
描述
EPSS_Version
协议版本号
EPSS_UnitType
单元的类型，见4.1单元类型
EPSS_Operation
操作码
EPSS_SessionId
会话标识
EPSS_Sequence
操作顺序号
2.3PDU格式
PDU由XML封装，只包含操作的特定信息。
XML的格式如下：
xmlversion=”1.0”?
>
2.4HTTPURL格式
HTTP的URL格式为http:
//ip:
port/unitType/operation?
attr1=value1&attr2=value2&...。
举例，从监控单元发送一条监控请求到NTDC，NTDC的IP为192.168.0.1，端口在38888上，则对应的URL为http:
//192.168.0.1:
38888/NSU/monitorStart?
devid=1&channelno=0。
则HTTP的请求行为：
GEThttp:
//192.168.0.1:
38888/NSU/monitorStart?
devid=1&channelno=0HTTP/1.1
2.5示例
2.5.1一般控制
以监控模块到转发的监控请求为例。
2.5.1.1请求
GEThttp:
//192.168.0.1:
38888/NSU/monitorStart?
devid=1&channelno=0HTTP/1.1
Content-type:
text/xml
Content-length:
0
Agent:
HTTPagent
EPSS_Version:
4.0.0.1
EPSS_UnitType:
NSU
EPSS_Operation:
monitorStart
EPSS_SessionId:
1
EPSS_Sequence:
100
2.5.1.2应答
HTTP/1.1200OK
Content-type:
text/xml
Content-length:
100
Agent:
HTTPagent
EPSS_Version:
4.0.0.1
EPSS_UnitType:
NTDC
EPSS_Operation:
monitorStart
EPSS_SessionId:
1
EPSS_Sequence:
100
xmlversion=”1.0”?
>
1
0
…
2.6文件或数据流读取
以NMU向NCMC请求设备数据xml为例。
2.6.1.1请求
GEThttp:
//192.168.0.1:
39999/NMU/getConfigFile?
type=0&name=data.xmlHTTP/1.1
Content-type:
text/xml
Content-length:
0
Agent:
HTTPagent
EPSS_Version:
4.0.0.1
EPSS_UnitType:
NMU
EPSS_Operation:
getConfigFile
EPSS_SessionId:
1
EPSS_Sequence:
100
2.6.1.2应答
HTTP/1.1200OK
Content-type:
octet-stream
Content-length:
1024
Agent:
HTTPagent
EPSS_Version:
4.0.0.1
EPSS_UnitType:
NCMC
EPSS_Operation:
getConfigFile
EPSS_SessionId:
1
EPSS_Sequence:
100
data……….
2.6.2文件上载保存
以NMU向NCMC保存用户管理xml为例。
2.6.2.1请求
POSThttp:
//192.168.0.1:
39999/NMU/saveConfigFile?
type=1&name=user.xmlHTTP/1.1
Content-type:
octet-stream
Content-length:
1024
Agent:
HTTPagent
EPSS_Version:
4.0.0.1
EPSS_UnitType:
NMU
EPSS_Operation:
saveConfigFile
EPSS_SessionId:
1
EPSS_Sequence:
100
Data……….
2.6.2.2应答
HTTP/1.1200OK
Content-type:
text-xml
Content-length:
100
Agent:
HTTPagent
EPSS_Version:
4.0.0.1
EPSS_UnitType:
NCMC
EPSS_Operation:
saveConfigFile
EPSS_SessionId:
1
EPSS_Sequence:
100
xmlversion=”1.0”?
>
1
3协议操作
3.1用户登录
用户登录操作，登录成功将创建一个正式的会话，获得系统使用权限。
3.1.1请求包
操作代码
EPSS_CU_NCMC_LOGIN
方向
CU->NCMC
索引
名字
类型
长度
说明
1
unitId
String
32
各单元的唯一标识
2
UserName
String
64
用户名
3
Password
String
64
密码
4
LocalIp
String
16
CU的本机IP
5
localPort
Int32
4
CU的本机侦听端口，只对NTDC和NRU有效
6
localMask
string
16
CU的本机子网掩码
7
Expires
Int32
4
心跳超时
8
Capability
Int32
4
网卡能力
3.1.2应答包
操作代码
EPSS_CU_NCMC_LOGIN
索引
名字
类型
长度
说明
1
Expires
Int32
4
心跳超时
2
Time
Uint32
4
同步时间
3.1.3返回码
索引
值
说明
1
DHRC_HAVE_LICENCE
已注册证书
2
DHRC_NO_LICENCE
未注册证书
3
DHRC_USER_NOT_EXIST
用户不存在
4
DHRC_PASSWORD_ERROR
密码错误
3.2登出
一般来讲，一个登录操作应该对应一个登出操作。
3.2.1请求包
操作代码
EPSS_CU_NCMC_LOGOUT
方向
CU->NCMC
索引
名字
类型
长度
说明
1
unitId
String
32
各单元的唯一标识
3.2.2应答包
只有包头，包含应答码，无包体。
3.2.3返回码
无特殊返回码。
3.3心跳
心跳是系统获得用户在线状态的重要途径。
在用户意外掉线地情况下，系统在心跳逻辑的控制下，可以主动关闭连接，释放用户资源。
心跳间隔：
推荐值，1分钟。
3.3.1请求包
操作代码
EPSS_CU_HEARTBEAT
方向
CU->NCMC，CU->NTDC
索引
名字
类型
长度
说明
1
unitId
String
32
各单元的唯一标识
2
Expires
Int32
4
超时时间，单位是秒
3.3.2应答包
操作代码
EPSS_CU_HEARTBEAT
索引
名字
类型
长度
说明
1
Expires
Int32
4
超时时间，单位是秒
2
Time
Uint32
4
同步时间
3.3.3返回码
无特殊返回码。
3.3.4说明
3.4请求配置文件
客户端登录成功之后，需要向中心请求设备列表、地图等信息，以进行客户端的初始化。
3.4.1请求包
操作代码
EPSS_CU_ACQUIRE_CONF_FILE
方向
CU->NCMC
索引
名字
类型
长度
说明
1
type
Byte
1
查询类型，详见4.2配置文件类型定义
2
Filename
String
32
文件名称，请求图片时，必须填写
3.4.2应答包
直接返回数据
3.4.3返回码
索引
值
说明
1
DHRC_FILE_NOT_EXIST
无此文件
2
DHRC_FILE_OPEN_FAILED
文件打开失败
3.4.4说明
使用HTTPGET下载文件，请求包的字段填写在URL，文件数据作为应答包的content。
电子地图图片，在需要的时候才去请求，使用后保存在本地，因为图片的改动不会太大，所以，可以避免下次运行程序时重复请求。
3.5请求保存配置
配置管理单元完成配置之后，需要将配置保存到中心。
3.5.1请求包
操作代码
EPSS_CU_SAVE_CONF_FILE
方向
NMU->NCMC，NAU->NCMC
索引
名字
类型
长度
说明
1
type
Byte
1
查询类型4.2配置文件类型定义
2
Filename
String
32
文件名称，电子地图图片时必须填写
3.5.2应答包
操作代码
EPSS_CU_ACQUIRE_CONF_FILE
索引
名字
类型
长度
说明
1
type
Byte
1
查询类型
3.5.3返回码
无特殊返回码。
3.5.4说明
使用HTTPPOST上传文件，请求包的字段填写在URL中，文件数据作为请求包的包体发送
3.6请求信息数据
有些模块，如NFU，只要获得部分配置数据即可，不需要整个配置文件；还有一些信息，如证书信息、存储服务、转发服务列表等，它们应该以内存数据的形式存在。
3.6.1请求包
操作代码
EPSS_CU_ACQUIRE_INFO
方向
CU->NCMC
索引
名字
类型
长度
说明
1
type
Byte
1
查询类型，详见4.3请求信息类型定义
3.6.2应答包
直接返回数据。
3.6.3返回码
无特殊返回码
3.6.4说明
使用HTTPGET获取信息，信息作为应答包的content
3.7查询设备配置
3.7.1请求包
操作代码
EPSS_CU_QUERY_DEV_CONF
方向
CU->NTDC
索引
名字
类型
长度
说明
1
type
Byte
1
配置类型，详见网络SDK里的定义
2
Devid
int32
4
设备标识
3
channelNO
Byte
1
通道号
4
Size
Int32
4
配置长度
3.7.2应答包
直接发送数据
3.7.3返回码
无特殊返回码。
3.7.4说明
使用HTTPGET。
3.8保存设备配置
3.8.1请求包
操作代码
EPSS_CU_SAVE_DEV_CONF
方向
CU->NTDC
索引
名字
类型
长度
说明
1
type
Byte
1
配置类型，详见网络SDK里的定义
2
Devid
int32
4
设备标识
3
channelNO
Byte
1
通道号
3.8.2应答包
操作代码
EPSS_CU_SAVE_DEV_CONF
索引
名字
类型
长度
说明
1
type
Byte
1
配置类型，详见网络SDK里的定义
2
Devid
int32
4
设备标识
3
channelNO
Byte
1
通道号
3.8.3返回码
无特殊返回码
3.8.4说明
使用HTTPPOST。
3.9CU向NCMC登录设备
实际上是请求分配转发的过程。
3.9.1请求包
操作代码
EPSS_CU_ACQUIRE_NTDC
方向
CU->NCMC
索引
名字
类型
长度
说明
1
Devid
int32
4
设备标识
3.9.2应答包
操作代码
EPSS_CU_ACQUIRE_NTDC
索引
名字
类型
长度
说明
1
IP
String
16
转发服务IP
2
Port
Int32
4
转发服务端口
3
Token
Uint32
4
操作令牌，以后所有关于该设备的操作请求
都要携带该字段，转发服务会对此进行验证
3.9.3返回码
索引
值
说明
1
DHRC_NO_POWER
无登录该设备的权限
2
DHRC_NO_NTDC_TO_USE
无转发可用
3.10NCMC登录设备
3.10.1请求包
操作代码
EPSS_NCMC_LOGIN_DEV
方向
NCMC->NTDC
索引
名字
类型
长度
说明
1
Devid
int32
4
设备标识
2
Type
Byte
1
设备类型。
0：
大华设备；1：
海康设备
3
Addr
String
64
地址
4
devPort
Int32
2
设备端口
5
ipOrDomain
Byte
1
Addr字段存储的是IP还是domain
6
isDdns
Byte
1
是否用DDNS登录，如果是，addr字段存的是DDNS的地址
7
ddnsName
String
64
设备在DDNS上的名称
8
ddnsPort
Int32
4
DDNS端口
9
Token
Uint32
4
操作令牌，NTDC用于对CU关于该设备的操作进行验证
3.10.2应答包
操作代码
EPSS_NCMC_LOGIN_DEV
索引
名字
类型
长度
说明
1
Devid
int32
4
设备标识
2
Token
Uint32
4
操作令牌
3.10.3返回码
无特殊返回码
3.11CU向NTDC登录设备
3.11.1请求包
操作代码
EPSS_CU_LOGIN_DEV
方向
CU->NTDC
索引
名字
类型
长度
说明
升级会员 