这是本文档旧的修订版!


概述

目前的openapi主要分为:获取Token、炒作直播间、第三方登录




Token


获取Token

描述:获取通讯凭证ACCESSTOKEN。

请求格式举例

POST lb/openapi/token/get HTTP/1.1
Host: https://live.rongkecloud.com/
Request Header: Content-Type:application/json;charset=utf-8
{
	"server_key" : "3f465948b28d6d66b953856c8a87d1b17a061e33"
}

请求头部

Field Value Description
Content-Type application/json 目前openapi全部都需要使用json格式来作为body请求体
Accept application/json 服务器返回的数据格式,目前服务器全部返回json格式的数据

请求参数

Parameter Description Required
server_key 企业密钥 Yes

响应格式举例(HTTP Body):

{
	"result": 
	{
		"token": "tk142721863959707648" 
	},
	"errmsg": "SUCCESS",
	"errcode": 0
}

返回值说明:

Parameter Description
result 返回相应的body体
token 此token是后续接口请求的凭证,如果在请求中token失效,则需要再重新获取token
errmsg 返回的错误信息,成功返回Success
errcode 返回的错误码,成功返回0

参数定义:server_key,是注册网客后,在管理平台产生的 40 位长度唯一字符串。

业务错误码:

错误码 含义
0 执行成功
1000 系统错误
1001 参数错误
1003 server_key无效

直播间相关操作


创建直播间

描述:创建一个直播间

请求格式举例

POST lb/openapi/token/get HTTP/1.1
Host: https://live.rongkecloud.com
Request Header: 
  Content-Type:application/json;charset=utf-8
	Accept:application/json;charset=utf-8
{
  "token":"tk142721863959707648",
  "topic":"mm",
  "anchor_name":"xiaozai",
  "anchor_pwd":"111111",  
  "anchor_desc":"我是 xiaozai",
  "live_source": "1",
  "room_type":"1"
}

请求头部

Field Value Description
Content-Type application/json 目前openapi全部都需要使用json格式来作为body请求体
Accept application/json 服务器返回的数据格式,目前服务器全部返回json格式的数据

请求参数

Parameter Description
token
topic 直播主题,必填,1-20位长度字符串
anchor_name 主播姓名,必填,1-10位长度字符串
anchor_pwd 主播进入会议室密码,必填,6-20位长度字符串,数字字母组合
anchor_desc 主播简介,选填,1-500位长度字符串
live_source 视频采集方式,必填,范围[“1”,“2”] 1-系统,2-外置
room_type 直播间时效, 必填,范围[“1”,“2”] 1-临时,2-永久

响应格式举例(HTTP Body):

Response Body:
{
  "result": {
    "room_id": "85100001"
  },
  "errmsg": "SUCCESS",
  "errcode": 0
}

返回值说明:

Parameter Description
result 返回相应的body体
room_id 房间id
errmsg 返回的错误信息,成功返回Success
errcode 返回的错误码,成功返回0

业务错误码:

错误码 含义
0 执行成功
1000 系统错误
1001 参数定义或者格式错误
1005 token无效

修改直播间

描述:在直播开始之前,修改直播间的任一属性,可以一次全部修改,也可以一次修改一项。

请求格式举例

POST lb/openapi/room/update HTTP/1.1
Host: https://live.rongkecloud.com
Request Header: 
  Content-Type:application/json;charset=utf-8
  Accept:application/json;charset=utf-8
 
{
  "token":"tk142721863959707648",
  "roomid": "100001",
  //以下各项均为选填项,与上次比,有变化则填写,未变化则不填写;
  "topic":"mm",
  "anchor_name":"xiaozai",
  "anchor_pwd":"111111",
  "anchor_desc":"111111"
}

请求头部

Field Value Description
Content-Type application/json 目前openapi全部都需要使用json格式来作为body请求体
Accept application/json 服务器返回的数据格式,目前服务器全部返回json格式的数据

请求参数

Parameter
token 用户身份校验凭证,必填,1-20位长度字符串
roomid 需要操作的直播间id,必填,字符串范围[1,Long.maxvalue]
topic 直播间主题,选填,1-20位长度字符串
anchor_name 发起人姓名,选填,1-10位长度字符串
anchor_pwd 主播密码,选填,6-20位长度字符串,数字字母组合
achor_desc 主播简介,选填,1-500位长度字符串

响应格式举例(HTTP Body):

Response Body:
{
  "errmsg": "SUCCESS",
  "errcode": 0
}

返回值说明:

Parameter Description
errmsg 返回的错误信息,成功返回Success
errcode 返回的错误码,成功返回0

业务错误码:

错误码 含义
0 执行成功
1000 系统错误
1001 参数错误
1005 token无效
3011 直播已结束
3012 直播已开始
3014 直播间无效

删除直播间

描述:删除直播间

请求格式举例

POST lb/openapi/room/delete HTTP/1.1
Host: https://live.rongkecloud.com
Request Headers: 
  Content-Type:application/json;charset=utf-8
  Accept:application/json;charset=utf-8
  Request Body: { 
    "token":"tk142721863959707648",
    "roomid": "85100001",
 
  }

