差别

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

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版
前一修订版
k_openapi:a_instructions [2017-06-23 16:10]
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: ​ 
-Accept:​application/​json;​charset=utf-8 +        ​Content-Type:​application/​json;​charset=utf-8 
-Request Body: +        Accept:​application/​json;​charset=utf-8 
-+Request Body:{ 
- "​server_key"​ : "​3f465948b28d6d66b953856c8a87d1b17a061e33"​+       ​"​server_key"​ : "​3f465948b28d6d66b953856c8a87d1b17a061e33"​
 } }
 </​code>​ </​code>​
行 56: 行 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>​
行 69: 行 68:
 **参数定义:server_key,是注册网客后,在管理平台产生的 40 位长度唯一字符串。** **参数定义:server_key,是注册网客后,在管理平台产生的 40 位长度唯一字符串。**
  
-{{:​g_outerapp:​人.png?400|}}+{{:​g_outerapp:​人.png}}
  
  
行 104: 行 103:
 URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​create URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​create
 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",​ 
-  "​token":"​tk142721863959707648",​ +        "​topic":"​mm",​ 
-  "​topic":"​mm",​ +        "​anchor_name":"​xiaozai",​ 
-  "​anchor_name":"​xiaozai",​ +        "​anchor_pwd":"​111111", ​  
-  "​anchor_pwd":"​111111", ​  +        "​anchor_desc":"​我是 xiaozai",​ 
-  "​anchor_desc":"​我是 xiaozai",​ +        "​live_source":​ "​1",​ 
-  "​live_source":​ "​1",​ +        "​room_type":"​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>​
行 171: 行 168:
 **请求格式举例** **请求格式举例**
 <code php> <code php>
-URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​create+URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​update
 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 
-Response ​Body: +Request ​Body:{ 
-+         ​"​token":"​tk142721863959707648",​ 
-  "​token":"​tk142721863959707648",​ +         ​"​roomid":​ "​100001",​ 
-  "​roomid":​ "​100001",​ +         ​//​以下各项均为选填项,与上次比,有变化则填写,未变化则不填写; 
-  //​以下各项均为选填项,与上次比,有变化则填写,未变化则不填写; +         ​"​topic":"​mm",​ 
-  "​topic":"​mm",​ +         ​"​anchor_name":"​xiaozai",​ 
-  "​anchor_name":"​xiaozai",​ +         ​"​anchor_pwd":"​111111",​ 
-  "​anchor_pwd":"​111111",​ +         ​"​anchor_desc":"​111111"​ 
-  "​anchor_desc":"​111111"​ +  }
-}+
  
 </​code>​ </​code>​
  
-**返回值说明:**+**返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
 |errmsg |返回的错误信息,成功返回Success | |errmsg |返回的错误信息,成功返回Success |
 |errcode |返回的错误码,成功返回0 | |errcode |返回的错误码,成功返回0 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 203: 行 199:
 |3014 |直播间无效 | |3014 |直播间无效 |
  
-**响应格式举例(HTTP Body)**:+**响应格式举例**
 <code php> <code php>
-Response Body: +Response Body:{ 
-+        "​errmsg":​ "​SUCCESS",​ 
-  "​errmsg":​ "​SUCCESS",​ +        "​errcode":​ 0
-  "​errcode":​ 0+
 } }
 </​code>​ </​code>​
行 237: 行 232:
 **请求格式举例** **请求格式举例**
 <code php> <code php>
-URL: https://​live.rongkecloud.com+URL: https://​live.rongkecloud.comlb/​openapi/​room/​delete
 Request Headers: ​ Request Headers: ​
-  ​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",​ +        "​token":"​tk142721863959707648",​ 
-    "​roomid":​ "​85100001"​,+        "​roomid":​ "​85100001"​
  
   }   }
行 261: 行 256:
 |3014 |直播间无效 | |3014 |直播间无效 |
  
-**响应格式举例(HTTP Body)**+**响应格式举例**
 <code php> <code php>
-Response Body: +Response Body:{ 
-+        "​errmsg":​ "​SUCCESS",​ 
-  "​errmsg":​ "​SUCCESS",​ +        "​errcode":​ 0
-  "​errcode":​ 0+
 } }
 </​code>​ </​code>​
行 297: 行 291:
 URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​get URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​get
 Request Headers: ​ Request Headers: ​
-  ​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",​ +        "​token":​ "​tk142721863959707648",​ 
-    "​roomid":​ "​85100001"​ +        "​roomid":​ "​85100001"​
   }   }
 </​code>​ </​code>​
