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.

You are advised to record the job_id corresponding to each URL after creating a moderation job so that you can close the moderation job later.
If the expected moderation result is not called back after a moderation job is created, the stream may be unstable and may fail to be pulled by the service. You can close the moderation job and create another moderation job for the stream.

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	If this field is not empty, the callback will be invoked to send the detection result to your URL. If the audio stream does not end, the client is called back when violation is detected in the segment. If the audio stream ends, the client is called back no matter whether violation is detected in the segment. NOTE: Your callback interface must support the POST method. For details about the callback data format, see the example response for the API used to query an audio moderation job. If the callback interface of your server returns HTTP status code 200 within three seconds after receiving the result from the content security service, the result is successfully received. If another HTTP status code is returned or no status code is returned within three seconds, the result fails to be received. In this case, the content security service will send the detection result repeatedly.
seed	No	String	Used to verify the requests initiated by Huawei Cloud content security service during callback notifications. You can customize it. The value is a random string that contains a maximum of 64 characters, including letters, digits, and underscores (_). NOTE: If seed is not empty, headers contains the X-Auth-Signature field. The field value is generated using the HMAC-SHA256 algorithm. The string to be encrypted is composed of create_time, job_id, request_id, and seed in sequence. The key is seed.

**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.
language	No	String	Supported audio stream language. The options are as follows: zh: Chinese (default value) en: English ar: Arabic
return_all_results	No	Boolean	Policy for returning the audio clip moderation result. The following values are available: false: Audio clips whose risk level is not pass are returned. true: Audio clips of all risk levels are returned. NOTE: 1. The default value is false. 2. The audio stream moderation result is returned every 10 seconds.

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

Previous topic: Audio Stream Moderation

Next topic: Stopping an Audio Stream Moderation Job

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel

For any further questions, feel free to contact us through the chatbot.

Chatbot