简要描述:
- 获取直播室信息
请求URL:
- /zhibo/rooms/{roomId}/prdline
HTTP请求方法:
- GET
请求头:
NA
URL请求参数:
| 名称 | 类型 | 是否必须 | 描述 |
|---|---|---|---|
| roomId | String | 是 | 直播间主键pid |
请求体参数:
NA
返回参数说明:
返回200的成功的响应体:
| 参数名 | 类型 | 说明 |
|---|---|---|
| pid | String | 直播房间pid |
| roomCode | String | 直播房间code编号 |
| sessionId | String | 直播当前活动场次pid,当直播关闭后为空 |
| chatroomId | String | 直播当前活动聊天室id,当直播关闭后为空 |
| hostId | String | 直播当前活动主播id,当直播关闭后为空 |
| orgId | String | 直接所属机构appKey |
| roomName | String | 直播间名称 |
| sessionName | String | 直播场次名称 |
| sourceId | int | 直播室所属source |
| description | String | 直播间描述 |
| hostPasswordHash | Object | 直播间主播密码加密字段 |
| assistantPasswordHash | Object | 直播间助理密码加密字段 |
| playPasswordHash | Object | 直播间观看密码加密字段 |
| resolutionLow | Integer | 流畅(0=未选中,1=选中) |
| resolutionMiddle | Integer | 标清(0=未选中,1=选中) |
| resolutionHigh | Integer | 高清(0=未选中,1=选中) |
示例:
请求:
GET https://api-zhibo.yxt.com/v1/zhibo/rooms/fe04ddc7-3628-4740-8db7-a504f3719bf3/prdline
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
{"pid": "fe04ddc7-3628-4740-8db7-a504f3719bf3","description": "汇知直播创建测试desc","orgId": "6d95b35f095f4285b7eebb326eaa221d","sessionId": null,"chatroomId": null,"hostId": null,"roomCode": "5mjdFgoMAc6","roomName": "汇知直播创建测试","sessionName": null,"sourceId": 90,"hostPasswordHash": "49ba59abbe56e057","assistantPasswordHash": null,"playPasswordHash": null,"resolutionLow": 1,"resolutionMiddle": 1,"resolutionHigh": 1}
错误时返回:
状态值: HTTP/1.1 400 Bad Request
{"error": {"key": "global.noprivilege","message": "No privilege."}}
错误代码列表:
格式: key=状态码;message
apis.auth.client.status.invalid=400;Client Org status is invalid.
apis.zhibo.orgadmin.validation.service.expired=400;Service is not active.