概述

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

描述：获取通讯凭证TOKEN。

请求地址

请求方式

请求头部

请求参数

请求格式举例

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

返回值说明

业务错误码

响应格式举例

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

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

描述：创建一个直播间

请求地址

请求方式

请求头部

请求参数

请求格式举例

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

返回值说明

业务错误码

响应格式举例

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

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

请求地址

请求方式

请求头部

请求参数

请求格式举例

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

返回值说明

业务错误码

响应格式举例

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

描述：删除直播间

请求地址

请求方式

请求头部

请求参数

请求格式举例

URL: https://live.rongkecloud.comlb/openapi/room/delete
Request Headers: 
        Content-Type:application/json;charset=utf-8
        Accept:application/json;charset=utf-8
Request Body: { 
        "token":"tk142721863959707648",
        "roomid": "85100001"
 
  }

返回值说明

业务错误码

响应格式举例

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

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

请求地址

请求方式

请求头部

请求参数

请求格式举例

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

返回值说明

业务错误码

响应格式举例

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
}

描述：获取直播间列表

请求地址

请求方式

请求头部

请求参数

请求格式举例

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

返回值说明

业务错误码

响应格式举例

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
}

描述：上传图片

请求地址

请求方式

请求头部

请求参数

请求格式举例

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

返回值说明

业务错误码

响应格式举例

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

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

请求地址

请求方式

请求参数

请求格式举例

URL: https://live.rongkecloud.com/otherLogin
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",
        "sign":"0ed8d8cd8f936299dca27382857b90e9"
 
  }

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

请求失败

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