行 335: 行 328:
 |3014 |直播间无效 | |3014 |直播间无效 |
  
-**响应格式举例(HTTP Body)**+**响应格式举例**
 <code php> <code php>
-Response Body: +Response Body:{ 
-+          "​result":​ [ 
-  "​result":​ [ +            
-    +              "​topic":​ "​验证各项功能",​ 
-      "​topic":​ "​验证各项功能",​ +              "​anchor_name":​ "​验证各项功能",​ 
-      "​anchor_name":​ "​验证各项功能",​ +              "​stop_time":​ "​1497077601",​ 
-      "​stop_time":​ "​1497077601",​ +              "​anchor_pwd":​ "​111111",​ 
-      "​anchor_pwd":​ "​111111",​ +              "​thema_url":​ "​http://​rongkeoss.aliyuncs.com/​poster/​dab5d0dd/​1.jpg",​ 
-      "​thema_url":​ "​http://​rongkeoss.aliyuncs.com/​poster/​dab5d0dd/​1.jpg",​ +              "​sub_roomid":​ "​141822448379101184",​ 
-      "​sub_roomid":​ "​141822448379101184",​ +              "​state":​ "​3",​ 
-      "​state":​ "​3",​ +              "​playback_url":​ "​https://​live.rongkecloud.com/​a/​142982894988558336",​ 
-      "​playback_url":​ "​https://​live.rongkecloud.com/​a/​142982894988558336",​ +              "​viewer_url":​ "​https://​live.rongkecloud.com/​a/​85100001",​ 
-      "​viewer_url":​ "​https://​live.rongkecloud.com/​a/​85100001",​ +              "​room_type":​ "​2",​ 
-      "​room_type":​ "​2",​ +              "​roomid":​ "​52381750",​ 
-      "​roomid":​ "​52381750",​ +              "​anchor_desc":​ "​验证各项功能",​ 
-      "​anchor_desc":​ "​验证各项功能",​ +              "​duration":​ "​05:​11:​24",​ 
-      "​duration":​ "​05:​11:​24",​ +              "​live_source":​ "​1",​ 
-      "​live_source":​ "​1",​ +              "​poster_url":"​http://​rongkeoss.aliyuncs.com/​poster/​07496596a/​1.jpg",​ 
-      "​poster_url":"​http://​rongkeoss.aliyuncs.com/​poster/​07496596a/​1.jpg",​ +              "​created":​ "​1497006168",​ 
-      "​created":​ "​1497006168",​ +              "​start_time":​ "​1497058917",​ 
-      "​start_time":​ "​1497058917",​ +              "​anchor_url":​ "​https://​live.rongkecloud.com/​h/​85100001"​ 
-      "​anchor_url":​ "​https://​live.rongkecloud.com/​h/​85100001"​ +        }  
-}  +        ],
-],+
   "​errmsg":​ "​SUCCESS",​   "​errmsg":​ "​SUCCESS",​
   "​errcode":​ 0   "​errcode":​ 0
行 390: 行 382:
 **请求格式举例** **请求格式举例**
 <code php> <code php>
-URL: https://​live.rongkecloud.com+URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​list
 Request Headers: ​ Request Headers: ​
-  ​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"​+        "​token":"​tk142721863959707648"​
   }   }
 </​code>​ </​code>​
行 428: 行 420:
 |3014 |直播间无效 | |3014 |直播间无效 |
  
-**响应格式举例(HTTP Body)**+**响应格式举例**
 <code php> <code php>
