tencent cloud

PrevNext

피드백

키워드를 검색하세요

Recent Pages

문서
Chat
    문서
    Download PDF

    API Overclocking Alarm Callbacks

    마지막 업데이트 시간:2024-05-08 16:34:56
    PDF 다운로드

      Feature Overview

      When the request frequency of the API exceeds 80% of the threshold, the app backend is notified of the call frequency alarm information through a callback.

      Notes

      To enable the callback, you must configure the callback URL. For detailed configuration methods, see Webhook Configuration.
      Once the callback URL is configured, an alarm callback is triggered by default if the request frequency exceeds the alarm threshold.
      During this callback, the Chat backend initiates an HTTP POST request to the app backend.
      After receiving the callback request, the app backend must check whether the SDKAppID contained in the request URL is consistent with its own SDKAppID.
      For other security-related matters, see Webhook Overview - Security Considerations.

      API Description

      Sample Request URL

      In the following example, the callback URL configured in the app is https://www.example.com Example:
      https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&OptPlatform=$OptPlatform&contenttype=json

      Request Parameters

      Request Parameters

      Parameter
      Description
      https
      The request protocol is HTTPS, and the request method is POST.
      www.example.com
      Callback URL
      SdkAppid
      SDKAppID allocated by the Chat console at the time of application creation
      CallbackCommand
      Fixed as Alert.RequestOverLimit
      contenttype
      Fixed value: JSON
      OptPlatform
      Client platform. For values, see Webhook Overview - Webhook Protocol for the meaning of the OptPlatform parameter.

      Sample Request Packet

      {
    "CallbackCommand": "Alert.RequestOverLimit",
    "ServiceName": "openim",
    "Command": "batchsendmsg",
    "Request": 510,
    "Limit": 200
}

      Request Packet Fields

      Field
      Type
      Description
      CallbackCommand
      String
      Fixed as Alert.RequestOverLimit
      ServiceName
      String
      Internal service name of API. Different ServiceNames correspond to different service types.
      Command
      String
      API command word, combined with ServiceName to identify specific business features.
      Request
      Integer
      API request QPS rate
      Limit
      Integer
      API request QPS threshold

      Sample Response Packet

      {
          "ActionStatus": "OK",
          "ErrorInfo": "",
          "ErrorCode": 0
      }

      Response Packet Fields

      Field
      Type
      Description
      ActionStatus
      String
      Request processing result:
      OK indicates successful processing.
      FAIL indicates failed processing.
      ErrorCode
      Integer
      Error code
      ErrorInfo
      String
      Error description

      References

      Webhook Overview
      RESTful APIs
      
      문의하기

      고객의 업무에 전용 서비스를 제공해드립니다.

      문의하기
      기술 지원

      더 많은 도움이 필요하시면, 티켓을 통해 연락 바랍니다. 티켓 서비스는 연중무휴 24시간 제공됩니다.

      티켓 제출
      연중무휴 24시간 전화 지원
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      개인정보 처리방침서비스 약관쿠키 정책