Skip to main content

User Deactivation and Activation Status Callback

The IM Service supports synchronizing the processing results to your application server when a user is deactivated or reactivated, allowing you to track the progress and results of individual or batch deactivation and activation processes.

  • After initiating deactivation, the server will notify the deactivation result via callback within 15 minutes.
  • In cases of reactivating a user ID, repeated deactivation, or repeated activation, the IM Service server will initiate a callback notification in real-time.

Enabling the Service​

Before using the User Deactivation and Activation Status Callback feature, ensure that the service is enabled for your current App Key. You can enable and configure this callback service on the Basic features page in the Console.

When enabling the service, configure a callback URL that is accessible. If your network has IP access restrictions, make sure to configure the IP allowlist; otherwise, you won't be able to receive server callbacks properly.

Callback Method​

Request Method: POST

Data Format: application/x-www-form-urlencoded

The IM Service server will add signature parameters to the POST request URL. You can verify the caller's identity and data validity through the signature. For details, refer to Server Callback Signature.

Callback Body Parameters​

The HTTP request body for this callback service is in application/x-www-form-urlencoded format and includes the following HTTP form parameters:

ParameterTypeDescription
userIdStringUser ID
operateIdStringOperation ID, a unique identifier for the current operation. Matches the operation ID returned by the Deactivate Users and Reactivate User ID APIs.
typeIntOperation type. 0: Deactivate user; 1: Reactivate user ID.
codeStringService processing result code for activation/deactivation. 0 indicates success. Other error codes are listed below.
timeLongOperation time

  • code Parameter Description (Service Processing Result Codes for Activation/Deactivation)

    CodeDescriptionRemarks
    24353Repeated DeactivationThis error code is returned when calling the deactivation API with a user ID that has already been deactivated.
    24354Repeated ActivationThis error code is returned when calling the reactivate user ID API with a user ID that is already active.
    24356User Deactivation in ProgressThis error code is returned when calling the deactivation API with a user ID that is currently in the deactivation process.
    OthersUnknown Error

Callback Request Example​

The following example assumes that the callback URL configured on the service enablement page is http://example.com/user_actiavtation_status_sync.php.

POST /user_actiavtation_status_sync.php?appKey=uwd1c0sxdlx2&signTimestamp=1681202504348&nonce=14314&signature=45beb7cc7307889a8e711219a47b7cf6a5b000e8&appKey=uwd1c0sxdlx2 HTTP/1.1
Host: example.com
Content-Type: application/x-www-form-urlencoded
User-Agent: RC/1.0

userId=uid1&operateId=C70B-B1D6-82E7-5SBO&type=0&code=0&time=1681202504348

Responding to Callback Requests​

tip
  • A successful HTTP 200 OK response is sufficient for the server to consider the status synchronized.
  • If the response times out after 5 seconds, the server will retry up to 2 more times. If it still fails, the status will no longer be synchronized.
  • If there is a large-scale timeout in a short period, the server will temporarily stop requesting your server and resume sending callback requests after 1 minute. In case of abnormal network disconnection, synchronization will be delayed by 5 minutes.
Last updated on