Standard recording configuration

Custom recording enables you to use third-party cloud storage services, while standard recording does not.

Set standard recording configuration

Sets the standard recording configuration for all live streams under the specified entry point.

PATCH https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/record/standard/regions/{region}

Parameter	Type	Description
`appid`	String	Required. The App ID retrieved from Agora Console.
`entry_point`	String	Required. The entry point name.
`region`	String	Required. The configured region when adding the domain.

The request body is in the JSON Object type, and contains the following fields:

Field	Type	Description
`mp4Config`	JSON Object	Optional. The configuration of the MP4 recording files. See mp4Config.
`hlsConfig`	JSON Object	Optional. The configuration of the HLS recording files. See HlsConfig.

If the returned HTTP status code is 200, the request is successful.

If the returned HTTP status code is not 200, the request fails. You can refer to the HTTP status code for possible reasons.

Request line

PATCH https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/record/standard/regions/cn HTTP/1.1

Request body

{
    "hlsConfig": {
        "enabled": true
    },
    "mp4Config": {
        "enabled": true
    }
}

Response line

HTTP/1.1 200 OK

Gets the standard recording configuration for the specified entry point.

GET https://api.agora.io/v1/projects/{appid}/fls/entry_points/{entry_point}/settings/record/standard/regions/{region}

Parameter	Type	Description
`appid`	String	Required. The App ID retrieved from Agora Console.
`entry_point`	String	Required. The entry point name.
`region`	String	Required. The configured region when adding the domain.

If the returned HTTP status code is 200, the request is successful, and the response body contains the following fields:

Field	Type	Description
`mp4Config`	JSON Object	The configuration of the MP4 recording files. See mp4Config.
`hlsConfig`	JSON Object	The configuration of the HLS recording files. See HlsConfig.

If the returned HTTP status code is not 200, the request fails. You can refer to the HTTP status code for possible reasons.

Request line

GET https://api.agora.io/v1/projects/{your_appid}/fls/entry_points/live/settings/record/standard/regions/cn HTTP/1.1

Response line

HTTP/1.1 200 OK

Request body

{
    "hlsConfig": {
        "enabled": true
    },
    "mp4Config": {
        "enabled": true
    }
}

The configuration of the MP4 recording files contains the following fields:

enabled: Bool type, optional. Whether to enable the recording in the MP4 format.

The configuration of the HLS recording files contains the following fields:

enabled: Bool type, optional. Whether to enable recording in the HLS format.

Status code	Description
200	The request succeeds.
400	The parameter is invalid, for example the `appid` or the `entry_point` is empty, or the `region` parameter value is invalid.
401	Unauthorized (the customer ID and the customer secret do not match).
404	The server cannot find the resource according to the request, which means the requested entry point does not exist or the requested URI path is invalid.
500	An internal error occurs in the server, so the server is not able to complete the request.
504	An internal error occurs in the server. The gateway or the proxy server did not receive a timely request from the remote server.