DB65∕T 4359-2021 视频指挥接口规范(新疆维吾尔自治区).pdf

ICS 35.020 CCS L 70 日065新疆维吾尔自治区地方标准DB 65/T 4359-2021 视频指挥接口规范Video command interface specification 2021一06-02发布2021 - 09 -01实施新疆维吾尔自治区市场监督管理局发布DB 65/T 4359-2021 并负责按照接口协议将指令发送到视频指挥接口服务端。视频指挥接口服务端负责接收视频指挥接口客户端发送的视频会议调度请求，并向视频会议系统发起对应的业务请求。指挥调度系统4. 2 格式和参数r-皿皿-皿-皿-视频指挥接口(客户端视频指挥接口(服务端)图1视频指挥接口结构采用统一资源标识符CURI风格)对接口进行描述。其格式及参数说明如下:视频会议系统a) 格式http:/ip/api/Firmid/ Platformid /version/function/rc_id; b) 参数说明:1) ip:视频指挥接口服务端的IPV4地址:2) api:应用程序编程接曰:3) Firmid:设备供应商编码，数据类型整数型32位:4) Platformid:平台类型编码，数据类型整数型32位:5) version:接口版本号，数据类型字符串:6) function:功能单元集，分为系统功能集和控制功能集:7) rc_id:功能单元。5 接口描述5.1 语法规则接口采用SON作为接口参数的封装格式，语法规则如下:一一数组用方括号J表示:一一对象用大括号，表示:一一一名称/值对之间用自号.隔开:一一名称置于双引号中，值有字符串、数值、布尔值、null、对象和数组:一一一并列的数据之间用逗号C，)分隔。5.2 功能单元说明见表1。功能单元集system control 说明系统功能控制功能表1功能单元集功能单元Crc_id)login_interface channel r loginout_interface organze_meetng end_meeting 功能单元说明登陆接口通道保持接口退出登陆接口创建会议接口结束会议接口2 表1功能单元集(续)功能单元集control 5.3 接口定义语言描述5.3.1 登陆接口说明控制功能功能单元(rcid) login_interface。功能单元(rcid) rid terminal dispatch_terminal designate_spokesman del terminal 功能说明:用于视频指挥接口客户端登陆视频指挥接口服务端的安全认证。访问参数说明:loginname:str登陆用户名loginpwd:str密码返回参数说明:errcode:str 0二成功，1二失败access token:str服务端鉴权成功后分配的访问令牌errmsg:气tr错误消息5.3.2 通道保持接口功能单元(rcid) channel_ro DB 65/T 4359-2021 功能单元说明终端强拆接口终端入会接口设置发言人接口终端移除接口功能说明:用于视频指挥接口客户端与视频指挥接口服务端之间定时发送通道保持消息，服务端通过解析通道保持的请求消息确定客户端的运行状态，客户端通过解析通道保持的返回消息确定服务端的运行状态，消息发送时间间隔为300秒。访问参数说明:access token:str通过登陆接口返回的服务端访问令牌返回参数说明:errcode:str 0=成功，1二失败，errmsg:气tr错误消息5.3.3 退出登录接口功能单元(rcid) loginout_interface。功能说明:用于视频指挥接口客户端登陆退出。3 DB 65/T 4359-2021 访问参数说明:access token:str通过登陆接口返回的服务端访问令牌loginname:str登陆用户名返回参数说明:errcode:str 0=成功，1=失败access token:str服务端鉴权成功后分配的访问令牌errmsg:str错误消息5.3.4创建会议接口功能单元(rcid) organize_meetingo 功能说明:用于视频指挥接口客户端向视频指挥接口服务端发起创建会议请求。访问参数说明:access token:str通过登陆接口返回的服务端访问令牌meeting_name:str会议名称pri_id:int优先级编码，指挥调度系统优先级编码规范见附录A，tcode tab:int终端号码类别标签，0=终端ip，1二终端1D，chairman_terminal:str主席终端坤返回参数说明:errcode:str 0=成功，1二失败schedule1d:气tr会议号码errmsg:气tr错误消息5.3.5 结束会议接口功能单元(rcid) end_meeting。功能说明:用于视频指挥接口客户端向视频指挥接口服务端发起结束会议请求。访问参数说明:access token:str通过登陆接口返回的服务端访问令牌schedule1d:str会议号码返回参数说明:errcode:str 0=成功，1二失败errmsg:str错误消息4 DB 65/T 4359-2021 5.3.6 终端强拆接口功能单元(rcid) rid_terminalo 功能说明:用于视频指挥接口客户端发起对指定终端的强拆请求，使指定终端从当前会议中退出，进入空闲状态o访问参数说明:access token:str通过登陆接口返回的服务端访问令牌pri_id:int优先级编码，指挥调度系统优先级编码规范见附录A，tcode_tab:飞nt终端号码类别标签，。二终端ip，二终端四terminal id:气tr终端ip或四返回参数说明:errcode:str 0二成功，1二失败errmsg:str错误消息5.3.7 终端入会接口功能单元(rcid) dispatch_terminal。功能说明:用于视频指挥接口客户端发起对指定终端加入指定会议请求。访问参数说明:access token:str通过登陆接口返回的服务端访问令牌schedule1d:str会议号码tcode_tab:int终端号码类别标签，0=终端地，1二终端四terminal id:str终端ip或四返回参数说明:errcode:str 0=成功，1二失败schedule1d:str会议号码气terminal id:str终端ip或四errmsg:气tr错误消息5.3.8 设置发言人接口功能单元(rcid) designate_spokesmano 功能说明:用于视频指挥接口客户端发起对指定终端设置成为指定会议发言人的请求。访问参数说明:access token: str通过登陆接口返回的服务端访问令牌schedule1d:str会议号码tcode_tab:int终端号码类别标签，0二终端ip，1二终端1D，5 DB 65/T 4359-2021 terminal id:str终端ip或四返回参数说明:errcode:str 0二成功，1二失败scheduleld:str会议号码terminal id:str终端ip或四errmsg:气tr错误消息5.3.9 终端移除接口功能单元(rcid) del terminalo 功能说明:用于视频指挥接口客户端发起将指定终端从指定会议中移除的请求。访问参数说明:access token:str通过登陆接口返回的服务端访问令牌scheduleld:str会议号码tcode_tab:int终端号码类别标签，0工终端ip，1=终端四terminal id:str终端ip或四返回参数说明:errcode:str 0=成功，1二失败errmsg:str错误消息6 A. 1 优先级编码规范附录A(规范性指挥调度系统优先级编码规范DB 65/T 4359-2021 调度优先级按照自治区(兵团)、自治区各斤级单位、地州/市(师)、区县(团)、乡镇(连)、村的顺序设定调度优先级及优先级编码。自治区各地州/市(师)、区县(团)、乡镇(连)、村按照优先级编码规范对已建、待建视频会议系统(MCU)进行升级调整，完成各级视频会议系统(MCU)的强拆功能及调度优先级功能，保障上级调度的优先。各个层级的优先级编码见表A.1o表A.1优先级编码优先级顺序层级优先级编码最高优先级自治区(兵团)10 第二优先级自治区各厅级单位11 第二优先级地州/市(师)20 第四优先级区县(团)30 第五优先级乡镇(连)40 第六优先级村50 7