1. 接口调用流程

Rest接入流程

2. 接口地址

提示:所有请求方式均为post请求

接口调用地址:

https://demoapi.livevip.com.cn/liveApi (正式上线时,需替换正式域名,详情请咨询客服)

调用接口时在后面加上接口名。如:

https://demoapi.livevip.com.cn/liveApi/CreateRoom

3. 授权认证

调用接口前需要从服务器上获得一个授权的token.根据调用接口的作用范围(scope)不同,有两种授权方式。
请注意调用接口的scope
第一种是使用后台管理账号授权,可用于scope为app的接口,大多用于房间管理,统计查询,等账户级管理接口
第二种是使用主播室口令授权可用于scope为room的接口,大多用于单个直播房间设置查询等

获取token接口:

https://xxx.com.cn/liveApi/AccessToken

Request Headers必需:

Content-Type:application/json //接口参数为json字符串

3.1 后台管理账号授权

{
    "scope": "app",
    "username":"ttttt",
    "password":"123456"
}

3.2 主播室口令授权

有两种方式,分别为roomId和roomKey。其中account是方便用户账号与直播权限对接,如果为空,系统自动生成唯一的随机账号
注意:如果用同一账号生成的token登陆系统会互踢。
password为创建主播室时的三个密码,使用不同的密码,生成的token权限是不一样的。
通过使用主播密码生成的token,具有主播的权限,可以用于房间管理等接口。
通过使用助理密码生成的token,具有助理的权限,在web浏览器端可以进行观看和回复
通过使用观看密码生成的token,具有观看的权限,适用于获取后,在Web SDK中调用,用于集成网页观看

3.2.1 roomId方式

{
    "scope": "room",
    "roomId":111111, //聊天室ID
    "password":"123456",//密码,请注意:通过不同密码生成的权限不同。
    "secretKey":"", //密钥,并非AccessSecret。参见下方备注
    "nickName":"张三",
    "account":"" //用户账号,可为空
}

备注:

  secretKey生成方式为md5 32位小写 (roomId+password+accessSecret)  
  password为主播室密码  
  accessSecret为用户唯一key

3.2.2 roomKey方式

{
    "scope": "room",
    "roomKey":"111111@gotye", //聊天室key,请参考下方备注
    "password":"123456",
    "nickName":"张三",
    "account":"" //用户账号,可为空
}

备注:

roomKey格式为: {thirdRoomId+'@'+companyEnId}
thirdRoomId为创建直播室时用户指定的第三方roomId.可以为空。
        为空时不能使用此接口获取token.
companyEnId为公司唯一英文标示,可以在后台控制面板获取到相应值,或者通过GetAppUser接口获取

授权调用返回

{
    "accessPath": "AccessToken",
    "runtime": 4,
  "  systime": 1470640802588,
    "status": 200, //状态码,200为成功
    "expiresIn": 86400, //有效时间,单位(秒)
    "accessToken": "9f9b152ac1936cb53d02297ff0ec18e1" //返回的token
    "role": 2 //角色; 1-后台用户 2-主播端 3-助理 4-观看端
}

API调用接口演示

对此,亲加还提供了java的演示代码,供集成使用。

4. 接口调用

调用接口,服务器端会验证token是否合法。

Request Headers必需:

Accept:application/json //接口返回json字符串
Content-Type:application/json //接口参数为json字符串
Authorization:9f9b152ac1936cb53d02297ff0ec18e1 //验证token

通用调用参数:

index // 索引/起始位置, 默认0
count // 数量, 默认10,最大100

通用返回值:

accessPath //访问接口路径
runtime //接口执行时间
systime //服务器调用时间戳
affectedRows //受影响的行,一般添加或修改时会返回
status //状态码
errorDesc //错误详细信息

5. 账户管理

5.1获取账户信息

调用此接口获取账户信息

接口名称:GetAppUser

认证token scope:app

调用方式:POST

调用参数:

{}

调用返回:

