产品文档

视音频通信

Real-Time-Communication

简介

视音频通信产品相关接口

版本

v1

API

接口名称 请求方式 功能描述
createToken POST 生成token-用户加入房间时携带token校验通过后方能加入
describeApp GET 查询应用信息:
describeAppKey GET 查询应用appKey
describeApps GET 查询用户应用列表信息
describeRegisterUser GET 查询注册用户
describeRegisterUsers GET 查询注册用户列表
允许通过条件过滤查询,支持的过滤字段如下:
- startTime[eq] 用户注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效
- endTime[eq] 用户注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效
describeRoomUsers GET 查询房间内人员列表
允许通过条件过滤查询,支持的过滤字段如下:
- status[eq] 在线状态 1-在线 2-离线
- startTime[eq] 用户加入时间段开始时间-UTC时间 startTime,endTime同时有值时生效
- endTime[eq] 用户加入时间段结束时间-UTC时间 startTime,endTime同时有值时生效
describeRoomUsersNum GET 统计房间内人数
describeUserRoom GET 查询注册房间号
describeUserRooms GET 查询注册房间号列表
允许通过条件过滤查询,支持的过滤字段如下:
- startTime[eq] 房间注册时间段开始时间-UTC时间 startTime,endTime同时有值时生效
- endTime[eq] 房间注册时间段结束时间-UTC时间 startTime,endTime同时有值时生效
postMessageToUser POST 发送自定义信令给房间内的人员
postMessageToUserRoom POST 发送自定义信令给房间
registerUser POST 注册用户-将业务接入方用户体系的userId注册为jrtc系统内可识别和流转的用户id
registerUserRoom POST 注册用户房间号-将业务接入方定义的userRoomId注册为jrtc系统内可识别和流转的房间号
removeAllUsersByUserRoomId POST 移除房间内所有人员
removeUserByUserRoomId POST 移除房间内人员
updateUserRoom PUT 修改房间
更新时间:2021-08-02 18:28:13
文档反馈 docs feedback