网易云信提供 RESTful 形式的服务端 API，通过发送 HTTPS 请求就可以获取 （GET），更新（PUT）, 创建 （POST），删除 （DELETE） 房间管理、房间踢人等相关数据或执行相关操作。
房间管理
| API |
方法 |
请求 URI |
| 创建房间 |
POST |
https://rtc.yunxinapi.com/v2/api/room |
| 查看房间信息 |
GET |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}https://rtc.yunxinapi.com/v3/api/rooms?cname={cname}
|
| 查看房间内成员信息 |
GET |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}/membershttps://rtc.yunxinapi.com/v3/api/rooms/members?cname={cname}
|
| 移除成员 |
POST |
https://rtc.yunxinapi.com/v2/api/kicklist/{cid}/members/{uid}https://rtc.yunxinapi.com/v3/api/kicklist/members?cname={cname}&uid={uid}
|
| 查看被移除成员列表 |
GET |
https://rtc.yunxinapi.com/v2/api/kicklist/{cid}https://rtc.yunxinapi.com/v3/api/kicklist?cname={cname}
|
| 撤销移除 |
DELETE |
https://rtc.yunxinapi.com/v2/api/kicklist/{cid}/members/{uid}https://rtc.yunxinapi.com/v3/api/kicklist/members?cname={cname}&uid={uid}
|
| 查询房间媒体流状态 |
GET |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}/streamshttps://rtc.yunxinapi.com/v3/api/rooms/streams?cname={cname}
|
| 设置房间成员封禁状态 |
POST |
https://rtc.yunxinapi.com/v2/api/right/changehttps://rtc.yunxinapi.com/v3/api/right/change?cname={cname}
|
| 删除房间 |
DELETE |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}https://rtc.yunxinapi.com/v3/api/rooms?cname={cname}
|
AI 服务
| API |
方法 |
请求 URI |
|
创建 RTC AI 任务
|
POST
|
https://rtc-ai.yunxinapi.com/v1/api/task/createhttps://rtc-ai.yunxinapi.com/ai/task/create
|
|
结束 RTC AI 任务
|
POST
|
https://rtc-ai.yunxinapi.com/v1/api/task/closehttps://rtc-ai.yunxinapi.com/ai/task/close
|
|
开启同声传译
|
POST
|
https://rtc-ai.yunxinapi.com/v1/api/si/starthttps://rtc-ai.yunxinapi.com/ai/si/start
|
|
关闭同声传译
|
POST
|
https://rtc-ai.yunxinapi.com/v1/api/si/stophttps://rtc-ai.yunxinapi.com/ai/si/stop
|
| 智能摘要 |
POST |
https://rtc-ai.yunxinapi.com/v1/api/task/create |
| 申请克隆音色 |
POST |
https://rtc-ai.yunxinapi.com/v1/api/tts/voice-id-apply |
| 查询可克隆音色 ID 数量 |
GET |
https://rtc-ai.yunxinapi.com/v1/api/tts/voice-id-apply |
| 克隆音色 |
POST |
https://rtc-ai.yunxinapi.com/v1/api/tts/voice-clone |
| 重新克隆音色 |
POST |
https://rtc-ai.yunxinapi.com/v1/api/tts/voice-reclone |
| 查询已克隆音色 |
GET |
https://rtc-ai.yunxinapi.com/v1/api/tts/voice |
| 删除克隆音色 |
DELETE |
https://rtc-ai.yunxinapi.com/v1/api/tts/voice |
安全通
| API |
方法 |
请求 URI |
| 创建安全通审核任务 |
POST |
https://rtc.yunxinapi.com/livewallsolution/submit |
| 查询审核视频截图 |
POST |
https://rtc.yunxinapi.com/livewallsolution/query/image |
| 查询审核音频断句 |
POST |
https://rtc.yunxinapi.com/livewallsolution/query/audio/task |
| 停止安全通审核任务 |
POST |
https://rtc.yunxinapi.com/livewallsolution/feedback |
云端播放
| API |
方法 |
请求 URI |
| 创建云端播放任务 |
POST |
https://rtc.yunxinapi.com/v2/api/task/create |
| 更新云端播放任务 |
POST |
https://rtc.yunxinapi.com/v2/api/task/updatehttps://rtc.yunxinapi.com/v3/api/task/update?cname={cname}
|
| 查询云端播放任务 |
POST |
https://rtc.yunxinapi.com/v2/api/task/listhttps://rtc.yunxinapi.com/v3/api/task/list?cname={cname}
|
| 暂停云端播放任务 |
POST |
https://rtc.yunxinapi.com/v2/api/task/pausehttps://rtc.yunxinapi.com/v3/api/task/pause?cname={cname}
|
| 恢复云端播放任务 |
POST |
https://rtc.yunxinapi.com/v2/api/task/resumehttps://rtc.yunxinapi.com/v3/api/task/resume?cname={cname}
|
| 销毁云端播放任务 |
POST |
https://rtc.yunxinapi.com/v2/api/task/closehttps://rtc.yunxinapi.com/v3/api/task/close?cname={cname}
|
云端录制
| API |
方法 |
请求 URI |
|
云端录制（旧版）
|
POST
|
https://rtc.yunxinapi.com/v2/api/record/{cid}https://rtc.yunxinapi.com/v3/api/record?cname={cname}
|
|
创建录制任务
|
POST
|
https://rtc.yunxinapi.com/v2/api/cloudrecord/submithttps://rtc.yunxinapi.com/v3/api/cloudrecord/submit?cname={cname}
|
|
更新录制布局
|
POST
|
https://rtc.yunxinapi.com/v2/api/cloudrecord/updatehttps://rtc.yunxinapi.com/v3/api/cloudrecord/update?cname={cname}
|
|
更新订阅列表
|
POST
|
https://rtc.yunxinapi.com/v2/api/cloudrecord/updateSubshttps://rtc.yunxinapi.com/v3/api/cloudrecord/updateSubs?cname={cname}
|
|
查询录制任务信息
|
POST
|
https://rtc.yunxinapi.com/v2/api/cloudrecord/taskshttps://rtc.yunxinapi.com/v3/api/cloudrecord/tasks?cname={cname}
|
| 查询云端录制文件信息 |
POST |
https://api.yunxinapi.com/nimserver/history/queryMediaFileByChannelId.action |
|
停止录制任务
|
POST
|
https://rtc.yunxinapi.com/v2/api/cloudrecord/stophttps://rtc.yunxinapi.com/v3/api/cloudrecord/stop?cname={cname}
|
旁路推流
| API |
方法 |
请求 URI |
| 创建旁路推流任务 |
POST |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}/taskhttps://rtc.yunxinapi.com/v3/api/rooms/task?cname={cname}
|
| 查询指定旁路推流任务 |
GET |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}/task/{taskId}https://rtc.yunxinapi.com/v3/api/rooms/task?cname={cname}&taskId={taskId}
|
| 查询所有旁路推流任务 |
GET |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}/taskshttps://rtc.yunxinapi.com/v3/api/rooms/tasks?cname={cname}
|
| 更新旁路推流任务 |
POST |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}/update/taskhttps://rtc.yunxinapi.com/v3/api/rooms/update/task?cname={cname}
|
| 停止旁路推流任务 |
DELETE |
https://rtc.yunxinapi.com/v2/api/rooms/{cid}/taskhttps://rtc.yunxinapi.com/v3/api/rooms/task?cname={cname}
|
