差别

这里会显示出您选择的修订版和当前版本之间的差别。

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版 		前一修订版
k_openapi:a_instructions [2017-06-23 15:46]
weijia 		k_openapi:a_instructions [2017-06-23 17:03] (当前版本)
weijia
行 30: 行 30:
 <code php> <code php>
 URL: https://​live.rongkecloud.com/​lb/​openapi/​token/​get URL: https://​live.rongkecloud.com/​lb/​openapi/​token/​get
-Request Header: Content-Type:​application/​json;​charset=utf-8 +Request Header: ​ 
-Request Body: +        ​Content-Type:​application/​json;​charset=utf-8 
-{ +        Accept:​application/​json;​charset=utf-8 
- "​server_key"​ : "​3f465948b28d6d66b953856c8a87d1b17a061e33"​+Request Body:{ 
 +       ​"​server_key"​ : "​3f465948b28d6d66b953856c8a87d1b17a061e33"​
 } }
 </​code>​ </​code>​
行 55: 行 56:
 **响应格式举例** **响应格式举例**
 <code php> <code php>
-Response Body: +Response Body:{ 
-{ +         ​"​result":​  
- "​result":​  +        { 
- { +          "​token":​ "​tk142721863959707648"​  
- "​token":​ "​tk142721863959707648"​  +        }, 
- }, +          "​errmsg":​ "​SUCCESS",​ 
- "​errmsg":​ "​SUCCESS",​ +          "​errcode":​ 0
- "​errcode":​ 0+
 } }
 </​code>​ </​code>​
行 68: 行 68:
 **参数定义：server_key，是注册网客后，在管理平台产生的 40 位长度唯一字符串。** **参数定义：server_key，是注册网客后，在管理平台产生的 40 位长度唯一字符串。**
  
-{{:​g_outerapp:​人.png?400|}}+{{:​g_outerapp:​人.png}}
  
  
行 101: 行 101:
 **请求格式举例** **请求格式举例**
 <code php> <code php>
-POST lb/​openapi/​token/​get HTTP/1.1 +URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​create 
-Host: https://​live.rongkecloud.com +Request Header: 
-Request Header:  +        Content-Type:​application/​json;​charset=utf-8 
-  Content-Type:​application/​json;​charset=utf-8 +        Accept:​application/​json;​charset=utf-8 
- Accept:​application/​json;​charset=utf-8 +Request Body: { 
-Request Body:  +        "​token":"​tk142721863959707648",​ 
-{ +        "​topic":"​mm",​ 
-  "​token":"​tk142721863959707648",​ +        "​anchor_name":"​xiaozai",​ 
-  "​topic":"​mm",​ +        "​anchor_pwd":"​111111", ​  
-  "​anchor_name":"​xiaozai",​ +        "​anchor_desc":"​我是 xiaozai",​ 
-  "​anchor_pwd":"​111111", ​  +        "​live_source":​ "​1",​ 
-  "​anchor_desc":"​我是 xiaozai",​ +        "​room_type":"​1"​ 
-  "​live_source":​ "​1",​ + }
-  "​room_type":"​1"​ +
-}+
 </​code>​ </​code>​
  
行 134: 行 132:
 **响应格式举例** **响应格式举例**
 <code php> <code php>
-Response Body: +Response Body:{ 
-{ +         ​"​result":​ { 
-  "​result":​ { +         ​"​room_id":​ "​85100001"​ 
-    "​room_id":​ "​85100001"​ +        }, 
-  }, +         ​"​errmsg":​ "​SUCCESS",​ 
-  "​errmsg":​ "​SUCCESS",​ +         ​"​errcode":​ 0
-  "​errcode":​ 0+
 } }
 </​code>​ </​code>​
行 155: 行 152:
 ^ METHOD ^ ^ METHOD ^
 |POST | |POST |
- 
-**请求格式举例** 
-<code php> 
-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"​ 
-} 
- 
-</​code>​ 
  
 **请求头部** **请求头部**
行 189: 行 166:
 |anchor_pwd |主播密码，选填，6-20位长度字符串，数字字母组合 | |anchor_pwd |主播密码，选填，6-20位长度字符串，数字字母组合 |
 |achor_desc |主播简介，选填，1-500位长度字符串| |achor_desc |主播简介，选填，1-500位长度字符串|
 +**请求格式举例**
 +<code php>
 +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"​
 +  }
  
-**响应格式举例（HTTP Body）**: 
-<code php> 
-Response Body: 
-{ 
-  "​errmsg":​ "​SUCCESS",​ 
-  "​errcode":​ 0 
-} 
 </​code>​ </​code>​
-**返回值说明:**+ 
 +**返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
 |errmsg |返回的错误信息，成功返回Success | |errmsg |返回的错误信息，成功返回Success |
 |errcode |返回的错误码，成功返回0 | |errcode |返回的错误码，成功返回0 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 212: 行 198:
 |3012 |直播已开始 | |3012 |直播已开始 |
 |3014 |直播间无效 | |3014 |直播间无效 |
 +
 +**响应格式举例**
 +<code php>
 +Response Body:{
 +        "​errmsg":​ "​SUCCESS",​
 +        "​errcode":​ 0
 +}
 +</​code>​
 +
  
  
