网易云信音/视频通话房间管理相关RESTful API接口文档

RESTful API接口功能说明

本文档主要说明网易云信音/视频服务器提供给开发者服务端房间管理相关RESTful API接口。需要注意的是，每个RESTful API接口都有频控限制，每位用户每秒钟可调用不超过1200次。

RESTful API接口详细说明

注：以下接口中的{id}为通话id，关于通话id的说明，请参阅音视频通话ID。此外通过eventType=5和6的消息抄送的也可以获取到通话id。

1.查询某个房间状态信息

HTTP请求方式:

HTTP 响应Code：

    200: 成功
    400：请求无效
    401：鉴权失败
    404：请求不存在
    429：请求个数超过频控限制
    500：服务器内部错误

HTTP响应内容:

Content-Type: application/json;charset=utf-8

{
    "cid":6207760637435905,             //房间ID【int64】
    "cname":"netease",                  //房间名称
    "accid": "193992653091841",         //房间创建者ID
    "total":3,                          //房间内活跃用户总数
    "mode":1,                           //房间模式【1：双人、2：多人】
    "stats":1,                          //房间状态【1：初始状态，2：进行中，3：正常结束，4：异常结束】
    "createtime":1513145726,            //房间创建时间【int64】
    "destroytime":1513145926            //房间结束时间【int64】
}

2.查询某个房间成员信息

HTTP请求方式:

HTTP响应Code：

    200: 成功
    400：请求无效
    401：鉴权失败
    404：请求不存在
    429：请求个数超过频控限制
    500：服务器内部错误

HTTP响应内容：

Content-Type: application/json;charset=utf-8

{
    "cname" : "netease",                //房间名称
    "cid" : 6207760637435905,           //房间ID【int64】
    "total" : 3,                        //房间活跃人数
    "members":[                         //房间活跃成员信息
        {
            "accid":"193992653091841",  //成员ID
            "starttime":1513145926,     //成员加入时间【int64】
            "role" : 101                //成员角色【101:点对点用户、201:会议用户、301:互动主播、302:普通观众、99:其它】
        }
    ]
}

3.删除某个房间

HTTP请求方式：

HTTP响应Code：

    200: 成功
    400：请求无效
    401：鉴权失败
    404：请求不存在
    429：请求个数超过频控限制
    500：服务器内部错误

HTTP响应内容：

    无 

4.管理员踢出房间内的指定用户并禁止后续加入

HTTP请求方式：

HTTP响应Code：

    200: 成功
    400：请求无效
    401：鉴权失败
    404：cid对应房间或accid对应用户不存在
    429：请求个数超过频控限制
    500：服务器内部错误

HTTP响应内容：

    无

5.管理员获取房间中踢出的人员列表

HTTP请求方式：

HTTP响应Code：

    200: 成功
    400：请求无效
    401：鉴权失败
    404：cid对应房间不存在
    429：请求个数超过频控限制
    500：服务器内部错误

HTTP响应内容：

Content-Type: application/json;charset=utf-8

{
    "accids":[                         //被踢出成员的成员ID列表
        193992653091841,
        193992653091842
    ]
}

6.管理员撤销踢人操作

HTTP请求方式：

HTTP响应Code：

    200: 成功
    400：请求无效
    401：鉴权失败
    404：cid对应房间或accid对应用户不存在
    429：请求个数超过频控限制
    500：服务器内部错误

HTTP响应内容：

    无

7.管理员设置频道录制

HTTP请求方式：

HTTP请求体

{   
    "a_record": true,                  //必填 bool，设置房间音频录制开关
    "v_record": true,                  //必填 bool，设置房间视频录制开关
    "type" : 0                         //选填 uint，设置房间所有用户的录制类型：0-混录单人 1-只混录 2-只单人
}

HTTP响应Code：

    200: 成功
    400：请求无效
    401：鉴权失败
    404：cid对应房间不存在
    429：请求个数超过频控限制
    500：服务器内部错误

HTTP响应内容：

    无

8.创建房间

参照互动直播服务器API文档。

RESTful API接口调用例子

1.获取房间信息示例代码【Go语言】：

    //初始化HTTP Client
    tr := http.Transport{
        TLSClientConfig : &tls.Config{InsecureSkipVerify: true},
    }
    client := http.Client{
        Timeout: 5 * time.Second,        //HTTP客户端超时时间
        Transport: &tr,
    }

    //id: 房间号
    var id int64 = 6217678937673432431
    url := fmt.Sprintf("https://roomserver-dev.netease.im/v1/api/rooms/%d", id)
    req, err := http.NewRequest(http.MethodGet, url, nil)
    if err != nil {
        fmt.Println("http newrequest error:", err)
        return
    }

    //开发者DemoKey
    var (
        AppkeyDemo     = "45c6af309b18a84451215d0bddr6e"
        SecretKeyDemo  = "37db6b60"
    )

    //云信Server API认证头信息, nonce, curtime, checksum生成详见:服务器API文档
    nonce, curtime, checksum := auth.GetLiveCheckSum(SecretKeyDemo)
    req.Header.Set("CheckSum", checksum)
    req.Header.Set("AppKey", AppkeyDemo)
    req.Header.Set("CurTime", curtime)
    req.Header.Set("Nonce", nonce)

    //HTTP请求
    resp, err := client.Do(req)
    if err != nil {
        fmt.Println("client do error:", err)
        return
    }
    defer resp.Body.Close()

    //HTTP响应
    body, err := ioutil.ReadAll(resp.Body);
    if err != nil{
        fmt.Println("status code:", resp.StatusCode, ", error:", err)
        return
    }

    //HTTP非200错误
    if resp.StatusCode != http.StatusOK {
        fmt.Println("status code:", resp.StatusCode, ", body:", string(body))
        return
    }

    //房间信息响应描述
    type GetRoomRes struct{
        Cid         int64  `json:"cid"`
        Cname       string `json:"cname"`
        Accid       string `json:"accid"`
        Total       int    `json:"total"`
        Mode        int    `json:"mode"`
        Stats       int    `json:"stats"`
        CreateTime  int64  `json:"createtime"`
        DestroyTime int64  `json:"destroytime"`
    }

    //解析房间信息
    var res GetRoomRes
    if err = json.Unmarshal(body, &res); err == nil {
        fmt.Printf("res = %+v", res)
    } 

本篇文档内容是否对您有帮助？

有帮助 我要吐槽

如果遇到产品相关问题，您可 提交工单 或 在线客服 寻求帮助。

此文档对你是否有帮助

×

有帮助 我要吐槽

×

反馈成功

非常感谢您的反馈，我们会继续努力做得更好。

确定