Skip to main content

Audit Result Callback

After enabling the IM Moderation service on the IM & RTC Moderation page in the Console, you can use the audit result callback to receive detailed audit results in real-time.

tip

This callback service only returns the audit results of IM & RTC Moderation.

Configure the Audit Result Callback URL​

Please configure the callback URL on the IM & RTC Moderation page in the Console. The configuration takes effect within 30 minutes. Ensure that the callback URL you provide is accessible via the public network.

Callback Method​

Request Method: POST

Data Format: application/json

The IM server will add a signature parameter to the POST request header. You can verify the caller's identity and ensure data validity through the signature. For details, see Server Callback Signature.

Callback Body Parameters​

The HTTP request body data format of this callback service is application/json, containing a JSON object with the following structure:

NameTypeDescription
resultIntReturns whether the audit passed. 10000 indicates the audit passed; 10001 indicates the audit failed. The audit result details are returned in the resultDetail field.
contentStringReturns the audited message content. See the content structure description below.
msgUIDStringMessage ID.
serviceProviderStringAudit service provider identifier.
resultDetailStringAudit result details, directly returning the audit result JSON structure response body from the audit service provider. See the resultDetail description below.

  • content Structure Description:

    NameTypeDescription
    appKeyStringappkey
    fromUserIdStringSender ID
    targetIdStringReceiver ID
    toUserIdsStringGroup member ID list (separated by commas). When sending a group targeted message, the list of group member user IDs receiving the message. Empty for non-group targeted messages.
    conversationTypeStringConversation type. Supported conversation types include: PERSON (one-to-one chat), GROUP (group chat), TEMPGROUP (chatroom chat), ULTRAGROUP (ultra group chat).
    objectNameStringMessage type. Generally includes: RC:TxtMsg (text message), RC:ImgMsg (image message), RC:VcMsg (voice message), RC:HQVCMsg (HD voice message), RC:SightMsg (short video message).
    messageStringMessage body content. For details, see the Message Structure Documentation.
    extraContentObjectExtended message content, JSON structure Key-Value pairs, e.g., {"type":"3"}. Key supports up to 32 characters, including uppercase and lowercase letters, numbers, and special characters + = - _. No Chinese characters are supported. Value supports up to 4096 characters.
    clientOsStringClient type, including: iOS, Android, HarmonyOS, Websocket, MiniProgram (mini-program), PC, Server (sent via Server API, requires enabling the Server API message routing feature).
    messageTimelongServer time when the server received the message from the client, accurate to milliseconds.
    messageIdStringMessage ID

  • resultDetail Description: Directly returns the audit result response body from the audit service provider.

    • If you selected ShuMei as the audit service provider in the Console, resultDetail contains the return result of ShuMei's audit. For detailed structure descriptions, refer to the following ShuMei documentation. Note that text and image audits return the response body of a single synchronous request, while audio and video audits return the response body of a single asynchronous request. The riskLabel1 in ShuMei's audit result response body carries the specific reason for the audit failure.

      • Text Message Audit Result See the "Return Result" section in this ShuMei document. Text audit returns the response body of a single synchronous request.
      • Image Message Audit Result See the "Synchronous Return Result" section in this ShuMei document. Image audit returns the response body of a single synchronous request.
      • Voice Message Audit Result See the "Callback Result" section in this ShuMei document. Audio audit returns the response body of a single asynchronous request.
      • Short Video Message Audit Result See the "Asynchronous Callback Result" section in this ShuMei document. Video audit returns the response body of a single asynchronous request.

Callback Request Example​

The following example assumes that the receiving URL you configured on the service activation page is http://example.com/review_result.php

POST review_result.php HTTP/1.1
Host: example.com
RC-App-Key: uwd1c0sxdlx2
RC-Timestamp: 1408710653491
RC-Nonce: 14314
RC-Signature: 45beb7cc7307889a8e711219a47b7cf6a5b000e8
Content-Type: application/json

{
  "result":10000,
  "content":"{****}",//Audited message structure JSON
  "serviceProvider":"ShuMei",
  "msgUID":"596E-P5PG-4FS2-7OJK",
  "resultDetail":"{****}";//Audit result detailed JSON structure
}

Responding to Callback Requests​

tip
  • As long as an HTTP 200 OK response is received, the server will consider the status synchronized.
  • If the response times out after 5 seconds, the server will retry 3 more times. If it still fails, the IM service will deliver the message by default.
  • If there are widespread timeouts in a short period, the server will temporarily stop requesting your server and will continue sending callback requests after 90 seconds. In case of abnormal network disconnection, synchronization will be delayed by 5 minutes.
Last updated on