科达视讯平台推送API

V6.1.0.4.0.20201230

API_level:1

推送信息

推送通知信息

名称 会议信息
通道 /confs/{conf_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示有会议开启或会议变更的信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议结束

名称 级联信息
通道 /confs/{conf_id}/cascades

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示有会议级联的更新信息

名称 发言人
通道 /confs/{conf_id}/speaker

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有发言人的更新信息

名称 主席
通道 /confs/{conf_id}/chairman

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有主席的更新信息

名称 双流源
通道 /confs/{conf_id}/dualstream

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有双流源的更新信息

名称 会议轮询
通道 /confs/{conf_id}/poll

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有轮询的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str 表示会议中的轮询结束

名称 主席轮询
通道 /confs/{conf_id}/chairmanpoll

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有主席轮询的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str 表示会议中的主席轮询结束

名称 语音激励
通道 /confs/{conf_id}/vad

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有语音激励的更新信息

名称 混音
通道 /confs/{conf_id}/mixs/{mix_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
mix_id ([0-9]+) 混音id,默认为1

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有混音的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的混音关闭

名称 画面合成
通道 /confs/{conf_id}/vmps/{vmp_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
vmp_id ([0-9]+) 画面合成号，默认为1

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有画面合成的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的画面和合成关闭

名称 终端列表
通道 /confs/{conf_id}/cascades/{cascade_id}/mts/{mt_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
cascade_id ([0-9\.]+) 会议级联号，其中0代表本级会议
mt_id ([0-9]+) 终端号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有终端的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的终端被删除

名称 电视墙自主画面合成
通道 /confs/{conf_id}/hduvmps/{hdu_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
hdu_id ([0-9_]+） 电视墙通道号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有电视墙自主画面合成的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的电视墙自主画面合成关闭

名称 会议电视墙
通道 /confs/{conf_id}/hdus/{hdu_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
hdu_id ([0-9_]+) 电视墙通道号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有电视墙的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的电视墙关闭

名称 电视墙批量轮询
通道 /confs/{conf_id}/hdupoll

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有电视墙批量轮询的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的电视墙批量轮询停止

名称 录像
通道 /confs/{conf_id}/recorders/{rec_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
rec_id ([0-9]+) 录像号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有录像的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的录像关闭

名称 终端自主画面合成
通道 /confs/{conf_id}/mtvmps/{mt_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
mt_id ([0-9\.]+) 自主画面合成终端号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有终端自主画面合成的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的终端自主画面合成关闭

名称 终端单通道自主自主画面合成
通道 /confs/{conf_id}/mt_channel_vmps/{mt_id}/{mt_chn_idx}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
mt_id ([0-9\.]+) 单通道自主画面合成终端号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有终端单通道自主画面合成的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的终端单通道自主画面合成关闭

名称 终端选看
通道 /confs/{conf_id}/inspections/{mt_id}/{mode}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
mt_id ([0-9]+) 终端号
mode ([0-9]+) 选看模式 1-视频 2-音频

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有终端选看的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的终端选看关闭

名称 上传终端
通道 /confs/{conf_id}/upload

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有上传终端的更新信息

名称 上传终端轮询
通道 /confs/{conf_id}/uploadpoll

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有上传终端轮询的更新信息

删除方法示例

删除方法说明

参数名称 数据类型 说明
method str delete表示会议中的上传终端轮询停止

名称 监控
通道 /confs/{conf_id}/monitor/{dst_ip}/{dst_port}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
dst_id ([0-9.]+) 监控IP
dst_port ([0-9]+) 监控端口

更新方法示例

更新方法说明

参数名称 数据类型 说明
method str update表示会议中有监控的更新信息

名称 系统告警通知
通道 /confs/{conf_id}/alarm

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号

名称 开始混音失败通知
通道 /confs/{conf_id}/mixs/{mix_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
mix_id ([0-9]+) 混音id,默认为1

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号
mode int 混音模式, 1-讨论 2-定制混音

名称 添加终端失败通知
通道 /confs/{conf_id}/mts

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号
mt object 终端对象
    account str 终端E164号,IP或电话号码
    account_type int 终端类型，5-e164号码; 6-电话; 7-ip地址
occupy_confname str 占用该终端的会议名称，仅当错误号为21410时返回该值

名称 开启画面合成失败通知
通道 /confs/{conf_id}/vmps/{vmp_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
vmp_id ([0-9]+) 画面合成号，默认为1

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号

名称 HDU选看失败通知
通道 /confs/{conf_id}/hdus/{hdu_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
hdu_id ([0-9_]+） 电视墙通道号

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号
mode int 电视墙模式, 1-选看，2-四分屏(仅传统会议有效)，3-单通道轮询

名称 录像异常通知
通道 /confs/{conf_id}/recorders/{rec_id}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
rec_id ([0-9]+) 录像号

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号

名称 放像异常通知
通道 /confs/{conf_id}/playback

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号

名称 终端选看失败通知
通道 /confs/{conf_id}/inspections/{mt_id}/{mode}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
mt_id ([0-9]+) 选看目的终端号
mode ([0-9]+) 选看模式 1-视频 2-音频

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号
src object 选看源
    type int 选看源类型: 1-终端 2-画面合成
    mt_id str 源终端号

名称 开启监控失败通知
通道 /confs/{conf_id}/monitor/{dst_ip}/{dst_port}

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号
dst_id ([0-9.]+) 监控IP
dst_port ([0-9]+) 监控端口

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
error_code int 表示返回的错误号
src object 监控源
    type int 监控源类型: 1-终端, 2-画面合成, 3-混音
    mt_id str 监控终端id, type为终端时必填

名称 终端申请主席通知
通道 /confs/{conf_id}/applychairman

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
mt_id str 申请终端id

名称 终端申请发言人通知
通道 /confs/{conf_id}/applyspeaker

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
mt_id str 申请终端id

名称 终端申请加入混音通知
通道 /confs/{conf_id}/applymix

参数说明

参数名称 数据格式 说明
conf_id ([0-9]+) 会议号

消息示例

更新方法说明

参数名称 数据类型 说明
method str notify表示系统通知
mt_id str 申请终端id