行 217: 行 212:
 描述：删除直播间 描述：删除直播间
  
-**请求格式举例** +**请求地址** 
-<code php> +^ URL ^ 
-POST lb/​openapi/​room/​delete HTTP/1.1 +|https://​live.rongkecloud.com/​lb/openapi/​room/​delete | 
-Host: https://​live.rongkecloud.com + 
-Request Headers:  +**请求方式** 
-  Content-Type:​application/json;​charset=utf-8 +^ METHOD ^ 
-  Accept:​application/json;​charset=utf-8 +|POST |
-  ​Request Body: {  +
-    "​token":"​tk142721863959707648",​ +
-    "​roomid":​ "​85100001",​+
  
-  } 
-</​code>​ 
 **请求头部** **请求头部**
 ^Field ^Value ^Description ^ ^Field ^Value ^Description ^
行 240: 行 230:
 |roomid |需要操作的直播间id，必填，字符串范围[1,​Long.maxvalue] | |roomid |需要操作的直播间id，必填，字符串范围[1,​Long.maxvalue] |
  
-**响应格式举例（HTTP Body）**:+**请求格式举例**
 <code php> <code php>
-Response Body: +URL: https://​live.rongkecloud.comlb/​openapi/​room/​delete 
-{ +Request Headers:  
-  "errmsg": "SUCCESS", +        Content-Type:​application/​json;​charset=utf-8 
-  "errcode": ​0 +        Accept:​application/​json;​charset=utf-8 
-}+Request Body: {  
 +        "token":"​tk142721863959707648", 
 +        "roomid": ​"​85100001"​ 
 + 
 +  ​}
 </​code>​ </​code>​
-**返回值说明:**+**返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
 |errmsg |返回的错误信息，成功返回Success | |errmsg |返回的错误信息，成功返回Success |
 |errcode |返回的错误码，成功返回0 | |errcode |返回的错误码，成功返回0 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 261: 行 255:
 |3012 |直播已开始 | |3012 |直播已开始 |
 |3014 |直播间无效 | |3014 |直播间无效 |
 +
 +**响应格式举例**
 +<code php>
 +Response Body:{
 +        "​errmsg":​ "​SUCCESS",​
 +        "​errcode":​ 0
 +}
 +</​code>​
 +
  
  
行 266: 行 269:
 描述：根据roomid获取直播间信息 描述：根据roomid获取直播间信息
  
-**请求格式举例** +**请求地址** 
-<code php> +^ URL ^ 
-POST lb/​openapi/​room/​get HTTP/1.1 +|https://​live.rongkecloud.com/​lb/openapi/​room/​get | 
-Host: https://​live.rongkecloud.com + 
-Request Headers:  +**请求方式** 
-  Content-Type:​application/json;​charset=utf-8 +^ METHOD ^ 
-  Accept:​application/json;​charset=utf-8 +|POST |
-  ​Request Body: {  +
-    "​token":​ "​tk142721863959707648",​ +
-    "​roomid":​ "​85100001"​+
  
-  } 
-</​code>​ 
 **请求头部** **请求头部**
 ^Field ^Value ^Description ^ ^Field ^Value ^Description ^
行 289: 行 287:
 |roomid |需要操作的直播间id，必填，字符串范围[1,​Long.maxvalue] | |roomid |需要操作的直播间id，必填，字符串范围[1,​Long.maxvalue] |
  
-**响应格式举例（HTTP Body）**:+**请求格式举例**
 <code php> <code php>
