差别

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

到此差别页面的链接

两侧同时换到之前的修订记录 前一修订版
后一修订版
前一修订版
k_openapi:a_instructions [2017-06-23 14:35]
weijia
k_openapi:a_instructions [2017-06-23 17:03] (当前版本)
weijia
行 9: 行 9:
 描述:获取通讯凭证TOKEN。 描述:获取通讯凭证TOKEN。
  
-**请求格式举例** +**请求地址** 
-<code php> +^ URL ^ 
-POST lb/​openapi/​token/​get HTTP/1.1 +|https://​live.rongkecloud.com/​lb/openapi/​token/​get | 
-Host: https://​live.rongkecloud.com/​ + 
-Request Header: Content-Type:​application/json;​charset=utf-8 +**请求方式** 
-{ +^ METHOD ^ 
- "​server_key"​ : "​3f465948b28d6d66b953856c8a87d1b17a061e33"​ +|POST | 
-} +
-</​code>​+
 **请求头部** **请求头部**
 ^Field ^Value ^Description ^ ^Field ^Value ^Description ^
行 28: 行 27:
  
  
-**响应格式举例(HTTP Body)**:+**请求格式举例**
 <code php> <code php>
-{ +URL: https://​live.rongkecloud.com/​lb/​openapi/​token/​get 
- "​result"​:  +Request Header:  
- { +        ​Content-Type:​application/​json;​charset=utf-8 
- "​token"​"​tk142721863959707648" ​ +        ​Accept:application/​json;​charset=utf-8 
- }, +Request Body:{ 
- "errmsg": "SUCCESS"+       ​"server_key" : "3f465948b28d6d66b953856c8a87d1b17a061e33"
- "​errcode":​ 0+
 } }
 </​code>​ </​code>​
-**返回值说明:**+ 
 + 
 + 
 +**返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
 |result |返回相应的body体 | |result |返回相应的body体 |
行 45: 行 46:
 |errmsg |返回的错误信息,成功返回Success | |errmsg |返回的错误信息,成功返回Success |
 |errcode |返回的错误码,成功返回0 | |errcode |返回的错误码,成功返回0 |
-**参数定义:server_key,是注册网客后,在管理平台产生的 40 位长度唯一字符串。** 
- 
-{{:​g_outerapp:​人.png?​200|}} 
  
- +**业务错误码**
-**业务错误码**:+
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 56: 行 53:
 |1001 |参数错误 | |1001 |参数错误 |
 |1003 |server_key无效 | |1003 |server_key无效 |
- + 
 +**响应格式举例** 
 +<code php> 
 +Response Body:{ 
 +         "​result":​  
 +        { 
 +          "​token":​ "​tk142721863959707648"​  
 +        }, 
 +          "​errmsg":​ "​SUCCESS",​ 
 +          "​errcode":​ 0 
 +
 +</​code>​ 
 + 
 +**参数定义:server_key,是注册网客后,在管理平台产生的 40 位长度唯一字符串。** 
 + 
 +{{:​g_outerapp:​人.png}} 
 + 
 =====直播间相关操作===== =====直播间相关操作=====
 ----- -----
行 62: 行 76:
 描述:创建一个直播间 描述:创建一个直播间
  
-**请求格式举例** +**请求地址** 
-<code php> +^ URL ^ 
-POST lb/​openapi/​token/​get HTTP/1.1 +|https://​live.rongkecloud.com/​lb/openapi/​room/​create |
-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"​ +
-}+
  
-</​code>​+**请求方式** 
 +^ METHOD ^ 
 +|POST |
  
 **请求头部** **请求头部**
行 85: 行 88:
 |Content-Type |application/​json |目前openapi全部都需要使用json格式来作为body请求体 | |Content-Type |application/​json |目前openapi全部都需要使用json格式来作为body请求体 |
 |Accept |application/​json |服务器返回的数据格式,目前服务器全部返回json格式的数据 | |Accept |application/​json |服务器返回的数据格式,目前服务器全部返回json格式的数据 |
- 
  
 **请求参数** **请求参数**
-^Parameter ^Description^ +^Parameter ^Description ^ 
-|token |用户身份校验凭证,必填,1-20位长度字符串+|token |用户身份校验凭证,必填,1-20位长度字符串|
 |topic |直播主题,必填,1-20位长度字符串| |topic |直播主题,必填,1-20位长度字符串|
 |anchor_name |主播姓名,必填,1-10位长度字符串| |anchor_name |主播姓名,必填,1-10位长度字符串|
行 96: 行 98:
 |live_source |视频采集方式,必填,范围["​1","​2"​] 1-系统,2-外置| |live_source |视频采集方式,必填,范围["​1","​2"​] 1-系统,2-外置|
 |room_type |直播间时效,​ 必填,范围["​1","​2"​] 1-临时,2-永久| |room_type |直播间时效,​ 必填,范围["​1","​2"​] 1-临时,2-永久|
