Configures callbacks for audio moderation results.

Usage notes

  • The automated review feature returns the audio moderation results based on the configured callback template.
  • Only some live centers support the automated review feature. For more information, see Supported regions.

QPS limit

You can call this operation up to 10 times per second per account. Requests that exceed this limit are dropped and you will experience service interruptions. We recommend that you take note of this limit when you call this operation. For more information, see QPS limit on an API operation in ApsaraVideo Live.

Debugging

OpenAPI Explorer automatically calculates the signature value. For your convenience, we recommend that you call this operation in OpenAPI Explorer. OpenAPI Explorer dynamically generates the sample code of the operation for different SDKs.

Request parameters

Parameter Type Required Example Description
Action String Yes AddLiveAudioAuditNotifyConfig

The operation that you want to perform. Set the value to AddLiveAudioAuditNotifyConfig.

DomainName String Yes example.com

The main streaming domain.

Callback String No https://demo.aliyundoc.com/callback

The callback URL. This URL is used to receive callback notifications about violations in audio.

CallbackTemplate String No {"domain":{DomainName},"app":{AppName},"stream":{StreamName},"timestamp":{Timestamp},"result":{Result}}

The callback template. Configure the following attributes:

  • {DomainName}: the streaming domain.
  • {AppName}: the name of the application to which the live stream belongs.
  • {StreamName}: the name of the live stream.
  • {Timestamp}: the time when the callback is returned. The value of this attribute is a UNIX timestamp. Unit: seconds.
  • {Result}: the moderation results.

Format of the Result attribute

Example:


[
        {
            "scene": "antispam",
            "label": "ad",
            "suggestion": "block",
            "rate": 99.91,
            "details": [
                {
                    "startTime": 1571989513,
                    "endTime": 1571989515,
                    "text": "The Shambhala team on the third floor cooperates with the team on the fifth floor.",
                    "label": "normal"
                },
                {
                    "startTime": 1571989515,
                    "endTime": 1571989518,
                    "text": "Two dishes, roasted fish and hot pot, are launched for celebration.",
                    "label": "normal"
                },
                {
                    "startTime": 1571989520,
                    "endTime": 1571989522,
                    "text": "The VIP price for Shambhala members is RMB 39.",
                    "label": "normal"
                },
                {
                    "startTime": 1571989523,
                    "endTime": 1571989526,
                    "text": "A discount of RMB 66 is offered for each consumption.",
                    "label": "normal"
                },
                {
                    "startTime": 1571989530,
                    "endTime": 1571989533,
                    "text": "Big prize! For more information, contact 3398787",
                    "label": "ad"
                },
                {
                    "startTime": 1571989533,
                    "endTime": 1571989534,
                    "text": "Good news! It seems so.",
                    "label": "normal"
                },
                {
                    "startTime": 1571989538,
                    "endTime": 1571989539,
                    "text": "Four persons carry the vehicle license with them.",
                    "label": "normal"
                },
                {
                    "startTime": 1571989542,
                    "endTime": 1571989543,
                    "text": "The proxy has 10 minutes left.",
                    "label": "normal"
                },
                {
                    "startTime": 1571989545,
                    "endTime": 1571989547,
                    "text": "China Construction Bank ETC witness",
                    "label": "normal"
                },
                {
                    "startTime": 1571989550,
                    "endTime": 1571989552,
                    "text": "Zhao Xinyuan of Lvliang State Investment Group Co., Ltd.",
                    "label": "normal"
                }
            ]
        }
]

Response parameters

Parameter Type Example Description
RequestId String 7BF95F2A-3B24-4CDE-9346-7F6FA86697A1

The ID of the request.

Examples

Sample requests

http(s)://live.aliyuncs.com/?Action=AddLiveAudioAuditNotifyConfig
&DomainName=example.com
&<Common request parameters>

Sample success responses

XML format

HTTP/1.1 200 OK
Content-Type:application/xml

<AddLiveAudioAuditNotifyConfigResponse>
    <RequestId>7BF95F2A-3B24-4CDE-9346-7F6FA86697A1</RequestId>
</AddLiveAudioAuditNotifyConfigResponse>

JSON format

HTTP/1.1 200 OK
Content-Type:application/json

{
  "AddLiveAudioAuditNotifyConfigResponse" : {
    "RequestId" : "7BF95F2A-3B24-4CDE-9346-7F6FA86697A1"
  }
}

Error codes

For a list of error codes, see Service error codes.