CloudHub 文档中心
下载中心 文档中心

RTC 音视频互动


RestAPI

ChannelAPI

频道

close_channel

关闭频道

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/close_channel

参数

参数说明类型长度可选默认值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
channel频道号String32必填

返回值

正确返回

{
  "result": "0",
  "msg": "返回描述"
}

信令

custom_signal_sending

自定义信令发送

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/custom_signal_sending

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则生成
channel频道号String必填
message_name消息名称String必填只支持 pubMsg 和 delMsg
signaling_name信令名称String必填发送的 pubMsg 和 delMsg 信令名称保持一致
signaling_id信令idString必填发送的 pubMsg 和 delMsg 信令 id 保持一致
data频道内组装数据Array,String选填传值数组或者 json 字符串,频道内所需组装数据, data 传值如下方案例 , 数组例 : data[key1]=value1, data[key2]=value2, json字符串例: {“key1”:“value1”,“key2”:“value2”}
is_save信令状态Int1选填0是否保存此条信令 : 0 不保存(默认); 1保存, 只有保存的 pubMsg 消息频道内才能收到 delMsg 消息;
send_type发送类型String选填__all__all : 发送信息给频道中的所有人(默认), __allExceptSender : 发送信息给除自己以外的频道中所有人, __none : 只发送信息到信令服务器不发给任何人, ***** : 某用户ID。只发送信息给此用户

返回值

正确返回

{
    "result":"0",
    "msg":"返回描述"
}

用户

user_publish_subscribe

禁止用户/允许用户发布(订阅)

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/user_publish_subscribe

参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
channel频道号String32必填
user_id用户 idString32必填
type类型Int1选填11 : 发布(默认); 2 : 订阅;
state状态Int1选填10 : 禁止; 1 : 允许(默认);

返回值

正确返回

{
  "result": "0",
  "msg": "返回描述"
}

user_off_line

频道中踢出指定用户

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/user_off_line

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
channel频道号String32必填
user_id用户 idString32必填

返回值

正确返回

{
    "result":"0",
    "msg":"返回描述"
}

online_users

获取在线用户

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/online_users

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
channel频道号String32必填
page页码Int2选填1例 : 1,2,3 …..
page_size每页条数Int2选填20默认 20,最大不超过 100

返回值

正确返回

{
  "result": 0,
  "data": [
    {
      "user_id": "733be467-007d-4830-6b60-4eb73fa10dda",
      "area": "中国.北京.北京",
      "operator": "电信",
      "ip": "114.112.179.70",
      "os_version": "Win10",
      "ts": 1610001163261,
      "media_line": "cna"
    }
  ],
  "msg": "success"
}

返回字段说明

字段说明
result返回状态码
data返回内容
user_id用户id
area用户区域
operator运营商
ip用户出口ip
os_version操作平台
ts进入时间,毫秒时间戳
media_line媒体线路
msg说明信息

create_blacklist

添加进通道黑名单

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/create_blacklist

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
scope黑名单范围Int1必填11: 企业, 2: 通道
channel_id通道号String20选填scope = 2 时必填
astrict_type限制类型Int1必填0: ip, 1: userid, 2: 昵称
astrict_content限制类型内容String50必填对应 ip/userid/昵称
astrict_aging限制时效Int1必填0: 5分钟, 1: 30分钟, 2: 当天, 3: 永久

返回值

{
  "result": 0
}

blacklist

获取进通道黑名单

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/blacklist

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
page页码Int选填1默认从 1 开始

返回值

{
    "result":0,
    "list":[
        {
            "id":"黑名单 id",
            "scope":"黑名单范围 1: 企业, 2: 通道",
            "channel":"黑名单通道号 指定通道",
            "astrict_type":"限制类型 0: ip, 1: userid, 2: 昵称",
            "astrict_content":"限制类型对应内容 ",
            "astrict_aging":"限制时效 0: 5分钟, 1: 半小时, 2: 当天, 3: 永久",
            "add_time":"添加时间",
            "effective_time":"有效时间根据时效和添加时间计算得来"
        }
    ],
    "page":1,
    "pagenumber":20
}

delete_blacklist

删除进通道黑名单

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/delete_blacklist

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
id黑名单 IDInt必填1

返回值

{
  "result": 0
}

状态码参考

状态码说明
0成功
1暂无数据
53101saas企业不能调用,或者通道名称不能为空
53001开始时间和结束时间必传
53002时间格式异常,或开始时间大于结束时间,结束时间大于当前时间

文件

upload_file

上传文件

接口地址

https://api.cloudhub.vip/ChannelAPI/upload_file

