tencent cloud

PrevNext

Feedback

search by keyword

Recent Pages

Documentation
Chat
    Documentation
    Download PDF

    Unblocklisting Users

    Last updated: 2024-07-16 11:25:50
    Download PDF

      Feature Description

      This API is used to remove one or multiple users from the blocklist.

      API Invocation Description

      Request URL example

      https://xxxxxx/v4/sns/black_list_delete?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

      Request parameters

      The following table lists and describes only the parameters to be modified when this API is invoked. For details on other parameters, see RESTful API Overview.
      Parameter
      Description
      https
      The request protocol is HTTPS, and the request method is POST.
      xxxxxx
      The country/region where your SDKAppID is located.
      China: console.tim.qq.com
      Singapore: adminapisgp.im.qcloud.com
      Seoul: adminapikr.im.qcloud.com
      Frankfurt: adminapiger.im.qcloud.com
      Silicon Valley: adminapiusa.im.qcloud.com
      Jakarta: adminapiidn.im.qcloud.com
      v4/sns/black_list_delete
      The Request API.
      sdkappid
      The SDKAppID assigned by the IM console when an application is created.
      identifier
      This must be the app admin account. For details, see App Admins.
      usersig
      The signature generated by the app admin account. For details, see Generating UserSig.
      random
      Enter a random 32-bit unsigned integer ranging from 0 to 4294967295.
      contenttype
      Request format. The value is always json.

      Maximum invocation frequency

      The maximum invocation frequency is 200 times per second.

      Request packet example

      {
       "From_Account":"id",
       "To_Account":["id1","id2","id3"]
      }

      Request packet fields

      Field
      Type
      Attribute
      Description
      From_Account
      String
      Required
      The identifier for which specific users are to be removed from their blocklist.
      To_Account
      Array
      Required
      The list of identifiers to be removed from the blocklist. The number of To_Accounts in a single request cannot exceed 1,000.

      Response packet example

      {
      "ResultItem":
      [
      {
      "To_Account":"id1",
      "ResultCode":0,
      "ResultInfo":""
      },
      {
      "To_Account":"id2",
      "ResultCode":0,
      "ResultInfo":""
      },
      {
      "To_Account":"id3",
      "ResultCode":30006,
      "ResultInfo":"Err_SNS_BlackListCheck_Check_Reverse_BlackList_Fail"
      }
      ],
      "Fail_Account":["id3"],
      "ActionStatus":"OK",
      "ErrorCode":0,
      "ErrorInfo":"",
      "ErrorDisplay":""
      }

      Response packet fields

      Field
      Type
      Description
      ResultItem
      Array
      The result object array for batch deletion from blocklist.
      To_Account
      String
      The identifier you request to be removed from the blocklist.
      ResultCode
      Integer
      The processing result of To_Account. 0: succeeded. Others: failed.
      ResultInfo
      String
      Error description for To_Account. If the processing is successful, the field is empty.
      Fail_Account
      Array
      The list of users that fails to be removed. This field is returned only when someone fails to be removed.
      ActionStatus
      String
      The request packet processing result. OK: succeeded. FAIL: failed.
      ErrorCode
      Integer
      The error code. 0: succeeded. Others: failed.
      ErrorInfo
      String
      Detailed error information.
      ErrorDisplay
      String
      Detailed error information to be displayed on the client.

      Error Codes

      Unless a network error (such as error 502) occurs, the HTTP return code for this API is always 200. ErrorCode and ErrorInfo in the response packet represent the actual error code and error information, respectively. For common error codes (60000 to 79999), see Error Codes. The following table describes the error codes specific to this API.
      Error Code
      Description
      30001
      A request parameter is incorrect. In this case, check request parameters based on the error description.
      30003
      The requested user account does not exist.
      30004
      The request requires app admin permissions.
      30006
      An internal server error occurred. In this case, try again.
      30007
      The network connection timed out. In this case, try again later.
      30008
      A write conflict occurred due to concurrent writes. In this case, we recommend that you use the batch mode.

      API Commissioning Tool

      Use the online commissioning tool for RESTful APIs to commission this API.

      References

      Removing users from blocklist
      Pulling a blocklist
      Verifying a blocklist

      Callback That May Be Triggered

      Contact Us

      Contact our sales team or business advisors to help your business.

      Contact Us
      Technical Support

      Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

      Submit a Ticket
      7x24 Phone Support
      Copyright © 2013-2024 Tencent Cloud. All Rights Reserved.
      Privacy PolicyLegalCookie Policy