{
  "accessPath": "GetAppUser",
  "runtime": 6,
  "systime": 1445242713495,
  "status": 200,
  "entity": {
    "userId": 7, //用户id
    "userEmail": "coco@163.com", // 用户email,相当于用户名
    "createDate": null, // 创建用户日期
    "companyName": "Gotye001", // 用户公司名称
    "postCode": "201210", // 邮政编码
    "address": "閘北區萬榮路700號", // 用户地址
    "contactPerson": "san.zhang", // 联系人
    "telephone": "021-11111111", // 联系电话
    "companyEnId": "Gotye7" // 唯一标识公司英文名,可用于roomKey方式获取token
    "checkStatus": 1//内部参数,可忽略
  }
}

5.2 修改账户信息

调用此接口修改账户信息

接口名称:ModifyAppUser

认证token scope:app

调用方式:POST

调用参数:

{
  "companyName": "Gotye001",
  "postCode": "201210",
  "address": "閘北區萬榮路700號",
  "contactPerson": "san.zhang",
  "telephone": "021-11111111"
}

调用返回:

{
  "accessPath": "ModifyAppUser",
  "runtime": 110,
  "systime": 1445244950057,
  "status": 200,
  "affectedRows": 1
}

5.3 获取客户端下载地址

调用此接口获取客户端下载地址

接口名称:GetClientSdk

认证token scope:room/app

调用方式:POST

调用参数:

{}

调用返回:

{
  "accessPath": "GetClientSdk",
  "runtime": 5,
  "systime": 1445247691014,
  "status": 200,
  "entity": {
    "userId": 7, //用户id
    "publishWinVersion": 59, // 客户端版本号
    "publishWinDownUrl": "" // 客户端下载地址,如"http://live.gotye.com.cn"
    "publishConfig": "" // 客户端配置
  }
}

6. 主播室管理

6.1 新建主播室

调用此接口新建一个主播室 请注意:主播,助理,用户登陆密码必须互不相同,否则房间将会创建失败

接口名称:CreateRoom

认证token scope:app

调用方式:POST/GET

调用参数:

{
  "roomName": "aaa主播室",//主播室名称
  "anchorPwd": "000000",//主播登录密码
  "assistPwd": "111111",//助理登录密码
  "userPwd": "222222",//用户登录密码
  "anchorDesc": "just test",//主播描述
  "contentDesc": "今天我们来讲讲骑行西藏是一种怎样的体验",//内容描述
  "thirdRoomId": "55555",//第三方房间号,可用于传入客户系统自带房间号或其他唯一标示,不可重复,否则将会失败
  "creator":"张三",//创建者
  "maxOnlineNum":200,//允许在线人数,0或不传表示无限制
  "firstIndustry":"金融",//大范围行业,如金融
  "secondIndustry":"银行"//小范围行业,如银行
}

调用返回:

{
  "accessPath": "CreateRoom",
  "runtime": 116,
  "systime": 1445235210656,
  "status": 200,
  "entity": {
    "roomId": 858587,//房间id
    "appUserId": 7,//用户id
    "roomName": "aaa主播室",
    "anchorPwd": "000000",
    "userPwd": "222222",
    "assistPwd": "111111",
    "anchorDesc": "just test",//主播简介
    "contentDesc": "今天我们来讲讲骑行西藏是一种怎样的体验",//内容简介
    "dateCreate": 1445235210660,//创建时间
    "thirdRoomId": "55555",
    "creator":"张三",//创建者
    "maxOnlineNum":200,//允许在线人数
    "firstIndustry":"金融",//大范围行业,如金融
    "secondIndustry":"银行"//小范围行业,如银行,
  }
}

6.2 删除主播室

调用此接口删除主播室

接口名称:DelRoom

认证token scope:app

调用方式:POST/GET

调用参数:

{
  "roomId": 858588 // 必填参数,主播室id
}

调用返回:

{
  "accessPath": "DelRoom",
  "runtime": 115,
  "systime": 1445236534336,
  "status": 200,
  "affectedRows": 1
}

6.3 查询主播室列表

调用此接口查询主播室列表

接口名称:GetRooms

认证token scope:app

调用方式:POST/GET

调用参数: 如果有不需要使用的查询条件,请勿传入该参数。请仅传入需要的搜索条件

