DescribeAbnormalEvent

Last updated: 2020-08-12 15:32:28

    1. API Description

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

    This API is used to query users’ exceptional experience events according to SDKAppID and return the exceptional experience ID and possible causes. It queries data in last 24 hours, and the query period is up to 1 hour which can start and end on different days. For more information about exceptional experience ID mapping, please see here.

    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. This API only supports: ap-guangzhou
    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 exceptional experience events

    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",
            "RoomId": "461",
            "EventTime": 1592448600,
            "ExperienceId": 5,
            "AbnormalEventList": [
              {
                "AbnormalEventId": 2014,
                "PeerId": ""
              }
            ]
          },
          {
            "UserId": "itachi3",
            "RoomId": "461",
            "EventTime": 1592448660,
            "ExperienceId": 4,
            "AbnormalEventList": [
              {
                "AbnormalEventId": 2014,
                "PeerId": ""
              },
              {
                "AbnormalEventId": 2021,
                "PeerId": ""
              },
              {
                "AbnormalEventId": 2022,
                "PeerId": ""
              }
            ]
          },
          {
            "UserId": "itachi3",
            "RoomId": "461",
            "EventTime": 1592448660,
            "ExperienceId": 5,
            "AbnormalEventList": [
              {
                "AbnormalEventId": 2014,
                "PeerId": ""
              }
            ]
          },
          {
            "UserId": "itachi3",
            "RoomId": "461",
            "EventTime": 1592448720,
            "ExperienceId": 4,
            "AbnormalEventList": [
              {
                "AbnormalEventId": 2014,
                "PeerId": ""
              },
              {
                "AbnormalEventId": 2021,
                "PeerId": ""
              },
              {
                "AbnormalEventId": 2022,
                "PeerId": ""
              }
            ]
          },
          {
            "UserId": "itachi3",
            "RoomId": "461",
            "EventTime": 1592448720,
            "ExperienceId": 5,
            "AbnormalEventList": [
              {
                "AbnormalEventId": 2014,
                "PeerId": ""
              }
            ]
          }
        ],
        "Total": 11,
        "RequestId": "75a3a17f-ca35-4cc8-b42f-2ebb8903b6a7"
      }
    }

    5. Developer Resources

    API Explorer

    This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

    SDK

    TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

    Command Line Interface

    6. Error Code

    The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.

    Error Code Description
    InternalError Internal error.
    InternalError.DBError An error occurred while querying the database.
    InternalError.EsQueryError An error occurred while querying ES.
    InternalError.HttpParaseFalied Failed to parse the HTTP request.
    InternalError.InterfaceErr API error.
    InternalError.MethodErr Unsupported method.
    InvalidParameter Invalid parameter.
    InvalidParameter.BodyParamsError Failed to parse the body parameter.
    InvalidParameter.EncodeParams Invalid EncodeParams.
    InvalidParameter.QueryScaleOversize The query time range exceeds 1 hour.
    InvalidParameter.SdkAppId SdkAppId is incorrect.
    InvalidParameter.StartTimeExpire The query start time is more than 24 hours earlier than now.
    InvalidParameter.StartTs Invalid StartTs.
    InvalidParameter.StartTsOversize The query start time is more than 5 days earlier than now.
    MissingParameter Missing parameter.
    MissingParameter.EndTs endTS_s is missing.
    MissingParameter.SdkAppId SdkAppId is missing.
    MissingParameter.StartTs startTS_s is missing.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help