本接口不用添加 token 公共参数,可直接使用 post 提交(文件预览域名:https://rddoccdnws.roadofcloud.net);

动态 ppt : 参数设置是 conversion =2 ,dynamicppt =1; 普通文档 : 参数设置是 conversion =1 ,dynamicppt =0;

要求上传类型 type=“file” 文件名为 filedata;

接口参数

参数说明类型长度可选缺省值备注
key企业 AppIDString32必填企业管理后台查看 AppID
conversion是否转换Int1必填11 : 转换(默认); 2 : 动态 ppt 转换; 3 : h5 文件; 4 : 媒体文件;
isopen是否是公开文档Int1必填0: 非公开文档 1:表示可关联文档
dynamicppt是否是动态pptInt1选填00: 非动态 ppt; 1: 动态 ppt; 上传动态 ppt 时需设置;
isconversion文件是否转高清Int1选填20 : 不转; 1 : 转; 2 : 按企业配置项转换(默认);
isvideoconversion文件视频是否转换高清Int1选填20 : 不转; 1 : 转; 2 : 按企业配置项转换(默认);
isvideoalone媒体文件是否转高清Int1选填20 : 不转; 1 : 转; 2 : 按企业配置项转换(默认);

返回值

正确返回

{
  "result": 0,
  "swfpath": "文件相对路径",
  "pagenum": "文件页数",
  "fileid": "文件id",
  "downloadpath": "文件下载地址(暂不支持下载)",
  "size": "文件大小",
  "status": "转换状态:0排队中,1成功,2转换失败,3转换中",
  "filename": "上传文件名称",
  "dynamicppt": "是否是动态 ppt,0: 非动态 ppt, 1: 动态 ppt",
  "fileprop": "0:默认,2:动态 ppt,3: h5 文件",
  "file_address": "文件拼接访问地址"
}

返回字段说明

字段说明
result返回状态码
swfpath文件相对地址
pagenum文件页数
fileid文件 id
downloadpath文件下载地址(暂时不支持下载)
size文件大小
filename文件名称
dynamicppt动态非动态文件状态
fileprop区分已上传的动态文件或者 H5 文件类型
file_address文件访问地址

返回状态码说明

状态码说明
0表示成功
3云存储失败
-1表示调用失败
-2文件上传失败
-3文件移动失败
-4非法文件类型
-5上传的文件后缀不符合标准
-6文档不能指定非公开
-10上传文件大于 100M 或文件页数超限

bind_file

频道关联文件

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/bind_file

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
channel频道号String必填
channel_type频道类型Int2选填21 : 为交互; 2 : 直播
file_id缺省显示文件 idInt选填指定缺省显示文件的 id, 如果以前指定过, 那么会重新指定为这个 fileid
fileid_arr文件 id 组Array必填文件id数组 例 : fileidarr[0]=, fileidarr[1]=, ……
sort_arr文件 id 对应排序数组Array选填排序值和文件 id 数组对应, 例 : sortarr[0]=, sortarr[1]=, ……

返回值

正确返回

{
    "result":"0",
    "msg":"返回描述"
}

unbind_file

频道取消关联文件

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/unbind_file

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
channel频道号String必填频道号
fileid_arr文件 id 组Array必填文件 id 数组 例 : fileidarr[0]=, fileidarr[1]=, ……

返回值

正确返回

{
    "result":"0",
    "msg":"返回描述"
}

delete_file

删除文件

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/delete_file

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
fileidarr文件 id 组Array必填文件 id 数组 例 : fileidarr[0]=, fileidarr[1]=, ……
参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
fileid_arr文件 id 组Array必填文件 id 数组 例 : fileidarr[0]=, fileidarr[1]=, ……

返回值

正确返回

{
    "result":"0",
    "msg":"返回描述"
}

录制

get_channel_record_list

获取常规录制件

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/get_channel_record_list

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
channelname通道名称String必填通道名称
starttime录制开始时间Int10选填时间戳(秒) 10 位数字
endtime录制结束时间Int10选填时间戳(秒) 10 位数字
page页码Int选填1默认从 1 开始

返回值

正确返回

{
    "result": "返回状态码",
    "data": [
          {
            "recordid": "录制件 id",
            "recordtitle": "录制件名称",
            "starttime": "录制开始时间",
            "duration":"录制时长",
            "list": [
                       "常规录制件里的具体文件列表"
            ],
            "ossBucketUrl": "常规录制件对应域名"
          }
    ]
}

返回状态码说明

状态码说明
0表示成功
1暂无数据
53101saas 企业不能调用,或者通道名称不能为空
53002时间格式异常,或开始时间大于结束时间,结束时间大于当前时间

delete_channel_record

删除常规录制件

接口地址

https://api.cloudhub.vip/ChannelAPI/v3/delete_channel_record

接口参数

参数说明类型长度可选缺省值备注
app_id企业 AppIDString32必填企业管理后台查看 AppID
token接口参数签名String32必填结合请求签名规则 生成
channelname通道名称String必填通道名称
starttime录制开始时间Int10必填时间戳(秒) 10 位数字
endtime录制结束时间Int10必填时间戳(秒) 10 位数字
page页码Int选填1默认从 1 开始

返回值

正确返回

{
    "result": "返回状态码"
}

返回状态码说明

状态码说明
0表示成功
1暂无数据
53101saas企业不能调用,或者通道名称不能为空
53001开始时间和结束时间必传
53002时间格式异常,或开始时间大于结束时间,结束时间大于当前时间

状态码参考

状态码说明
0成功
1执行成功,没有匹配数据
-1房间未在线
3001服务器过期
3002公司已经冻结
3003频道已删除或过期
4001该公司不存在
4007通道不存在
4105没有符合的数据
4200文件不存在
4302参数格式不正确
5106表示黑名单不存在或已被删除
5107表示id不能为空,且得为int类型参数
5108黑名单范围不能为空,且参数必须在文档指定范围
5112限制类型不能为空,且参数必须在文档指定范围
5113限制类型内容不能为空
5114限制类型时效不能为空,且参数必须在文档指定范围
5115通道名称不能为空
10021频道需要至少一个人存在
47001app_id 参数不存在
47002token 不存在
47003token 验证不通过
47004企业没有生成验证密钥或者企业app_id传参错误
48005Paas 企业不能执行该操作
48001请检查传参是否正确
48002频道不存在
48003用户不存在或者已经离开频道