{
  "startDate": 1445307593635,
  "endDate": 1445307594916,
  "searchRoomId": 10023, //查询条件,房间id
  "roomName":"aaa主播室", //查询条件,房间名
  "creator":"李四", //查询条件,创建者
  "type":0, //查询类型,0-未删除 1-全部(包含未删除和已经删除的) 2-直播中 3-已删除,默认0
  "index": 0,
  "count": 10
}

说明:startDate、endDate指定主播室生成时间段,这两个字段中任意字段都可为空。

调用返回:

{
  "accessPath": "GetRooms",
  "runtime": 11,
  "systime": 1445307594940,
  "total": 100,
  "status": 200,
  "entities": [
    {
      "roomId": 858597,//房间号
      "roomKey": "e12c5199de3d49d2866918181aecc83e",
      "appUserId": 7,
      "roomName": "aaa主播室",
      "anchorPwd": "000000",
      "userPwd": "222222",
      "assistPwd": "111111",
      "dateCreate": 1445307593000,//创建时间,单位毫秒
      "thirdRoomId": null, //三方id
      "creator":"张三",//创建者
      "onlineNum": 150,//当前在线人数
      "maxOnlineNum":200,//允许在线人数,0或null表示无限制
      "firstIndustry":"金融",//大范围行业,如金融
      "secondIndustry":"银行",//小范围行业,如银行
      "status":0 //房间状态,0-正常 1-已删除 2-正在直播
    }
  ]
}

6.4 编辑主播室

调用此接口编辑主播室 roomID为必填参数,其他参数如果不填,将会保持原有参数

接口名称:ModifyRoom

认证token scope:app

调用方式:POST/GET

调用参数:

{
    "roomId": 100041, //必须参数
    "roomName": "",//房间名称
    "startPlayTime": 1441957077872,//开始直播时间,单位:毫秒
    "stopPlayTime":1441957077900,//结束直播时间,单位:毫秒
    "anchorPwd": "",//主播密码
    "assistPwd": "",//助教密码
    "userPwd": "",//观看端密码
    "anchorDesc": "",//主播介绍
    "contentDesc": ""//直播内容介绍
    "maxOnlineNum":200, //允许在线人数
        "firstIndustry":"娱乐",//房间类型,大范围类型,如娱乐
        "secondIndustry":"游戏", //房间类型,小范围类型,如游戏
        "creator":"李四"//创建人
}

调用返回:

{
    "accessPath": "/ModifyRoom",
    "runtime": 37,
    "systime": 1422265871895,
    "status": 200,
    "affectedRows":1//更改生效的房间数,为1
}

6.5 查询主播室

调用此接口根据roomId查询某个主播室

接口名称:GetRoom

认证token scope:app

调用方式:POST/GET

调用参数:

{
  "roomId": 858588 //主播室ID
}

调用返回:

{
  "accessPath": "GetRoom",
  "runtime": 9,
  "systime": 1445236532130,
  "status": 200,
  "entity": {
    "roomId": 858588,
    "appUserId": 7,
    "roomName": "aaa主播室",
    "anchorDesc": "just test",
    "contentDesc": "今天我们来讲讲骑行西藏是一种怎样的体验",
    "dateCreate": 1445236531000,
    "thirdRoomId": "55555",
    "creator":"张三",//创建者
    "maxOnlineNum":200,//允许在线人数
    "firstIndustry":"金融",//大范围行业,如金融
        "secondIndustry":"银行" //小范围行业,如银行
  }
}

6.6 生成客户端地址

调用此接口生成客户端播放地址 通过本接口可以获取到相应的直播观看,PC主播发起地址等,可以集成至自有的Web页面或者后台中 建议通过Room级别的token调用该接口
接口名称:GetClientUrls

认证token scope:room/app

调用方式:POST/GET

调用参数:

{
   "roomId":111, // scope为app时。此参数必须
}

调用返回:

