Close Stream API

DeepCleer Close Audio Stream Moderation lets the client notify the server to terminate an active audio stream moderation task before it ends naturally.

API Description

The Close Audio Stream API stops an in-progress audio stream moderation task identified by its requestId. Use this endpoint to release DeepCleer stream-pull resources when the upstream live room has ended, when you no longer need moderation results, or when you need to recycle a duplicate-submission dupRequestId returned by the Audio Stream Moderation API.

Requirements

Item	Specification
Protocol	HTTP or HTTPS
Method	POST
Encoding	UTF-8
Format	All request and response parameters use JSON

Timeout Suggestion

Recommended request timeout: 1 second.

ℹ️
This call is a synchronous control-plane operation — it acknowledges that the close request was accepted. Once accepted, DeepCleer stops pulling the stream and (when returnFinishInfo was set to 1 on the original submission) delivers a final stream-end callback to the original callback URL.

Request

Request URL

Cluster	Endpoint
Silicon Valley	`http://api-audiostream-gg.fengkongcloud.com/finish_audiostream/v4`
Singapore	`http://api-audiostream-xjp.fengkongcloud.com/finish_audiostream/v4`

Request Parameters

Parameter	Type	Required	Max Length	Description
`accessKey`	string	Yes	20	API authentication key. The default `accessKey` is sent in your onboarding email.
`requestId`	string	Yes	—	Unique DeepCleer request identifier of the audio stream moderation task to close. Use the `requestId` returned by the original Audio Stream Moderation submission, or the `dupRequestId` returned when a duplicate submission was detected.

Response

Response Parameters

ℹ️
Parameters other than code, message, and requestId are only guaranteed to be returned when code is 1100.

Parameter	Type	Required	Description
`requestId`	string	Yes	Unique DeepCleer request identifier for this close call.
`code`	int32	Yes	Response code. See Response Codes.
`message`	string	Yes	Response message corresponding to the `code`.

Response Codes

Code	Message
`1100`	Success
`1901`	QPS or stream-count limit exceeded
`1902`	Invalid parameters
`1903`	Service failure
`1904`	Stream pull failure
`9101`	Unauthorized operation

Examples

Request Example

{
  "accessKey": "xxxxx",
  "requestId": "xxxxx"
}

Response Example

{
  "code": 1100,
  "message": "Success",
  "requestId": "a78eef377079acc6cdec24967ecde722"
}