临境直播开发者接入指南

简要描述：

获取直播室参会签到统计明细，按加入时间倒序

请求URL:

/zhibo/attendee/sign/statistics?roomId={roomId} 获取直播室参会签到明细
/zhibo/attendee/sign/statistics?session={sessionId} 获取直播场次参会签到明细

HTTP请求方法：

请求头：

URL请求参数:

名称	类型	是否必须	描述
roomId	String	是	直播间主键pid
limit	int	否	每页记录数. 默认值为20.
offset	int	否	上一页最后一条记录号, offset必须是limit的倍数, 第一页为0. 当前页码可以通过offset/limit + 1来获得. 默认值为0.

请求体参数:

返回参数说明:

返回200的成功的响应体:

参数名	类型	说明
datas[].userId	String	参会人员Id
datas[].nickName	String	昵称
datas[].joinTime	String	参加时间
datas[].leaveTime	String	离会时间
datas[].duration	String	参会时长(格式：xHxmxs， x是数字，H-小时，m-分钟，s-秒)
datas[].clientDevice	String	推流或观看客户端品牌类型
datas[].osVersion	String	推流或观看客户端系统版本
datas[].appVersion	String	推流或观看客户端版本号
datas[].firstSignTime	String	首次签到时间
datas[].lastSignTime	String	最后一次签到时间
datas[].factSign	String	用户签到次数合计
datas[].countSign	String	发起签到次数合计

示例:

请求:
GET https://api-zhibo.yxt.com/v1/zhibo/attendee/sign/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

{
    "datas": [
        {
            "userId": "00849c9d-02a9-4007-bab8-4215cdbb1e94",
            "nickName": "游客364244",
            "joinTime": "2017-03-24 14:01:07.0",
            "leaveTime": "2017-03-24 14:01:07.0",
            "clientDevice": "",
            "osVersion": "111",
            "appVersion": "22",
            "duration": "1H2m23s",
            "firstSignTime": "2017-05-11 16:19:35.0",
            "lastSignTime": "2017-05-12 09:33:50.0",
            "factSign": "3",
            "countSign": "180"
        },
        {
            "userId": "010af816-a922-49bf-8e7c-1180cb5bbf6e",
            "nickName": "游客636992",
            "joinTime": "2017-03-14 20:56:55.0",
            "leaveTime": "2017-03-14 20:56:55.0",
            "clientDevice": "",
            "osVersion": "",
            "appVersion": "",
            "duration": "0s",
            "firstSignTime": null,
            "lastSignTime": null,
            "factSign": "0",
            "countSign": "180"
        },
      .......
    ],
    "paging": {
        "limit": 20,
        "offset": 0,
        "pages": 1,
        "count": 11
    }
}

错误时返回:

状态值: HTTP/1.1 400 Bad Request

{
  "error": {
    "key": "global.noprivilege",
    "message": "No privilege."
  }
}

错误代码列表:

格式: 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.

修改历史

2018-02-12 增加按场次查询参会签到明细的url

获取直播室参会签到统计明细