-**响应格式举例(HTTP Body)**:+ 
 +**请求格式举例**
 <code php> <code php>
-Response Body+URLhttps://​live.rongkecloud.com/​lb/​openapi/​room/​create 
-+Request Header: 
-  "result": ​{ +        Content-Type:​application/​json;​charset=utf-8 
-    "room_id": "85100001+        Accept:​application/​json;​charset=utf-8 
-  }+Request Body: 
-  "errmsg": "SUCCESS", +        "token":"​tk142721863959707648",​ 
-  "errcode": ​0 +        "topic":"​mm", 
-}+        "​anchor_name":"​xiaozai"​
 +        "​anchor_pwd":"​111111", ​  
 +        ​"anchor_desc":"​我是 xiaozai", 
 +        "live_source": ​"​1",​ 
 +        "​room_type":"​1"​ 
 + }
 </​code>​ </​code>​
-**返回值说明:**+ 
 +**返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
 |result |返回相应的body体 | |result |返回相应的body体 |
行 114: 行 123:
 |errcode |返回的错误码,成功返回0 | |errcode |返回的错误码,成功返回0 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 120: 行 129:
 |1001 |参数定义或者格式错误| |1001 |参数定义或者格式错误|
 |1005 |token无效 | |1005 |token无效 |
 +
 +**响应格式举例**
 +<code php>
 +Response Body:{
 +         "​result":​ {
 +         "​room_id":​ "​85100001"​
 +        },
 +         "​errmsg":​ "​SUCCESS",​
 +         "​errcode":​ 0
 +}
 +</​code>​
 +
  
 ====修改直播间==== ====修改直播间====
 描述:在直播开始之前,修改直播间的任一属性,可以一次全部修改,也可以一次修改一项。 描述:在直播开始之前,修改直播间的任一属性,可以一次全部修改,也可以一次修改一项。
  
-**请求格式举例** +**请求地址** 
-<code php> +^ URL ^ 
-POST lb/​openapi/​room/​update HTTP/1.1 +|https://​live.rongkecloud.com/​lb/openapi/​room/​update |
-Host: https://​live.rongkecloud.com +
-Request Header:  +
-  Content-Type:​application/json;​charset=utf-8 +
-  Accept:​application/json;​charset=utf-8+
  
-{ +**请求方式** 
-  "​token":"​tk142721863959707648",​ +^ METHOD ^ 
-  "​roomid":​ "​100001",​ +|POST |
-  //​以下各项均为选填项,与上次比,有变化则填写,未变化则不填写; +
-  "​topic":"​mm",​ +
-  "​anchor_name":"​xiaozai",​ +
-  "​anchor_pwd":"​111111",​ +
-  "​anchor_desc":"​111111"​ +
-+
- +
-</​code>​+
  
 **请求头部** **请求头部**
行 150: 行 159:
  
 **请求参数** **请求参数**
-^Parameter ^Description ​+^Parameter ^Description ​^
 |token |用户身份校验凭证,必填,1-20位长度字符串 | |token |用户身份校验凭证,必填,1-20位长度字符串 |
 |roomid | 需要操作的直播间id,必填,字符串范围[1,​Long.maxvalue]| |roomid | 需要操作的直播间id,必填,字符串范围[1,​Long.maxvalue]|
行 157: 行 166:
 |anchor_pwd |主播密码,选填,6-20位长度字符串,数字字母组合 | |anchor_pwd |主播密码,选填,6-20位长度字符串,数字字母组合 |
 |achor_desc |主播简介,选填,1-500位长度字符串| |achor_desc |主播简介,选填,1-500位长度字符串|
- +**请求格式举例**
-**响应格式举例(HTTP Body)**:+
 <code php> <code php>
-Response Body+URL: https://​live.rongkecloud.com/​lb/​openapi/​room/​update 
-+Request Header:  
-  "errmsg": "SUCCESS", +        Content-Type:​application/​json;​charset=utf-8 
-  "errcode": ​0 +        Accept:​application/​json;​charset=utf-8 
-}+Request Body:
 +         ​"token":"​tk142721863959707648", 
 +         ​"roomid": ​"​100001",​ 
 +         //​以下各项均为选填项,与上次比,有变化则填写,未变化则不填写; 
 +         "​topic":"​mm",​ 
 +         "​anchor_name":"​xiaozai",​ 
 +         "​anchor_pwd":"​111111",​ 
 +         "​anchor_desc":"​111111"​ 
 +  ​} 
 </​code>​ </​code>​
