tencent cloud

PrevNext

フィードバック

キーワードで検索してください

Recent Pages

ドキュメント
Chat
    ドキュメント
    Download PDF

    After a User Is Removed from Blocklist

    最終更新日:2024-02-07 17:30:51
    PDFファイルをダウンロード

      Feature Description

      Through this callback, the app backend can view the user deletion from blocklist in real time.

      Precautions

      To enable this callback, you must configure the callback URL and toggle on the corresponding protocol. For details on the configuration method, see Third-Party Callback Configuration.
      Callback direction: The IM 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 issues, see Third-Party Callback Overview: Security Considerations.

      Callback Triggering Scenarios

      An app user uses a client to initiate a request to remove users from blocklist.
      The app backend initiates a request to remove users from blocklist through the RESTful API.

      Callback Triggering Time

      The callback is triggered after the IM backend receives a request to remove users from blocklist and successfully remove the users.

      API Description

      Request URL example

      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&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform

      Request parameters

      Parameter
      Description
      https
      The request protocol is HTTPS, and the request method is POST.
      www.example.com
      The callback URL.
      SdkAppid
      The SDKAppID assigned by the IM console when an application is created.
      CallbackCommand
      The value is fixed to Sns.CallbackBlackListDelete.
      contenttype
      The value is fixed to JSON.
      ClientIP
      The client IP address, whose format is similar to: 127.0.0.1.
      OptPlatform
      The client platform. For details on the possible values, see the OptPlatform parameter in Third-Party Callback Overview: Callback Protocols.

      Request packet example

      {
          "CallbackCommand": "Sns.CallbackBlackListDelete",
          "PairList": [
              {
                  "From_Account": "id",
                  "To_Account": "id1"
              },
              {
                  "From_Account": "id",
                  "To_Account": "id2"
              },
              {
                  "From_Account": "id",
                  "To_Account": "id3"
              }
          ]
      }

      Request packet fields

      Field
      Type
      Description
      CallbackCommand
      String
      The callback command.
      PairList
      Array
      The account pair for which the deletion from blocklist is successful.
      From_Account
      String
      From_Account deletes To_Account from its blocklist.
      To_Account
      String
      To_Account is deleted from the blocklist of From_Account.

      Response packet example

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

      Response packet fields

      Field
      Type
      Attribute
      Description
      ActionStatus
      String
      Required
      The request processing result. OK: succeeded. FAIL: failed.
      ErrorCode
      Integer
      Required
      The error code. 0 indicates that app backend processing was successful, and 1 indicates that app backend processing failed.
      ErrorInfo
      String
      Required
      Error information.

      References

      Third-party callback overview
      RESTful APIs: Adding users to the blocklist
      お問い合わせ

      カスタマーサービスをご提供できるため、ぜひお気軽にお問い合わせくださいませ。

      お問い合わせ
      テクニカルサポート

      さらにサポートが必要な場合は、サポートチケットを送信して弊社サポートチームにお問い合わせください。24時間365日のサポートをご提供します。

      チケットを送信
      電話サポート（24 時間365日対応）
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      個人情報保護方針利用規約クッキーポリシー