临境直播开发者接入指南

简要描述：

获取直播室信息

请求URL:

/zhibo/open/rooms

HTTP请求方法：

请求头：

URL请求参数:

请求体参数:

返回参数说明:

返回200的成功的响应体:

参数名	类型	说明
datas[].pid	String	直播间表主键
datas[].orgId	String	机构uuid
datas[].sourceId	String	产品线标识(10:金牌团队, 20:机构网校, 30:咖场, 40:商城, 50:企业大学, 90:默认产线)
datas[].roomName	String	直播室名称
datas[].roomCode	String	直播室code
datas[].description	String	直播室描述
datas[].allowAnonym	int	是否允许匿名观看(0-不允许,1-允许)
datas[].avatarStream	String	视频流id
datas[].status	int	直播间状态(0-禁用,1-启用)
datas[].type	int	直播间类型(1-默认,其它-待定)
datas[].createTime	String	创建时间
datas[].sessions[].sessionStartTime	String	直播场次开始时间
datas[].sessions[].sessionEndTime	String	直播场次结束时间
datas[].sessions[].hostName	tring	直播场次主讲人名称
datas[].sessions[].hostAvatarUrl	String	直播场次主讲人头像
datas[].sessions[].sessionName	String	直播场次名称
datas[].sessions[].sessionDesc	String	直播场次简介
datas[].sessions[].pid	String	直播场次主键pid
datas[].sessions[].deletedFlag	int	直播场次删除标记（0=未删除，1=删除）
paging.limit	int	每页记录数
paging.offset	int	上一页最后一条记录号, offset必须是limit的倍数, 第一页为0. 当前页码可以通过offset/limit + 1来获得.
paging.pages	int	列表总页数
paging.count	int	列表总记录数

示例:

请求:
GET https://api-zhibo.yxt.com/v1/zhibo/open/rooms
Content-Type: application/json;charset=UTF-8
appkey: xxxxxxxxxxxxxxxxxxxxx
nonce: xxxx
timestamp: xxxxxxxxxx
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
source: xxxx

请求体:
NA

正确时返回:
状态值: HTTP/1.1 200 OK.
Content-Type: application/json;charset=UTF-8

{
    "datas":[
        {
            "pid":"22a2adf5-e850-4237-ad72-fadd85135b6f",
            "orgId":"139db85631924a70b66fc6f8c6a9562a",
            "sourceId":90,
            "roomName":"测试直播室名称",
            "roomCode":"20191029222",
            "description":"",
            "allowAnonym":1,
            "avatarStream":"cc7f142bf41247eb9879c9fc8d03e9f0",
            "hostPassword":"123456",
            "hostPasswordHash":null,
            "assistantPassword":"",
            "assistantPasswordHash":null,
            "playPassword":"",
            "playPasswordHash":null,
            "status":1,
            "type":1,
            "createTime":"2019-10-29 23:18:34.0",
            "resolutionLow":1,
            "resolutionMiddle":1,
            "resolutionHigh":0,
            "roomCoverUrl":"",
            "withSession":1,
            "roomsRelated":null,
            "sessions":[
                {
                    "sessionStartTime":"2019-10-29 23:09:00.0",
                    "sessionEndTime":"2019-11-28 00:00:00.0",
                    "sessionStartTimeTs":0,
                    "sessionEndTimeTs":0,
                    "sessionName":"测试老包推流123",
                    "hostName":null,
                    "hostAvatarUrl":null,
                    "sessionDesc":null,
                    "basePlayCount":0,
                    "pid":"5e0b6d6b-db9e-448a-9364-560072635a48",
                    "deletedFlag":0,
                    "watchCode":null,
                    "sessionCode":"13083105762"
                }
            ],
            "ad":null,
            "enableCollectInfo":0,
            "enableWhitelist":0,
            "sessionCode":"",
            "attendeeWhitelist":[
            ],
            "highSpeed":0
        }
    ],
    "paging":{
        "limit":1,
        "offset":0,
        "pages":3,
        "count":55
    }
}

错误时返回:

状态值: HTTP/1.1 400 Bad Request

{
  "error": {
    "key": "global.noprivilege",
    "message": "No privilege."
  }
}

错误代码列表:

格式: key=状态码;message
apis.zhiboadmin.validation.orgId.invalid=400;Invalid orgId.
apis.auth.client.status.invalid=400;Client Org status is invalid.
apis.zhibo.orgadmin.validation.service.expired=400;Service is not active.

获取直播室列表