Queries the configuration of callbacks for audio moderation results.

Usage notes

  • Obtain the main streaming domain, and then call this operation to query the configuration of callbacks for audio moderation results.
  • 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 DescribeLiveAudioAuditNotifyConfig

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

DomainName String Yes example.com

The main streaming domain.

Response parameters

Parameter Type Example Description
RequestId String B908FF89-B03C-4831-B55B-48D2A7DA0A68

The ID of the request.

LiveAudioAuditNotifyConfigList Array of LiveAudioAuditNotifyConfig

The configuration of callbacks for audio moderation results.

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

The callback template. The following attributes are configured:

  • {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.
DomainName String example.com

The main streaming domain.

Callback String http://guide.aliyundoc.com/callback

The callback URL.

Examples

Sample requests

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

Sample success responses

XML format 

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

<?xml version="1.0" encoding="UTF-8" ?>
<DescribeLiveAudioAuditNotifyConfigResponse>
<RequestId>B908FF89-B03C-4831-B55B-48D2A7DA0A68</RequestId>
<LiveAudioAuditNotifyConfigList>
    <LiveAudioAuditNotifyConfig>
        <Callback>http://guide.aliyundoc.com/callback</Callback>
        <DomainName>example.com</DomainName>
        <CallbackTemplate>{\"domain\":{DomainName},\"app\":{AppName},\"stream\":{StreamName},\"timestamp\":{Timestamp},\"result\":{Result}}</CallbackTemplate>
    </LiveAudioAuditNotifyConfig>
</LiveAudioAuditNotifyConfigList>
</DescribeLiveAudioAuditNotifyConfigResponse>

JSON format 

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

{
  "DescribeLiveAudioAuditNotifyConfigResponse" : {
    "RequestId" : "B908FF89-B03C-4831-B55B-48D2A7DA0A68",
    "LiveAudioAuditNotifyConfigList" : {
      "LiveAudioAuditNotifyConfig" : {
        "Callback" : "http://guide.aliyundoc.com/callback",
        "DomainName" : "example.com",
        "CallbackTemplate" : "{\\\"domain\\\":{DomainName},\\\"app\\\":{AppName},\\\"stream\\\":{StreamName},\\\"timestamp\\\":{Timestamp},\\\"result\\\":{Result}}"
      }
    }
  }
}

Error codes

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