Help Center> Content Moderation> API Reference> APIs> Audio Stream Moderation> Creating an Audio Stream Moderation Job
Updated on 2024-03-27 GMT+08:00
View PDF

Creating an Audio Stream Moderation Job

Function

This API is used to create an audio stream moderation job. After the job is created, the job ID is returned.

URI

POST /v3/{project_id}/moderation/audio-stream/jobs

Table 1 Path parameters

Parameter

Mandatory

Type

Description

project_id

Yes

String

Project ID. For details about how to obtain the project ID, see Obtaining a Project ID.

Request Parameters

Table 2 Request header parameters

Parameter

Mandatory

Type

Description

X-Auth-Token

Yes

String

User token, which can be obtained by calling the IAM API (The token is the value of X-Subject-Token in the response header.)
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

data

Yes

data object

Audio stream data input

event_type

Yes

String

Event type. The options are as follows:

  • default: default event
  • audiobook: audio book
  • education: educational audio
  • game: game voice room
  • live: livestream fashion show
  • ecommerce: livestream e-commerce
  • voiceroom: dating voice room
  • private: private voice chat

categories

Yes

Array of strings

Types of risks to be detected. The list cannot be empty. The available risk types are as follows:

  • porn
  • abuse
  • ad
  • moan

callback

Yes

String

HTTP callback interface, which is invoked to notify you of the moderation result. For details about the moderation result parameters, see Response Parameters.

If the audio stream has not ended, the callback interface is invoked to review the violation content. If the audio stream has ended, the client is called no matter whether the audio stream contains violation content.
Table 4 data

Parameter

Mandatory

Type

Description

url

Yes

String

Audio stream URL. Mainstream protocols such as RTMP, RTMPS, HLS, HTTP, and HTTPS are supported.

Response Parameters

Status code: 200

Table 5 Response body parameters

Parameter

Type

Description

request_id

String

Unique ID of the request, which is used for troubleshooting. You are advised to save the ID.

job_id

String

Unique job ID

Status code: 400

Table 6 Response body parameters

Parameter

Type

Description

error_code

String

Error code of a failed API call. For details, see Error Codes.

This parameter is not included when the API is successfully called.

error_msg

String

Error message of a failed API call.

This parameter is not included when the API is successfully called.

Example Request

Create an audio stream moderation job.

POST https://{endpoint}/v3/{project_id}/moderation/audio-stream/jobs
{
  "data" : {
    "url" : "https://xxxxx"
  },
  "event_type" : "default",
  "categories" : [ "porn", "ad" ],
  "callback" : "http://xxxx"
}

Example Response

Status code: 200

Example of a successful response

{
  "job_id" : "01661356800_7c0fe871f80543358917e4faebca4a48",
  "request_id" : "07490f57ac5e034c077ab25b5f9e1da5"
}

Status code: 400

Example of a failed response

{
  "error_code" : "AIS.0401",
  "error_msg" : "The input parameter event_type is incorrect."
}

Status Codes

Status Code

Description

200

Example of a successful response

400

Example of a failed response

Error Codes

For details, see Error Codes.

Parent topic: Audio Stream Moderation