科达视讯平台实时音视频API

1. 获取房间列表
2. 创建房间
3. 删除房间
4. 添加房间成员
5. 获取房间成员列表信息
6. 踢出房间成员
7. 获取实时音视频版本信息

名称	获取房间列表
URI	/api/v1/krtc/rooms
方法	GET
说明	获取房间列表
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token，放url中
start	int	获取的视频房间列表的起始房间位置, 0表示第一个房间, 默认为0
count	int	获取的视频房间的个数, 即包括start在内的后count个房间, 0代表获取所有房间, 默认为10

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
total	int	总房间数
confs	array	房间列表
room_name	str	房间名称 最大字符长度：64个字节
user_domain_name	str	房间所属的的用户域名称
room_id	str	正在使用的房间号 最大字符长度：48个字节
room_type	int	房间类型 0-传统混合； 1-端口混合； 2-SFU纯转发房间；
auto_end	int	房间中无成员时，是否自动关闭房间，默认为1，永久房间时默认为0 0-否； 1-是；
start_time	str	房间开始时间（ISO8601:2000格式表示）
meeting_id	str	所有房间唯一ID号，查询历史会议记录使用
duration	int	房间时长 ，单位分钟，0为永久房间,默认240
bitrate	int	房间码率
creator	str	房间创建人：128个字节
resolution	int	房间主视频分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	创建房间
URI	/api/v1/krtc/rooms
方法	POST
说明	创建房间
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token，放url中
		请求内容，以JSON形式放body中发送

params示例

params说明

参数名称	数据类型	说明
room_name*	str	房间名称 最大字符长度：64个字节
duration	int	房间时长 ，单位分钟，0为永久房间,默认240
bitrate*	int	房间码率,例如：1024，2048，4096
auto_end	int	房间中无成员时，是否自动关闭房间，默认为1，永久房间时默认为0 0-否； 1-是；
room_type	int	会议类型，默认2 0-传统混合； 1-端口混合； 2-SFU纯转发会议；
resolution*	int	房间分辨率 1-QCIF; 2-CIF; 3-4CIF; 12-720P; 13-1080P; 14-WCIF; 15-W4CIF; 16-4k;
format*	int	主视频格式 1-MPEG; 2-H.261; 3-H.263; 4-H.264_HP; 5-H.264_BP; 6-H.265; 7-H.263+;
frame*	int	帧率,例如：30

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
room_id	str	正在使用的房间唯一号码
meeting_id	str	所有会议唯一ID号，查询历史会议记录使用
description	str	结果描述

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	删除房间
URI	/api/v1/krtc/rooms/{room_id}
方法	DELETE
说明	删除房间
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token，放url中

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	添加房间成员
URI	/api/v1/krtc/rooms/{room_id}/users
方法	POST
说明	添加房间成员
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token，放url中
		请求内容，以JSON形式放body中发送

params示例

params说明

参数名称	数据类型	说明
user_id*	str	成员ID,成员的唯一标识
bitrate	int	终端呼叫码率,例如：1024，2048，4096

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	获取房间成员列表信息
URI	/api/v1/krtc/rooms/{room_id}/users
方法	GET
说明	获取房间成员列表信息
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token，放url中

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
users	array	房间成员数组
user_id	str	成员ID,成员的唯一标识
user_alias	str	成员别名 最大字符长度：128个字节
user_ip	str	成员IP
online	int	是否在线 0-否； 1-是；
dual	int	成员是否在发送共享桌面 0-否； 1-是；
mute	int	成员是否哑音 0-否； 1-是；
silence	int	成员是否静音 0-否； 1-是；

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	踢出房间成员
URI	/api/v1/krtc/rooms/{room_id}/users/{user_id}
方法	DELETE
说明	踢出房间成员
最低支持版本	3

参数说明

参数名称	数据类型	说明
account_token*	str	登陆token，放url中

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号
description	str	结果描述

名称	获取实时音视频版本信息
URI	/api/krtc/version
方法	GET
说明	获取实时音视频版本信息
最低支持版本	3

成功回复示例

成功回复说明

参数名称	数据类型	说明
success	int	是否成功
version	str	版本信息
api_level	int	实时音视频版本标识，请与实时音视频说明文档中的各个接口的最低支持版本号作对比，若小于最低支持版本号，则该接口不支持当前版本的API调用

失败回复示例

失败回复说明

参数名称	数据类型	说明
success	int	是否成功
error_code	int	失败时的错误号