Configure callback notifications

Key concepts

Before you configure callback notifications, understand the concepts in the following table.

Prerequisites

To use this service, you must request activation from after-sales support. If the Content Moderation service is not activated, the manual review section is not visible in the console.

To enable the service, contact after-sales support by joining the Alibaba Cloud Content Moderation Q&A group on DingTalk (Group ID: 35573806). When you request to join, provide your company name and role (for example, Developer, Product Manager, or Reviewer). For example: XXX Company + Developer.

Human moderation callback notifications

The human moderation API returns results asynchronously through callbacks. Human moderation includes machine and human review and human-only review. The callback configuration for each mode is different and described below.

Machine and human review

If you use both the Alibaba Cloud human moderation and machine auditing services, you must configure message notifications in the console to receive callbacks for human moderation. Follow these steps:

1. Log on to the Content Moderation console.

2. In the left-side navigation pane, choose Machine Auditing V1.0 > Settings.

3. On the Notification tab, click Create New Notification.

4. In the Create New Notification dialog box, enter a Title and Callback URL, select an Encryption algorithm, Notification type, and Audit Result, and then click Confirm.

   After you save the configuration, the system automatically generates a seed. The seed value verifies that requests to your callback URL originate from Alibaba Cloud. Securely store the generated seed.

   Important

   • If you have already configured a callback notification service for machine auditing, you can reuse the existing configuration or create a new one.

   • By default, the system sends callbacks for all review results, but you can choose to receive them only for specific results.

   • For Notification Type, select Manual Review Results by AlibabaCloud.

   • Encryption algorithm options:

     • SHA256: Uses the HMAC-SHA256 encryption algorithm.

     • SM3: Uses the SM3 encryption algorithm and returns a hexadecimal string consisting of lowercase letters and digits.

       For example, encrypting abc with SM3 returns 66c7f0f462eeedd9d1f2d46bdc10e4e24167c4875cf2f7a2297da02b8f4ba8e0.

5. On the Machine Moderation page, click BizType Manage.

6. On the BizType Manage tab, find the target business scene, and in the Operation column, click Choose Notification Plan to link the Callback notification scheme that you configured in Step4.

Human-only review

If you use the Alibaba Cloud human-only review service, you must include the callback (callback URL) and seed (verification string) parameters in your API request to enable callbacks.

1. Prepare an HTTP callback URL and a seed parameter to receive the scan results.

2. When you call an asynchronous content moderation API, include the callback and seed parameters in your request.

   For parameter details, see Image human moderation, Video human moderation, Text human moderation, and Review human moderation results.

Content form field

After you enable callback notifications, Content Moderation sends API callbacks based on your configuration. These notifications contain the content form data. The following table describes the structure of the content field.

{
    "humanAuditResult": {
          "suggestion": "pass",
          "customAuditFlag": false,
          "dataId": "yyyy",
          "labels": [
              "porn",
              "vulgar"
        ],
          "taskId": "xxxxxx"
    }
}