{
  "accessPath": "GetClientUrls",
  "runtime": 4,
  "systime": 1445252574332,
  "status": 200,
  "entity": {
    "modChatUrl": "", // H5聊天室地址,该地址包含有一个完整的聊天界面,可以嵌入相应的iframe中用于聊天
    "educVisitorUrl": "", // 直播观看地址,该地址会自动生成一个完整观看页面。该页面PC和手机端均可观看
    "pcLivePublisherUrl":"" //pc直播主播端地址,可以通过该链接,直接进入网页发起端
    "modPublisherShareUrl": ""//课件分享页面,可以将该地址嵌入相应的iframe中,用于进行课件的播放和展示。(注:该参数为使用主播密码获取到room级别的token才会有)
       “modVisitorShareUrl":""//课件观看端地址。(注:该参数为使用观看密码获取到的 room级别的token才会有)
  }
}

注:modeChatUrl格式{CLIENT_URL}/chat/index.html?token={authorization} educVisitorUrl格式{CLIENTURL}/educOnline/{LIVEROLE.visitor}/{key}/enter 其中LIVE_ROLE.visitor是观看端角色名称,key由观看端角色、用户ID、主播室ID唯一确定。

6.7 查询直播上下文

调用此接口得到直播上下文信息

接口名称:GetLiveContext

认证token scope:room/app

调用方式:POST/GET

调用参数:

{
  "roomId":111, // scope为app时。此参数必须
}

调用返回:

{
  "accessPath": "GetLiveContext",
  "runtime": 8,
  "systime": 1445242713788,
  "status": 200,
  "entity": {
    "recordingStatus": 0, // 1-直播中 0-无直播
    "playUserCount": 0, // 当前播放视频人数
    "virPlayUserCount": 0//虚拟人数
    "stopType": 1//停止推流原因  //0-异常断开 1-主动停流 2-手机来电
  }
}

6.8 批量查询直播信息

接口名称:GetRoomsLiveInfo

认证token scope:app

调用方式:POST/GET

调用参数:

{
    "roomIds":[1111,222222]//数组内为需要查询的房间号列表,数字格式的数组
}

调用返回:

{
    "accessPath": "GetRoomsLiveInfo",
    "runtime": 23,
    "systime": 1460529124308,
    "status": 200,
    "entities": [{
    "roomId": 1111,
    "playUserCount": 0, /观看端人数
    "streamStatus": 0, //1-推流中 0-停止
    "playRtmpUrls": ["rtmp://live.gotye.com.cn/live/1111"],//rtmp拉流地址
    "playHlsUrls": ["http://liveplayerm3u8.livevip.com.cn/live/1111"],//hls拉流地址
    "playFlvUrls": ["http://liveplayerflv.livevip.com.cn/live/1111"]//flv拉流地址
    }]
}

6.9 编辑主播室配置

调用此接口编辑主播室。注意,此只有后台管理员与主播权限才能调用
接口名称:SetRoomConfig

认证token scope:app/room

调用方式:POST/GET

调用参数:

{
    "roomId": 100041, //必须
    "roomCoverPicFile": "", //房间封面图片base64之后string,或者直接表单上传
    "realOnlineMulti":2.0 //房间在线人数倍率,倍率越大,增长越快,建议设置为1~3
}

说明:虚拟在线人数 ≈ 倍率实际人数ln(实际人数)
调用返回:

{
    "accessPath": "/SetRoomConfig",
    "runtime": 37,
    "systime": 1422265871895,
    "status": 200,
    "affectedRows":1
}

6.10 查询主播室配置

查询主播室配置,注意,此接口中其它属性不开放不维护,不能使用。
接口名称:GetRoomConfig

认证token scope:app/room

调用方式:POST/GET

调用参数:

{
    "roomId": 100041, //必须
}

调用返回:

{
    "accessPath": "GetRoomConfig",
    "runtime": 7,
    "systime": 1463125247024,
    "status": 200,
    "entity": {
      "roomId": 101695,
      "roomCoverPicUrl": "", //房间封面下载地址
      "themeType":1, //主题类型,1-默认 2-主题1...
      "clarity": 1, //清晰度,1-标清 2-高清 3-超清, 默认1
      "realOnlineMulti":1.0 //在线人数倍率,人数详细说明见SetRoomConfig()接口
    }

}

7. 录播管理

7.1 保存录播信息