请求头部

Field Value Description
Content-Type application/json 目前openapi全部都需要使用json格式来作为body请求体
Accept application/json 服务器返回的数据格式,目前服务器全部返回json格式的数据

请求参数

Parameter Description
token用户身份校验凭证,必填,1-20位长度字符串
roomid 需要操作的直播间id,必填,字符串范围[1,Long.maxvalue]

响应格式举例(HTTP Body):

Response Body:
{
  "errmsg": "SUCCESS",
  "errcode": 0
}

返回值说明:

Parameter Description
errmsg 返回的错误信息,成功返回Success
errcode 返回的错误码,成功返回0

业务错误码:

错误码 含义
0 执行成功
1000 系统错误
1001 参数定义或者格式错误
1005 token无效
3012 直播已开始
3014 直播间无效

获取直播间信息

描述:根据roomid获取直播间信息

请求格式举例

POST lb/openapi/room/get HTTP/1.1
Host: https://live.rongkecloud.com
Request Headers: 
  Content-Type:application/json;charset=utf-8
  Accept:application/json;charset=utf-8
  Request Body: { 
    "token": "tk142721863959707648",
    "roomid": "85100001"
 
  }

请求头部

Field Value Description
Content-Type application/json 目前openapi全部都需要使用json格式来作为body请求体
Accept application/json 服务器返回的数据格式,目前服务器全部返回json格式的数据

请求参数

Parameter Description
token 用户身份校验凭证,必填,1-20位长度字符串
roomid 需要操作的直播间id,必填,字符串范围[1,Long.maxvalue]

响应格式举例(HTTP Body):

Response Body:
{
  "result": [
    {
      "topic": "验证各项功能",
      "anchor_name": "验证各项功能",
      "stop_time": "1497077601",
      "anchor_pwd": "111111",
      "thema_url": "http://rongkeoss.aliyuncs.com/poster/dab5d0dd/1.jpg",
      "sub_roomid": "141822448379101184",
      "state": "3",
      "playback_url": "https://live.rongkecloud.com/a/142982894988558336",
      "viewer_url": "https://live.rongkecloud.com/a/85100001",
      "room_type": "2",
      "roomid": "52381750",
      "anchor_desc": "验证各项功能",
      "duration": "05:11:24",
      "live_source": "1",
      "poster_url":"http://rongkeoss.aliyuncs.com/poster/07496596a/1.jpg",
      "created": "1497006168",
      "start_time": "1497058917",
      "anchor_url": "https://live.rongkecloud.com/h/85100001"
} 
],
  "errmsg": "SUCCESS",
  "errcode": 0
}

返回值说明:

Parameter Description
topic 直播主题
anchor_name 主播名称
stop_time 直播结束时间
anchor_pwd 直播端进入直播间密码
thema_url 主题背景图片地址
sub_roomid 直播间子号码
state 直播间状态[0,1,3] 0-未开始,1-进行中,3-已结束
viewer_url 观看端URL地址
roomid 直播间号码
anchor_desc 主播描述
duration 直播时长
poster_url 海报图片地址
created 直播间创建时间
start_time 直播开始时间
anchor_url 直播端URL地址
playback_url 直播间视频回看地址(如果没有开启视频回看,该地址为空)
live_source 视频采集方式
room_type 直播间时效

业务错误码:

错误码 含义
0 执行成功
1000 系统错误
1001 参数定义或者格式错误
1005 token无效
3014 直播间无效

获取直播间列表

描述:获取直播间列表

请求格式举例

POST lb/openapi/room/list HTTP/1.1
Host: https://live.rongkecloud.com
Request Headers: 
  Content-Type:application/json;charset=utf-8
  Accept:application/json;charset=utf-8
  Request Body: { 
   "token":"tk142721863959707648"
 
  }

请求头部

Field Value Description
Content-Type application/json 目前openapi全部都需要使用json格式来作为body请求体
Accept application/json 服务器返回的数据格式,目前服务器全部返回json格式的数据

请求参数

Parameter Description
token 用户身份校验凭证,必填,1-20位长度字符串

响应格式举例(HTTP Body):

Response Body:
{
  "result": [
    {
      "topic": "验证各项功能",
      "anchor_name": "验证各项功能",
      "stop_time": "1497077601",
      "anchor_pwd": "111111",
      "thema_url": "http://rongkeoss.aliyuncs.com/poster/dab5d0dd/1.jpg",
      "sub_roomid": "141822448379101184",
      "state": "3",
      "playback_url": "https://live.rongkecloud.com/a/142982894988558336",
      "viewer_url": "https://live.rongkecloud.com/a/85100001",
      "room_type": "2",
      "roomid": "52381750",
      "anchor_desc": "验证各项功能",
      "duration": "05:11:24",
      "live_source": "1",
      "poster_url":"http://rongkeoss.aliyuncs.com/poster/07496596a/1.jpg",
      "created": "1497006168",
      "start_time": "1497058917",
      "anchor_url": "https://live.rongkecloud.com/h/85100001"
},
{},],
  "errmsg": "SUCCESS",
  "errcode": 0
}

