Enable callback notification

Concepts

The following table introduces the concepts related to callback notification.

Callback notification for machine-assisted moderation results

All asynchronous moderation operations of the Content Moderation API support callback notification, including asynchronous image moderation and asynchronous video moderation. For more information, see Moderate images asynchronously and Moderate videos asynchronously. If you call an asynchronous operation and need Content Moderation to return the moderation results, specify the callback and seed parameters in your moderation request. The callback parameter specifies the callback URL and the seed parameter specifies a string that is used to verify the callback notification request.

Procedure

1. Prepare the HTTP callback URL and verification string for receiving moderation results.
2. When you call an asynchronous operation for content moderation, specify the callback and seed parameters in your moderation request. For more information, see the parameter description of the relevant API operation.

Callback notification for human review results

1. Log on to the Alibaba Cloud Content Moderation console.
2. In the left-side navigation pane, choose Settings > Moderation API.
3. On the Moderation API page, click the Message tab.
4. On the Message tab, click Settings or View. If you have not specified a callback URL, the Settings button appears. If you have specified a callback URL, the View button appears.
5. In the API Callback Notification Settings panel, set the Callback URL parameter and click OK.
   After the callback URL is specified, the system automatically generates a value for the seed parameter. You can use the value of the seed parameter to verify whether a callback notification request is sent from Alibaba Cloud to the callback URL. Save and use the value of the seed parameter based on your business needs.

Content parameter description

After callback notification is enabled, Content Moderation sends the moderation results that are generated by the Content Moderation API in a callback notification to the specified callback URL. The callback notification contains the content parameter. The following tables describe the structure of the content parameter.

{
    "scanResult": {
        "code": 200,
        "msg": "OK",
        "taskId": "fdd25f95-4892-4d6b-aca9-7939bc6e9baa-1486198766695",
        "url": "http://1.jpg",
        "results": [
            {
                "rate": 100,
                "scene": "porn",
                "suggestion": "block",
                "label": "porn"
            }
        ]
    },
    "auditReult": {
        "suggestion": "block",
        "labels": [
            "porn",
            "ad",
            "terrorism"
        ]
    },
    "humanAuditResult": {
          "suggestion": "pass",
          "dataId": "yyyy",
          "labels": [
              "Pornographic content",
              "Vulgar content"
        ],
          "taskId": "xxxxxx"
    }
}