调用此接口设置录播的开始时间、结束时间。备注:必须在录制结束后调用

接口名称:SetRecordingTime

认证token scope:app/room

调用方式:POST/Get

调用参数:

{
  "roomId": 100002, // app认证时必须
  "timeError": 60, //误差时间范围,单位秒,默认为:(endDate-startDate)/10/1000
  "startDate": 1447043464367, // 开始录制时间, 单位:毫秒
  "endDate": 1447043644367 //结束录制时间, 单位:毫秒
}

调用返回

{
  "accessPath": "SetRecordingTime",
  "runtime": 31,
  "systime": 1447043705520,
  "status": 200
}

说明:
正确设置直播时间可以有效加速视频生成
总时长(t_all) = (endDate-startDate)/1000
设置时长(t_set) = t_all-timeError,t_set不能为0(即timeError不得大于或等于设置的时间差值)
实际直播时间(t_pub) = 主播端推流时间,此时间段在startDate与endDate之间
最小有郊时间(t_min) = t_all*9/10
1.必须在录制结束后才能调用
2.每次调用,系统会记录录播结束时间,下次调用开始时间不能在此之前
3.t_pub>=t_set,马上合成。例:直播9分钟,设置10,马上合成(实际直播时间大于设置时长,则立即合成)
4.t_pubt_min,合成挂起,1小时后强制合成 (实际直播时长略小于设置时长,则需要等待1小时后强制合成)
5.t_pub < t_min。例:直播5分钟,设置1小时,5<(60/10),则3小时后强制合成(实际直播时长小于设置时长的10分之1,则3小时后强制合成)

7.2 删除录播

调用此接口删除录播

接口名称:DelRecoding

认证token scope:app

调用方式:POST

调用参数:

{
  "recordingId":7//录播ID,可以通过获取录播列表以及录播信息获取到
}

调用返回:

{
    "accessPath": "/DelRecoding",
    "runtime": 60,
    "systime": 1420515592022,
    "status": 200,
    "affectedRows": 1
}

7.3 编辑录播信息

调用此接口编辑录播信息

接口名称:EditRecording

认证token scope:app

调用方式:POST

调用参数:

{
  "recordingName": "JunitTestRecName",//录播视频名称
  "recordingId": 7,//录播ID,可以通过获取录播列表GetRecordings以及录播信息GetRecording获取到
  "anchorDesc": "JunitAnchorDesc",
  "contentDesc": "JunitTestDesc",
  "enableProtectFlag": 1,
  "protectPwd": "121212"
}

调用返回:

{
  "accessPath": "EditRecording",
  "runtime": 123,
  "systime": 1445241398655,
  "status": 200,
  "affectedRows": 1
}

7.4 录播列表获取

调用此接口获录播列表,下载地址每次会重新生成,有效时间半小时。

接口名称:GetRecordings

认证token scope:app

调用方式:POST

调用参数:

{
  "roomId": 8686, // 主播室id
  "index": 0, // 查询起始位置
  "count": 10 // 查询个数
}

调用返回:

{
  "accessPath": "GetRecordings",
  "runtime": 7,
  "systime": 1445239894242,
  "status": 200,
  "total":10,
  "entities": [
    {
      "recordingName": "测试主播室",//录播视频名称
      "downUrl": "",//视频下载地址
      "recordingShareUrl":"", //分享地址
      "recordingId": 7,//录播id
      "roomId": 8686,//直播室id
      "startRecordTime": 1445239894242,//视频创建时间,毫秒为单位
      "recStarTime": 1445239894200,//录制开始时间,毫秒为单位
      "recEndTime": 1445239894250,//录制结束时间,毫秒为单位
      "duration": 40,//时长,单位:分钟
      "size": 17042,//视频大小,单位:KB
      "recFirstFrameUrl": ""//录制视频第一帧图片地址
    }
  ]
}

7.5 获取录播信息

调用此接口获取录播视频信息

接口名称:GetRecording

认证token scope:app

调用方式:POST

调用参数:

{
  "recordingId": 7 //录播id
}

调用返回:

