临境直播开发者接入指南

简要描述：

修改直播室信息

请求URL:

不含场次的更新

/zhibo/rooms/{roomId}

含场次的更新, 有返回结果

/zhibo/rooms/{roomId}/withsession

HTTP请求方法：

请求头：

URL请求参数:

名称	类型	是否必须	描述
roomId	String	是	直播间主键pid

请求体参数:

不含场次的：

参数名	是否必须	类型	输入校验	说明
roomName	是	String	最大长度100	直播间房间名称
roomCode	否	String	长度11	直播间ID/Code, 传值会验证长度和是否为字母或数字
description	否	String	最大长度500	直播间房间描述
hostPassword	否	String	最大长度32	设置直播主播密码
assistantPassword	否	String	最大长度32	设置直播助理密码
playPassword	否	String	最大长度32	设置直播观看密码
roomCoverUrl	否	String	最大长度500	直播室封面图片Url

含场次的：

参数名	是否必须	类型	输入校验	说明
roomName	是	String	最大长度100	直播间房间名称
roomCode	否	String	长度11	直播间ID/Code, 不传值时自动生成，传值会验证长度和是否为字母或数字
description	否	String	最大长度500	直播间房间描述
hostPassword	否	String	最大长度32	设置直播主播密码
assistantPassword	否	String	最大长度32	设置直播助理密码
playPassword	否	String	最大长度32	设置直播观看密码
roomCoverUrl	否	String	最大长度500	直播室封面图片Url
sessions[].sessionStartTime	否, 若session不为空，则此字段必须	String	日期格式yyyy-MM-dd HH:mm:ss	直播场次开始时间
sessions[].sessionEndTime	否, 若session不为空，则此字段必须	String	日期格式yyyy-MM-dd HH:mm:ss	直播场次结束时间
sessions[].hostName	否	String	50	直播场次主讲人名称
sessions[].hostAvatarUrl	否	String	500	直播场次主讲人头像
sessions[].sessionName	否, 若session不为空，则此字段必须	String	100	直播场次名称
sessions[].sessionDesc	否	String	500	直播场次简介
sessions[].pid	否	String	36	直播场次主键pid
sessions[].deletedFlag	否	int	500	直播场次删除标记（0=未删除，1=删除）
ad.adImgUrl	否, 若ad不为空，则此字段必须	String	500	图链广告图片Url
ad.adLink	否	String	500	广告链接
ad.enableAd	否	int	1	开启直播图链广告广告类型(1=直播间图链广告)
ad.adLocation	否	int	1	广告显示位置(1=左上角,2=右下角,3=左下角,4=右上角)

返回参数说明:

返回204的没有响应体的响应值

示例:

请求:
PUT https://api-zhibo.yxt.com/v1/zhibo/rooms/fe04ddc7-3628-4740-8db7-a504f3719bf3
Content-Type: application/json;charset=UTF-8
appkey: xxxxxxxxxxxxxxxxxxxxx
nonce: xxxx
timestamp: xxxxxxxxxx
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
source: xxxx

请求体:
{
“roomName”: “直播创建测试”,
“description”: “直播创建测试desc”,
“hostPassword”: “123456”
}

正确时返回:
不含场次的更新：
状态值: HTTP/1.1 204 No Content.
Content-Type: application/json;charset=UTF-8

含场次的更新：
HTTP/1.1 200 OK.
Content-Type:application/json

错误时返回:

状态值: 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.
apis.zhibo.room.validation.roomId.length=400;length of roomId is 11.
apis.zhibo.room.validation.roomId.invalid=400;roomId should be number or charactor.
apis.zhibo.room.validation.roomId.existed=400;roomId is already existed.
apis.zhibo.error.room.streamcreate.error=400;zhibo room stream create failed
apis.zhibo.room.validation.roomname.length=400;Max length of roomName is 100.
apis.zhibo.room.validation.type.invalid=400;room type is invalid.
apis.zhibo.room.validation.guestCount.invalid=400;guestCount is invalid.
apis.zhibo.room.validation.roomNameOfOrg.existed=400;roomName of this org is already existed.
apis.zhibo.room.validation.avatar.length=400;Max length of avatar is 500.
apis.zhibo.room.validation.hostname.length=400;Max length of hostName is 50.
apis.zhibo.room.validation.adImgUrl.length=400;Max length of adImgUrl is 500.
apis.zhibo.room.validation.adLink.length=400;Max length of adLink is 500.
apis.zhibo.room.validation.adLocation.invalid=400;adLocation is invalid.
apis.zhibo.room.validation.enableAd.invalid=400;enableAd is invalid.
apis.zhibo.room.validation.ad.adImgUrl.required=400;ad.adImgUrl is required.
apis.zhibo.room.validation.ad.adLink.required=400;ad.adLink is required.
apis.zhibo.room.validation.ad.userIdNotHost=400;login userId is not the hostId.
apis.zhibo.room.validation.session.sessionName.required=400;session.sessionName is required.
apis.zhibo.room.validation.session.startEndtime.required=400;session.sessionStartTime and session.sessionEndTime are required.
apis.zhibo.room.validation.session.startEndtime.invalid=400;session.sessionStartTime should not equal or greater than session.sessionEndTime.
apis.zhibo.room.validation.session.timeConflict=400;session time period conflict
apis.zhibo.room.validation.session.exceedMaxSize=400;can only create 31 sessions for one room

修改历史

2018-02-12 请求body增加字段：roomCoverUrl, sessions[]多场次, ad广告; 增加验证信息;

修改直播室