调用GetRoomStatistics获取房间的人数统计信息,包括在线人数、历史PV和历史UV。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

请求参数

名称 类型 是否必选 示例值 描述
Action String GetRoomStatistics

系统规定参数。取值:GetRoomStatistics

Request Object

请求参数的结构体。

Domain String 7m***q

应用的appKey。

RoomId String 9645**c180a1

房间ID,由调用CreateRoom时返回。

返回数据

名称 类型 示例值 描述
RequestId String FE22D613-D3C6-4A58-87CA-F21FC85AA08E

请求ID。

ResponseSuccess Boolean true

请求是否成功。

ErrorCode String 1000

错误码,请求异常时返回。

ErrorMessage String internal error

错误信息,请求异常时返回。

Result Object

请求的返回结果。

OnlineCount Integer 100

当前房间的在线用户数。

UV Integer 100

当前房间的历史用户访问数目(UV)。

PV Integer 100

当前房间的历史访问数目(PV)。

示例

请求示例

http(s)://[Endpoint]/?Action=GetRoomStatistics
&Request={"Domain":"7m***q","RoomId":"9645**c180a1"}
&公共请求参数

正常返回示例

XML格式

HTTP/1.1 200 OK
Content-Type:application/xml

<GetRoomStatisticsResponse>
    <RequestId>FE22D613-D3C6-4A58-87CA-F21FC85AA08E</RequestId>
    <ResponseSuccess>true</ResponseSuccess>
    <Result>
        <OnlineCount>100</OnlineCount>
        <UV>100</UV>
        <PV>100</PV>
    </Result>
</GetRoomStatisticsResponse>

JSON格式

HTTP/1.1 200 OK
Content-Type:application/json

{
  "RequestId" : "FE22D613-D3C6-4A58-87CA-F21FC85AA08E",
  "ResponseSuccess" : true,
  "Result" : {
    "OnlineCount" : 100,
    "UV" : 100,
    "PV" : 100
  }
}

错误码

访问错误中心查看更多错误码。