-**返回值说明:**+ 
 +**返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
 |errmsg |返回的错误信息,成功返回Success | |errmsg |返回的错误信息,成功返回Success |
 |errcode |返回的错误码,成功返回0 | |errcode |返回的错误码,成功返回0 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 180: 行 198:
 |3012 |直播已开始 | |3012 |直播已开始 |
 |3014 |直播间无效 | |3014 |直播间无效 |
 +
 +**响应格式举例**
 +<code php>
 +Response Body:{
 +        "​errmsg":​ "​SUCCESS",​
 +        "​errcode":​ 0
 +}
 +</​code>​
 +
  
  
行 185: 行 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 ^
行 208: 行 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 |执行成功 |
行 229: 行 255:
 |3012 |直播已开始 | |3012 |直播已开始 |
 |3014 |直播间无效 | |3014 |直播间无效 |
 +
 +**响应格式举例**
 +<code php>
 +Response Body:{
 +        "​errmsg":​ "​SUCCESS",​
 +        "​errcode":​ 0
 +}
 +</​code>​
 +
  
  
行 234: 行 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 ^
行 257: 行 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",​ +</​code>​
-      "​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>​ +**返回值说明**
-**返回值说明:**+
 ^Parameter ^Description ^ ^Parameter ^Description ^
 |topic |直播主题 | |topic |直播主题 |
行 309: 行 320:
 |room_type | 直播间时效 | |room_type | 直播间时效 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 316: 行 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 ^
行 341: 行 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 ^
 |topic | 直播主题 | |topic | 直播主题 |
行 396: 行 412:
 |room_type | 直播间时效 | |room_type | 直播间时效 |
  
-**业务错误码**:+**业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
 |0 |执行成功 | |0 |执行成功 |
行 403: 行 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>​
 +
  
  
行 408: 行 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 ^
行 430: 行 474:
 **请求参数** **请求参数**
 ^Parameter ^Description ^ ^Parameter ^Description ^
-|token | 用户身份校验凭证,必填,1-20位长度字符串 |+|token | 用户身份校验凭证,必填,1-20位长度字符串
 +|roomid | 需要操作的直播间id,必填,字符串范围[1,​Long.maxvalue]| 
 +|type | 上传图片类型,必填, 范围["​1","​2"​] (1.背景图片,2.海报图片)| 
 +|file | 上传文件路径,支持jpg、jpeg、png格式,限制20M|
  
-**响应格式举例(HTTP Body)**:+**请求格式举例**
 <code php> <code php>
-Response Body+URLhttps://​live.rongkecloud.com/​lb/​openapi/​room/​image/​upload 
-+Request Headers:  
-  "​token":"​tk142721863959707648",​ +        Content-Type:​multipart/​form-data 
-  "​roomid":​ "​85100001"​ +        Accept:​application/​json;​charset=utf-8 
-  "​type":​ "​1",​ +Request Body: {  
-  "​file":​ "​本地文件路径"​ +        "​token":"​tk142721863959707648",​ 
- +        "​roomid":​ "​85100001"​ 
- +        "​type":​ "​1",​ 
- +        "​file":​ "​本地文件路径"​ 
- +  }
 </​code>​ </​code>​
-**请求参数**+ 
 +**返回值说明**
 ^Parameter ^Description ^ ^Parameter ^Description ^
-|token 用户身份校验凭证必填,1-20位长度字符串 ​+|errmsg ​|返回的错误信息成功返回Success ​
-|roomid ​需要操作直播间id必填,字符串范围[1,​Long.maxvalue] ​+|errcode ​|返回错误码成功返回0 ​
-|type | 上传图片类型,必填, 范围["​1","​2"​] (1.背景图片,2.海报图片) | +
-|file | 上传文件路径,支持jpg、jpeg、png格式,限制20M | +
-**响应格式举例(HTTP Body)** +
-<code php> +
-Response Body: +
-+
-"​errmsg":​ "​SUCCESS","​errcode":​ 0 +
-+
-</​code>​+
 **业务错误码** **业务错误码**
 ^错误码 ^含义 ^ ^错误码 ^含义 ^
行 467: 行 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 |
  
 **请求参数** **请求参数**
行 494: 行 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>​
  
 **请求结果说明** **请求结果说明**
行 531: 行 587:
 timestamp=1498100460959&​1bbd886460827015e5d605ed44252251 timestamp=1498100460959&​1bbd886460827015e5d605ed44252251
  
-**(注意)进行字典集排序的每个K-V参数进行连接的字符为&” **+**(注意)进行字典集排序的每个K-V参数进行连接的字符为&”**
  
 3.对排序后的字符串进行MD5(32)加密后生成的 3.对排序后的字符串进行MD5(32)加密后生成的