请求参数

Parameter Description
topic 直播主题
anchor_name 主播名称
stop_time 直播结束时间
anchor_pwd 直播端进入直播间密码
thema_url 主题背景图片地址
sub_roomid 直播间子号码
state 直播间状态[0,1,3] 0-未开始,1-进行中,3-已结束
viewer_url 观看端URL地址
roomid 直播间号码
anchor_desc 主播描述
duration 直播时长
poster_url 海报图片地址
created 直播间创建时间
start_time 直播开始时间
anchor_url 直播端URL地址
playback_url 直播间视频回看地址
live_source 视频采集方式
room_type 直播间时效

业务错误码:

错误码 含义
0 执行成功
1000 系统错误
1001 参数定义或者格式错误
1005 token无效
3014 直播间无效

上传图片

描述:上传图片

请求格式举例

POST lb/openapi/room/image/upload HTTP/1.1
Host: https://live.rongkecloud.com
Request Headers: 
  Content-Type:multipart/form-data
  Accept:application/json;charset=utf-8
  Request Body: { 
    "token":"tk142721863959707648",
    "roomid": "85100001"
    "type": "1",
    "file": "本地文件路径"
 
  }

请求头部

Field Value Description
Content-Type multipart/form-data
Accept application/json 服务器返回的数据格式,目前服务器全部返回json格式的数据

请求参数

Parameter Description
token 用户身份校验凭证,必填,1-20位长度字符串

响应格式举例(HTTP Body):

Response Body:
{
  "token":"tk142721863959707648",
  "roomid": "85100001"
  "type": "1",
  "file": "本地文件路径"
 
 
}

请求参数

Parameter Description
token 用户身份校验凭证,必填,1-20位长度字符串
roomid 需要操作的直播间id,必填,字符串范围[1,Long.maxvalue]
type 上传图片类型,必填, 范围[“1”,“2”] (1.背景图片,2.海报图片)
file 上传文件路径,支持jpg、jpeg、png格式,限制20M

响应格式举例(HTTP Body)

Response Body:
{
"errmsg": "SUCCESS","errcode": 0
}

业务错误码

错误码 含义
0 执行成功
1000 系统错误
1001 参数定义或者格式错误
1005 token无效
3014 直播间无效
2005 文件太大

第三方登录

描述:第三方用户进入网客管理平台

请求格式举例

POST  otherLogin HTTP/1.1
Host: http://live.rongkecloud.com/
Request Headers: 
  Content-Type:multipart/form-data
  Accept:application/json;charset=utf-8
  Request Body: { 
    "account":"xuxiaomeng@rongkecloud.com",
    "timestamp":"1497947499525",
    "noncestr":"UgACgq4yGItkD3MrKU8TiFrfSz0RIHfZ",
    "backurl":"/TestOtherLogin/error"
  }

请求参数

Parameter Description Required Length Type
account 登陆网客的邮箱账号 N1-52String
timestamp获得当前时间戳,精确到毫秒;例如:1497955992787N long
noncestr随机字符串N32String
backurl回调地址N1-100String
sign使用account、timestamp、randomStr、backUrl加上MD5加密后的登陆密码为参数用MD5加密生成签名;N32String

请求结果说明 请求成功:直接进入主页面

请求失败

错误码 类型 说明
1String 网客的邮箱账号为空
2String 时间戳为空
3String 请求时间不再有效时间的范围内
4String 随机字符串为空
5String 签名为空
6String 账号不存在
7String 签名错误
8String 账号被禁用
9String 回调地址长度超限
10String 账号长度超限
11String 时间戳格式错误
12String 随机字符串格式错误

sign签名流程:

1. 对登录网客密码进行MD5加密,产生32位的加密字符串。

 例如:
 登陆密码为11111111,经过MD5加密后产生的字符串为:1bbd886460827015e5d605ed44252251

2. 对请求参数进行字典集排序后,并且和加密后的登录密码进行合并,作为签名的原始数据。

  例如:
      account=xuxiaomeng@rongkecloud.com
      timestamp=1497947499525
      noncestr =UgACgq4yGItkD3MrKU8TiFrfSz0RIHfZ
      backurl=/TestOtherLogin/error

字典集排序后合并加密密码字符串: account=xuxiaomeng@rongkecloud.com&backurl=/TestOtherLogin/ error&noncestr=GUd2AY8aBZbcdWjrmySiOj3Zrx4ZPyRL& timestamp=1498100460959&1bbd886460827015e5d605ed44252251

(注意)进行字典集排序的每个K-V参数进行连接的字符为”&”

3.对排序后的字符串进行MD5(32)加密后生成的 sign:0ed8d8cd8f936299dca27382857b90e9 错误码返回:

错误码是通过提供的回调地址进行返回:
示例:http://xxxxx/xx?errcode=1