简要描述:

  • 获取直播室参会记录,按加入时间倒序

请求URL:

  • /zhibo/attendee/statistics?sessionId={sessionId} 获取直播室某场次参会记录
  • /zhibo/attendee/statistics?roomId={roomId} 获取直播室所有参会记录

HTTP请求方法:

  • GET

请求头:

NA

URL请求参数:

名称 类型 是否必须 描述
sessionId String 场次pid
roomId String 房间pid,roomId和sessionId必须任意提供一个
limit int 每页记录数. 默认值为20.
offset int 上一页最后一条记录号, offset必须是limit的倍数, 第一页为0. 当前页码可以通过offset/limit + 1来获得. 默认值为0.

请求体参数:

NA

返回参数说明:

返回200的成功的响应体:

参数名 类型 说明
datas[].userId String 参会人员Id
datas[].nickName String 昵称
datas[].joinTime String 参加时间
datas[].leaveTime String 离会时间
datas[].duration String 参会时长
datas[].clientDevice String 推流或观看客户端品牌类型
datas[].osVersion String 推流或观看客户端系统版本
datas[].appVersion String 推流或观看客户端版本号

示例:

请求:
GET https://api-zhibo.yxt.com/v1/zhibo/attendee/statistics?roomId=c4f0cb31-6b9f-44f0-86fc-00d231e436a5
Content-Type: application/json;charset=UTF-8
appkey: xxxxxxxxxxxxxxxxxxxxx
nonce: xxxx
timestamp: xxxxxxxxxx
signature: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
source: xxxx

请求体:
NA

正确时返回:
状态值: HTTP/1.1 200 OK.
Content-Type: application/json;charset=UTF-8

  1. {
  2. "datas": [
  3. {
  4. "userId": "05f5ae06-43f2-4c1d-8dfb-ca9fd1d23ebf",
  5. "nickName": "游客103948",
  6. "joinTime": "2017-03-15 17:32:14.0",
  7. "leaveTime": "2017-03-16 12:52:29.0",
  8. "clientDevice": "iPhone6s",
  9. "osVersion": "iOS 10.1.1.0",
  10. "appVersion": "SDK V1.1",
  11. "duration": "1s"
  12. },
  13. {
  14. "userId": "0d5ac1f9-a851-48a3-b538-1c0201109220",
  15. "nickName": "游客170296",
  16. "joinTime": "2017-03-15 17:31:19.0",
  17. "leaveTime": "2017-03-15 18:52:29.0",
  18. "clientDevice": "iPhone6s",
  19. "osVersion": "iOS 10.1.1.0",
  20. "appVersion": "SDK V1.1",
  21. "duration": "1s"
  22. },
  23. .......
  24. ],
  25. "paging": {
  26. "limit": 20,
  27. "offset": 0,
  28. "pages": 1,
  29. "count": 11
  30. }
  31. }

错误时返回:

状态值: HTTP/1.1 400 Bad Request

  1. {
  2. "error": {
  3. "key": "global.noprivilege",
  4. "message": "No privilege."
  5. }
  6. }

错误代码列表:

格式: key=状态码;message
apis.auth.client.status.invalid=400;Client Org status is invalid.
apis.zhibo.orgadmin.validation.service.expired=400;Service is not active.
apis.zhibo.room.validation.notExisted=404;Room is not existed.
apis.zhibo.gift.precent.validation.provideRoomIdOrSessionId=400;need provide roomId or sessonId.