DescribeAbnormalEvent

Last updated: 2021-04-28 11:10:00

1. API Description

Domain name for API request: trtc.tencentcloudapi.com.

This API is used to query exception occurrences under a specified SDKAppID and return the exception IDs and possible causes. It queries data in last 15 days, and the query period is up to 1 hour, which can start and end on different days. For more information about exceptions, please see the exception event ID mapping table: https://intl.cloud.tencent.com/document/product/647/37906.

A maximum of 1 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.

Parameter Name Required Type Description
Action Yes String Common parameter. The value used for this API: DescribeAbnormalEvent.
Version Yes String Common parameter. The value used for this API: 2019-07-22.
Region Yes String Common parameter. For more information, please see the list of regions supported by the product.
SdkAppId Yes String User SDKAppID, which can be used to query 20 exceptional experience events (in one or more rooms)
StartTime Yes Integer Query start time
EndTime Yes Integer Query end time
RoomId No String Room ID, which can be used to query up to 20 exceptional experience events in a specific room

3. Output Parameters

Parameter Name Type Description
Total Integer Number of returned data entries.
AbnormalExperienceList Array of AbnormalExperience Exceptional experience list.
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Querying exceptions

Input Example

https://trtc.tencentcloudapi.com/?Action=DescribeAbnormalEvent
&SdkAppId=1400188366
&StartTime=1592448600
&EndTime=1592449080
&RoomId=461
&<Common request parameters>

Output Example

{
  "Response": {
    "AbnormalExperienceList": [
      {
        "UserId": "itachi3",
        "RoomId": "461",
        "EventTime": 1592448600,
        "ExperienceId": 4,
        "AbnormalEventList": [
          {
            "AbnormalEventId": 2011,
            "PeerId": ""
          },
          {
            "AbnormalEventId": 2012,
            "PeerId": ""
          }
        ]
      },
      {
        "UserId": "itachili1",
        "RoomId": "461",
        "EventTime": 1592448600,
        "ExperienceId": 4,
        "AbnormalEventList": [
          {
            "AbnormalEventId": 2011,
            "PeerId": ""
          },
          {
            "AbnormalEventId": 2012,
            "PeerId": ""
          }
        ]
      },
      {
        "UserId": "itachi3",
        "RoomId": "461",
        "EventTime": 1592448660,
        "ExperienceId": 4,
        "AbnormalEventList": [
          {
            "AbnormalEventId": 2011,
            "PeerId": ""
          },
          {
            "AbnormalEventId": 2012,
            "PeerId": ""
          }
        ]
      },
      {
        "UserId": "itachi3",
        "RoomId": "461",
        "EventTime": 1592448720,
        "ExperienceId": 4,
        "AbnormalEventList": [
          {
            "AbnormalEventId": 2011,
            "PeerId": ""
          },
          {
            "AbnormalEventId": 2012,
            "PeerId": ""
          }
        ]
      },
      {
        "UserId": "itachi3",
        "RoomId": "461",
        "EventTime": 1592448780,
        "ExperienceId": 4,
        "AbnormalEventList": [
          {
            "AbnormalEventId": 2011,
            "PeerId": ""
          },
          {
            "AbnormalEventId": 2012,
            "PeerId": ""
          }
        ]
      },
      {
        "UserId": "itachi3",
        "RoomId": "461",
        "EventTime": 1592448600,
        "ExperienceId": 4,
        "AbnormalEventList": [
          {
            "AbnormalEventId": 2014,
            "PeerId": ""
          },
          {
            "AbnormalEventId": 2021,
            "PeerId": ""
          },
          {
            "AbnormalEventId": 2022,
            "PeerId": ""
          },
          {
            "AbnormalEventId": 2011,
            "PeerId": "itachili1"
          },
          {
            "AbnormalEventId": 2012,
            "PeerId": "itachili1"
          }
        ]
      },
      {
        "UserId": "itachi3",