-Response Body: +URL: https://​live.rongkecloud.com/​lb/openapi/room/get 
-{ +Request Headers:  
-  "​result":​ [ +        ​Content-Type:application/​json;​charset=utf-8 
-    { +        ​Accept:application/json;​charset=utf-8 
-      "​topic":​ "​验证各项功能",​ +Request Body: {  
-      "​anchor_name":​ "​验证各项功能",​ +        "token": "tk142721863959707648", 
-      "​stop_time":​ "​1497077601",​ +        "roomid": "​85100001"​ 
-      "​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 +
-} +
 </​code>​ </​code>​
-**返回值说明:**+ 
 +**返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
 |topic |直播主题 | |topic |直播主题 |
行 341: 行 320:
 |room_type | 直播间时效 | |room_type | 直播间时效 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 348: 行 327:
 |1005 |token无效 | |1005 |token无效 |
 |3014 |直播间无效 | |3014 |直播间无效 |
 +
 +**响应格式举例**
 +<code php>
 +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
 +}
 +
 +</​code>​
 +
  
 ====获取直播间列表==== ====获取直播间列表====
 描述：获取直播间列表 描述：获取直播间列表
  
-**请求格式举例** +**请求地址** 
-<code php> +^ URL ^ 
-POST lb/​openapi/​room/​list HTTP/1.1 +|https://​live.rongkecloud.com/​lb/​openapi/​room/​list | 
-Host: https://​live.rongkecloud.com + 
-Request Headers: ​ +**请求方式** 
-  ​Content-Type:​application/​json;​charset=utf-8 +^ METHOD ^ 
-  ​Accept:​application/​json;​charset=utf-8 +|POST |
-  ​Request Body: {  +
-   "​token":"​tk142721863959707648"​+
  
-  } 
-</​code>​ 
 **请求头部** **请求头部**
 ^Field ^Value ^Description ^ ^Field ^Value ^Description ^
行 373: 行 380:
 |token | 用户身份校验凭证，必填，1-20位长度字符串 | |token | 用户身份校验凭证，必填，1-20位长度字符串 |
  
-**响应格式举例（HTTP Body）**:+**请求格式举例**
 <code php> <code php>
-Response Body: +URL: https://​live.rongkecloud.com/​lb/openapi/room/list 
-{ +Request Headers:  
-  "​result":​ [ +        ​Content-Type:application/​json;​charset=utf-8 
-    { +        ​Accept:application/json;​charset=utf-8 
-      "​topic":​ "​验证各项功能",​ +Request Body: {  
-      "​anchor_name":​ "​验证各项功能",​ +        "token":"​tk142721863959707648" 
-      "​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 +
-}  +
- +
 </​code>​ </​code>​
 +
 **返回值说明** **返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
行 428: 行 412:
 |room_type | 直播间时效 | |room_type | 直播间时效 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 435: 行 419:
 |1005 |token无效 | |1005 |token无效 |
 |3014 |直播间无效 | |3014 |直播间无效 |
 +
 +**响应格式举例**
 +<code php>
 +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
 +} 
 +
 +
 +</​code>​
 +
  
  
行 440: 行 459:
 描述：上传图片 描述：上传图片
  
-**请求格式举例** +**请求地址** 
-<code php> +^ URL ^ 
-POST lb/​openapi/​room/​image/​upload HTTP/1.1 +|https://​live.rongkecloud.com/​lb/openapi/​room/​image/​upload | 
-Host: https://​live.rongkecloud.com + 
-Request Headers:  +**请求方式** 
-  Content-Type:​multipart/form-data +^ METHOD ^ 
-  Accept:​application/json;​charset=utf-8 +|POST |
-  ​Request Body: {  +
-    "​token":"​tk142721863959707648",​ +
-    "​roomid":​ "​85100001"​ +
-    "​type":​ "​1",​ +
-    "​file":​ "​本地文件路径"​+
  
-  } 
-</​code>​ 
 **请求头部** **请求头部**
 ^Field ^Value ^Description ^ ^Field ^Value ^Description ^
行 467: 行 479:
 |file | 上传文件路径，支持jpg、jpeg、png格式，限制20M| |file | 上传文件路径，支持jpg、jpeg、png格式，限制20M|
  
- +**请求格式举例**
-**响应格式举例（HTTP Body）**+
 <code php> <code php>
-Response Body: +URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​image/​upload 
-{ +Request Headers:  
-"errmsg": "SUCCESS","​errcode": ​0 +        Content-Type:​multipart/​form-data 
-}+        Accept:​application/​json;​charset=utf-8 
 +Request Body: {  
 +        "token":"​tk142721863959707648", 
 +        ​"roomid": ​"​85100001"​ 
 +        "​type":​ "​1",​ 
 +        "​file":​ "​本地文件路径"​ 
 +  }
 </​code>​ </​code>​
 +
 +**返回值说明**
 +^Parameter ^Description ^
 +|errmsg |返回的错误信息，成功返回Success |
 +|errcode |返回的错误码，成功返回0 |
  
 **业务错误码** **业务错误码**
行 484: 行 506:
 |3014 |直播间无效 | |3014 |直播间无效 |
 |2005 |文件太大 | |2005 |文件太大 |
 +
 +**响应格式举例**
 +<code php>
 +Response Body:{
 +"​errmsg":​ "​SUCCESS","​errcode":​ 0
 +}
 +</​code>​
 +
 +
  
 ====第三方登录==== ====第三方登录====
 描述：第三方用户进入网客管理平台 描述：第三方用户进入网客管理平台
  
-**请求格式举例** +**请求地址** 
-<code php> +^ URL ^ 
-POST  otherLogin HTTP/1.1 +|https://​live.rongkecloud.com/​otherLogin |
-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"​ +
-  } +
-</​code>​+
  
 +**请求方式**
 +^ METHOD ^
 +|POST |
  
 **请求参数** **请求参数**
行 511: 行 534:
 |backurl|回调地址|N|1-100|String| |backurl|回调地址|N|1-100|String|
 |sign|使用account、timestamp、randomStr、backUrl加上MD5加密后的登陆密码为参数用MD5加密生成签名；|N|32|String| |sign|使用account、timestamp、randomStr、backUrl加上MD5加密后的登陆密码为参数用MD5加密生成签名；|N|32|String|
 +
 +**请求格式举例**
 +<code php>
 +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"​
 +
 +  }
 +</​code>​
  
 **请求结果说明** **请求结果说明**