{
  "accessPath": "GetRecording",
  "runtime": 9,
  "systime": 1445240718704,
  "status": 200,
  "entity": {
    "recordingName": "测试主播室",//录制名称
    "fileName": null,//视频文件的名称
    "downUrl": "",//下载地址
    "m3u8Url": "",//m3u8地址,后台配置转码且加速完成才会返回该属性
    "anchorDesc": null,//录制视频对应直播室的主播介绍
    "contentDesc": null,//录制视频内容介绍
    "roomId": null,//直播室id
    "startRecordTime": 14452407187600,//视频创建时间,毫秒为单位
    "recFirstFrameUrl": "",//录制视频第一帧图片地址
        "recStartTime": 1470046019000,// 开始录制时间,单位:毫秒
        "recEndTime": 1470046165000, //结束录制时间,单位:毫秒
    "duration": 3, //时长,单位:分钟
    "size": 7058//视频大小,单位:KB
  }
}

8. 统计管理

8.1 获取流量和带宽日统计结果

接口名称:GetBaseStati

认证token scope:app

调用方式:POST

调用参数:

{
  "stDate": "2016-04-01", // 格式'yyyy-MM-dd'
  "edDate": "2016-04-02" // 格式'yyyy-MM-dd'
}

说明:stDate、edDate指定统计时间的范围,stDate和edDate可以相同

调用返回:

{
  "accessPath": "GetBaseStati",
  "runtime": 34,
  "systime": 1445328292521,
  "status": 200,
  "entities": [
    {
      "date": "2015-10-12", // 统计日期
      "useFlux": 2310.0, // 使用流量
      "maxBandwidth": 660 // 最大带宽
    }
  ]
}

8.2 获取带宽实时统计结果

接口名称:GetBandwidthStati

认证token scope:app

调用方式:POST

调用参数:

{
  "stDate": "2016-03-25",//开始时间,格式'yyyy-MM-dd'
  "edDate": "2016-03-25"//截止时间,格式'yyyy-MM-dd'
}

说明:stDate和edDate可以相同,会返回stDate当天数据

调用返回:

{
  "accessPath": "GetBandwidthStati",
  "runtime": 42,
  "systime": 1458876155275,
  "status": 200,
  "entity": {
    "appUserId": 18,
    "values": [
      129,
      4096,
      232
    ],//带宽值列表,单位Kbps
    "beginTime": "2016-03-25 00:00",//格式:'yyyy-MM-dd HH:mm'
    "endTime": "2016-03-25 11:10"//格式:'yyyy-MM-dd HH:mm'
  }
}

说明:values的第一个值对应的时间是beginTime,每2个点的时间间隔是10min,最后一个值对应的时间是endTime。

8.3 获取在线人数统计结果

接口名称:GetPlayUserStati

认证token scope:app/room

调用方式:POST

调用参数:

{
  "roomId":1227,//房间id
  "stDate": "2016-03-24",//开始时间,格式"yyyy-MM-dd"
  "edDate": "2016-03-24",//截止时间,格式"yyyy-MM-dd"
  "type": 1 //返回数据时间间隔类型,1-5分钟 2-10分钟,不传该参数时默认为1分钟
}

说明:stDate和edDate可以相同,会返回stDate当天数据,roomId为空会返回用户级别的统计结果,否则返回主播室的统计结果最多返回7天数据,如果edDate和stDate的时间间隔大于7天,则返回从stDate开始连续7天的数据。

调用返回:

