調用DescribeEndPointEventList獲取端對端用戶事件列表。

使用說明

本接口用于獲取端對端用戶事件列表。例如：在事件列表中您可以獲取事件名稱、事件類型等信息。

QPS限制

本接口的單用戶QPS限制為10次/秒。超過限制，API調用會被限流，這可能會影響您的業務，請合理調用。更多信息，請參見QPS限制。

調試

您可以在OpenAPI Explorer中直接運行該接口，免去您計算簽名的困擾。運行成功后，OpenAPI Explorer可以自動生成SDK代碼示例。

請求頭

該接口使用公共請求頭，無特殊請求頭。請參見公共請求參數文檔。

請求語法

POST /api/call/describeEndPointEventList HTTP/1.1

請求參數

名稱 類型 位置 是否必選 示例值 描述
AppId String Query 是 9qb1****

App ID，可通過控制臺創建和查詢。
ChannelId String Query 是 311

頻道ID。
CreatedTs Long Query 是 1615887685

創建頻道時間，支持查詢最近30天的數據。使用UNIX時間戳表示，單位：秒。
DestroyedTs Long Query 否 1615888615

釋放頻道時間，使用UNIX時間戳表示，單位：秒。參數為空表示獲取當前時間。

說明 如果傳入的頻道釋放時間超過真實的釋放時間，將返回從創建時間開始到真實釋放時間之間的數據。
UserIdList String Query 是 c906531af5f9****

用戶ID列表，多個用英文逗號（,）分隔。

返回數據

名稱 類型 示例值 描述
Nodes Array of Nodes

用戶基本信息列表。
UserId String testuserid

用戶ID。
EventDataItems Array of EventDataItems

事件數據列表。
Ts Long 1615887685

第一個事件發生的時間，使用UNIX時間戳表示，單位：秒。
EventList Array of EventList

事件列表。
EventName String 開始發布

事件名稱。
EventType String USER

事件類型，取值：

  • USER：用戶事件。
  • SYSTEM：系統事件。
Ts Long 1615887686

事件發生的時間，使用UNIX時間戳表示，單位：秒。
RequestId String 3CFF4E0E-4F4D-49B6-B4C9-12C97E2F1ECD

請求ID。

示例

請求示例

POST api/call/describeEndPointEventList?AppId=9qb1****&ChannelId=311&UserIdList=c906531af5f9****&CreatedTs=1615887685&DestroyedTs=1615888615 HTTP/1.1 
Host: vdc.cn-shenzhen.aliyuncs.com 
Date: GMT Date

正常返回示例

XML格式 

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

<DescribeEndPointEventListResponse>
<code>200</code>
<data>
    <RequestId>3CFF4E0E-4F4D-49B6-B4C9-12C97E2F1ECD</RequestId>
    <Nodes>
        <UserId>c906531af5f92a78</UserId>
        <EventDataItems>
            <EventList>
                <EventType>USER</EventType>
                <EventName>開始發布</EventName>
                <Ts>1615887686</Ts>
            </EventList>
            <EventList>
                <EventType>USER</EventType>
                <EventName>加入房間成功</EventName>
                <Ts>1615887686</Ts>
            </EventList>
            <EventList>
                <EventType>USER</EventType>
                <EventName>訂閱流，來自User ID：8214cf2fe8ffbdd6 的音頻流</EventName>
                <Ts>1615887698</Ts>
            </EventList>
            <EventList>
                <EventType>USER</EventType>
                <EventName>重新訂閱流，來自User ID：8214cf2fe8ffbdd6 的音頻流</EventName>
                <Ts>1615887705</Ts>
            </EventList>
            <EventList>
                <EventType>USER</EventType>
                <EventName>重新訂閱流，來自User ID：8214cf2fe8ffbdd6 的音頻流</EventName>
                <Ts>1615887706</Ts>
            </EventList>
            <EventList>
                <EventType>USER</EventType>
                <EventName>取消訂閱流，發布端User ID：8214cf2fe8ffbdd6</EventName>
                <Ts>1615887707</Ts>
            </EventList>
            <Ts>1615887685</Ts>
        </EventDataItems>
        <EventDataItems>
            <EventList>
                <EventType>USER</EventType>
                <EventName>訂閱流，來自User ID：c052a4e5e96134e1 的音頻流</EventName>
                <Ts>1615887720</Ts>
            </EventList>
            <EventList>
                <EventType>USER</EventType>
                <EventName>取消訂閱流，發布端User ID：c052a4e5e96134e1</EventName>
                <Ts>1615887722</Ts>
            </EventList>
            <Ts>1615887710</Ts>
        </EventDataItems>
    </Nodes>
</data>
<httpStatusCode>200</httpStatusCode>
<requestId>3CFF4E0E-4F4D-49B6-B4C9-12C97E2F1ECD</requestId>
<successResponse>true</successResponse>
</DescribeEndPointEventListResponse>

JSON格式 

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

{
  "code" : "200",
  "data" : {
    "RequestId" : "3CFF4E0E-4F4D-49B6-B4C9-12C97E2F1ECD",
    "Nodes" : [ {
      "UserId" : "c906531af5f92a78",
      "EventDataItems" : [ {
        "EventList" : [ {
          "EventType" : "USER",
          "EventName" : "開始發布",
          "Ts" : 1615887686
        }, {
          "EventType" : "USER",
          "EventName" : "加入房間成功",
          "Ts" : 1615887686
        }, {
          "EventType" : "USER",
          "EventName" : "訂閱流，來自User ID：8214cf2fe8ffbdd6 的音頻流",
          "Ts" : 1615887698
        }, {
          "EventType" : "USER",
          "EventName" : "重新訂閱流，來自User ID：8214cf2fe8ffbdd6 的音頻流",
          "Ts" : 1615887705
        }, {
          "EventType" : "USER",
          "EventName" : "重新訂閱流，來自User ID：8214cf2fe8ffbdd6 的音頻流",
          "Ts" : 1615887706
        }, {
          "EventType" : "USER",
          "EventName" : "取消訂閱流，發布端User ID：8214cf2fe8ffbdd6",
          "Ts" : 1615887707
        } ],
        "Ts" : 1615887685
      }, {
        "EventList" : [ {
          "EventType" : "USER",
          "EventName" : "訂閱流，來自User ID：c052a4e5e96134e1 的音頻流",
          "Ts" : 1615887720
        }, {
          "EventType" : "USER",
          "EventName" : "取消訂閱流，發布端User ID：c052a4e5e96134e1",
          "Ts" : 1615887722
        } ],
        "Ts" : 1615887710
      } ]
    } ]
  },
  "httpStatusCode" : "200",
  "requestId" : "3CFF4E0E-4F4D-49B6-B4C9-12C97E2F1ECD",
  "successResponse" : true
}