简要描述：

  • 创建直播室，获取直播室推流和观看协议链接

请求URL:

  • /zhibo/rooms/{roomId}/linkvalidatecode 房间唯一验证码 (或者匿名无userId的情况)
  • /zhibo/rooms/{roomId}/users/{userId}/linkvalidatecode 用户唯一验证码

HTTP请求方法：

  • POST

请求头：

NA

URL请求参数:

NA

请求体参数:

参数名 是否必须 类型 输入校验 说明
userId 否 String 最大长度36 产线userId
userName 否 String 最大长度50 产线用户名称（当用户唯一验证码获取时验证不为空）
loginName 否 String 最大长度50 产线用户登陆名称
userAvatar 否 String 最大长度500 产线用户头像url
userPoint 否 String 大于0的整形数字符串 产线用户积分
roomId 否 String 最大长度36 直播室pid或roomCode
sessionName 否 String 最大长度50 直播场次名称
pwd 否 String 直播室密码(推流链接为推流密码，观看链接为观看密码)
at 否 String 0或1的字符串 是否为助教(“0”=否，”1”=是)
bgImg 否 String web观看页面对应的背景图
shortUrl 否 String 产线观看链接短地址（用于分享观看链接使用）
roomName 否 String 直播室名称（用于在微信分享观看链接时，显示直播室名称）
coverUrl 否 String 直播封面地址（用于在微信分享观看链接时，显示直播封面）
intro 否 String 直播简介信息（用于在微信分享观看链接时，显示直播简介）

返回参数说明:

返回200的成功的响应体:

参数名 类型 说明
code String 为直播验证code, 用在产线URL中作为ljCode参数的值传递给直播平台

示例:

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

请求体:
{
“userId”:”0bb18f9a-afbe-4d03-bcb4-a4157e4f90a2”,
“userName”:”test测试”,
“loginName”:”test123”,
“userAvatar”:”http://xxdsf/2323.png“,
“roomId”:”123123123dfaf”,
“sessionName”:”测试”,
“pwd”:”123456”,
“at”:”1”,
“userPoint”:”5600”,
“bgImg”:””,
“shortUrl”:”http://short.yunxuetang.com.cn/TMCfJH0P“,
“roomName”:”PPT使用培训”,
“coverUrl”:””,
“intro”:”如何直播漂亮的PPT”
}

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

  1. {
  2.     "code": "k86VV5ceVFFG0MdS"
  3. }

错误时返回:

状态值: HTTP/1.1 400 Bad Request

  1. {
  2.   "error": {
  3.     "key": "global.noprivilege",
  4.     "message": "No privilege."
  5.   }
  6. }

错误代码列表:

格式: key=状态码;message
apis.zhibo.account.validation.userpoint.value=400;user point available value is 0~max of integer.
apis.zhibo.account.validation.at.value=400;at available value is 0 or 1.