{
  "accessPath": "GetPlayUserStati",
  "runtime": 15,
  "systime": 1458809397083,
  "status": 200,
  "entity": {
      "beginTime": "2016-03-24 00:00", //格式:"yyyy-MM-dd HH:mm"
      "endTime": "2016-03-24 16:45", //格式:"yyyy-MM-dd HH:mm"
      "interval": 5, //onlineNumList中数据时间间隔,单位:min
      "onlineNumList": [
      0,
      0,
      0
  ]// 人数列表
}

说明:onlineNumList的第一个值对应的时间是beginTime,每2个点的时间间隔是interval,最后一个值对应的时间是endTime。

8.4 获取按天人数统计结果

接口名称:GetPlayUserDayStati

认证token scope:app

调用方式:POST/GET

调用参数:

{
  "roomId": 10010,// 房间id,为空时返回用户级别的数据
  "stDate": "2016-04-10",// 开始时间,格式"yyyy-MM-dd"
  "edDate": "2016-04-15" // 截止时间,格式"yyyy-MM-dd"
}

说明:返回结果包含stDate的数据,stDate和edDate可以相同。

调用返回:

{
  "accessPath": "GetPlayUserDayStati",
  "runtime": 5,
  "systime": 1460718676465,
  "status": 200,
  "entities": [
      {
          "statiDate": "2016-04-10", // 日期
          "value": 4875 // 人数
      }
  ]
}

8.5 获取按月人数统计结果

接口名称:GetPlayUserMonthStati

认证token scope:app

调用方式:POST/GET

调用参数:

{
  "roomId": 10010,// 房间id,为空时返回用户级别的数据
  "stMonth": "2016-03",// 开始时间,格式"yyyy-MM"
  "edMonth": "2016-04" // 截止时间,格式"yyyy-MM"
}

说明:返回结果包含edMonth的数据,stMonth和edMonth可以相同,返回结果不包括当前月的数据。

调用返回:

{
 "accessPath": "GetPlayUserMonthStati",
 "runtime": 9,
 "systime": 1460719102033,
 "status": 200,
 "entities": [
     {
         "month": "2016-03", // 月份
         "value": 1000 // 人数
     }
 ]
}

9. 监控管理

9.1 后台消息发送

接口名称:SendMsg(该接口可用于服务端给客户端发送系统消息公告)

认证token scope:room

调用方式:POST

调用参数:

    {
      "server": "chat", //服务器,// chat stati share ,默认chat
      "sender": "admin", //发送者账号
      "recvId":"", //接收者账号,如果为空,发送到聊天室所有人
      "type": 1, //消息type,1-文本信息 3-通知
      "text": "", //消息内容
      "extra":"" //附加内容
    }

调用返回:

    {
      "accessPath": "SendMsg",
      "runtime": 14,
      "systime": 1456474044901,
      "status": 200
    }

9.2 控制直播室流状态

接口名称:SetRoomStreamStatus(调用此接口控制直播室流状态)

认证token scope:app/room

调用方式:POST

调用参数:

    {
      "roomId": 100023, //房间id
      "action": 0 //0-禁流,1-恢复
    }

调用返回:

    {
      "accessPath": "SetRoomStreamStatus",
      "runtime": 14,
      "systime": 1456474044901,
      "status": 200
    }

10. 接口状态码

--> 5003 视频已经上传过
状态码状态描述
系统
200调用成功
401认证失败.无效的token
500系统处理异常
411无效许可
417接口超过每天room最大访问次数
419接口超过每天app最大访问次数
420没有权限访问此资源
录播相关接口
1001无效的录播id
1003无效的录播时间,三天前的录播不能生成
1005无效的开始录播时间,开始时间不能在最后一次调用时间之前
主播室相关接口
2001无效的主播室ID
2002主播室不存在
2003room password 重复
2004room password 非法
2005roomName非法
2007聊天室id为空
2008thirdRoomId已存在
2009 人数已满
20010 控制房间流状态失败
20011 房间数超过上限,用户没有认证时会有该限制
20013 没有直播回看
appUser相关接口
3001用户账户已过期
3003暂停服务
3004 appkey不存在
3005 旧密码错误,修改密码时要做旧密码验证
3006 域名没有cname,自有域名绑定时要检查域名是否cname
附件相关接口
4001附件重复
点播视频状态
5001点播视频后缀不正确
5002点播视频上传失败
主播室配置相关接口
8001 图片上传失败
8003 房间分享图片上传失败
8005 房间封面图片上传失败
8007 主播室水印图片上传失败
直播记录
9001 直播记录id为空
9002 无效的直播记录id
统计接口
13001 时间格式错误
记录导出(观看、聊天记录)
14001 导出文件上传文件服务器失败
14002 导出文件生成中
礼品相关接口
15001 上传礼品图片失败
15002 无效的礼品id
15002 删除礼品图片失败
返回顶部