-Response Body: +Response Body:{ 
-+          "​result":​ [ 
-  "​result":​ [ +            
-    +              "​topic":​ "​验证各项功能",​ 
-      "​topic":​ "​验证各项功能",​ +              "​anchor_name":​ "​验证各项功能",​ 
-      "​anchor_name":​ "​验证各项功能",​ +              "​stop_time":​ "​1497077601",​ 
-      "​stop_time":​ "​1497077601",​ +              "​anchor_pwd":​ "​111111",​ 
-      "​anchor_pwd":​ "​111111",​ +              "​thema_url":​ "​http://​rongkeoss.aliyuncs.com/​poster/​dab5d0dd/​1.jpg",​ 
-      "​thema_url":​ "​http://​rongkeoss.aliyuncs.com/​poster/​dab5d0dd/​1.jpg",​ +              "​sub_roomid":​ "​141822448379101184",​ 
-      "​sub_roomid":​ "​141822448379101184",​ +              "​state":​ "​3",​ 
-      "​state":​ "​3",​ +              "​playback_url":​ "​https://​live.rongkecloud.com/​a/​142982894988558336",​ 
-      "​playback_url":​ "​https://​live.rongkecloud.com/​a/​142982894988558336",​ +              "​viewer_url":​ "​https://​live.rongkecloud.com/​a/​85100001",​ 
-      "​viewer_url":​ "​https://​live.rongkecloud.com/​a/​85100001",​ +              "​room_type":​ "​2",​ 
-      "​room_type":​ "​2",​ +              "​roomid":​ "​52381750",​ 
-      "​roomid":​ "​52381750",​ +              "​anchor_desc":​ "​验证各项功能",​ 
-      "​anchor_desc":​ "​验证各项功能",​ +              "​duration":​ "​05:​11:​24",​ 
-      "​duration":​ "​05:​11:​24",​ +              "​live_source":​ "​1",​ 
-      "​live_source":​ "​1",​ +              "​poster_url":"​http://​rongkeoss.aliyuncs.com/​poster/​07496596a/​1.jpg",​ 
-      "​poster_url":"​http://​rongkeoss.aliyuncs.com/​poster/​07496596a/​1.jpg",​ +              "​created":​ "​1497006168",​ 
-      "​created":​ "​1497006168",​ +              "​start_time":​ "​1497058917",​ 
-      "​start_time":​ "​1497058917",​ +              "​anchor_url":​ "​https://​live.rongkecloud.com/​h/​85100001"​ 
-      "​anchor_url":​ "​https://​live.rongkecloud.com/​h/​85100001"​ +        }, 
-}, +        {},
-{},+
  
   ],   ],
行 490: 行 481:
 **请求格式举例** **请求格式举例**
 <code php> <code php>
-URL: https://​live.rongkecloud.com+URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​image/​upload
 Request Headers: ​ Request Headers: ​
-  ​Content-Type:​multipart/​form-data +        ​Content-Type:​multipart/​form-data 
-  Accept:​application/​json;​charset=utf-8 +        Accept:​application/​json;​charset=utf-8 
-  Request Body: {  +Request Body: {  
-    "​token":"​tk142721863959707648",​ +        "​token":"​tk142721863959707648",​ 
-    "​roomid":​ "​85100001"​ +        "​roomid":​ "​85100001"​ 
-    "​type":​ "​1",​ +        "​type":​ "​1",​ 
-    "​file":​ "​本地文件路径"​+        "​file":​ "​本地文件路径"​
   }   }
 </​code>​ </​code>​
 +
 +**返回值说明**
 +^Parameter ^Description ^
 +|errmsg |返回的错误信息,成功返回Success |
 +|errcode |返回的错误码,成功返回0 |
  
 **业务错误码** **业务错误码**
行 511: 行 507:
 |2005 |文件太大 | |2005 |文件太大 |
  
-**响应格式举例(HTTP Body)**+**响应格式举例**
 <code php> <code php>
-Response Body: +Response Body:{
-{+
 "​errmsg":​ "​SUCCESS","​errcode":​ 0 "​errmsg":​ "​SUCCESS","​errcode":​ 0
 } }
行 542: 行 537:
 **请求格式举例** **请求格式举例**
 <code php> <code php>
-URL: http://​live.rongkecloud.com/​+URL: https://​live.rongkecloud.com/​otherLogin
 Request Headers: ​ Request Headers: ​
-  ​Content-Type:​multipart/​form-data +        ​Content-Type:​multipart/​form-data 
-  Accept:​application/​json;​charset=utf-8 +        Accept:​application/​json;​charset=utf-8 
-  Request Body: {  +Request Body: {  
-    "​account":"​xuxiaomeng@rongkecloud.com",​ +        "​account":"​xuxiaomeng@rongkecloud.com",​ 
-    "​timestamp":"​1497947499525",​ +        "​timestamp":"​1497947499525",​ 
-    "​noncestr":"​UgACgq4yGItkD3MrKU8TiFrfSz0RIHfZ",​ +        "​noncestr":"​UgACgq4yGItkD3MrKU8TiFrfSz0RIHfZ",​ 
-    "​backurl":"/​TestOtherLogin/​error"​+        "​backurl":"/​TestOtherLogin/​error"​
 +        "​sign":"​0ed8d8cd8f936299dca27382857b90e9"​ 
   }   }
 </​code>​ </​code>​