Help Center/ Live/ Cloud Live API Reference/ Recording Callback Management/ Creating a Recording Callback
Updated on 2024-09-27 GMT+08:00
View PDF

Creating a Recording Callback

Function

This API is used to create a recording callback.

Calling Method

For details, see Calling APIs.

URI

POST /v1/{project_id}/record/callbacks

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

No

String

User token. This parameter is mandatory when token authentication is used. The token can be obtained by calling the IAM API used to obtain a user token. The value of X-Subject-Token in the response header is the user token.

Authorization

No

String

Authentication information. This parameter is mandatory for AK/SK authentication.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory for AK/SK authentication.

X-Project-Id

No

String

Project ID. This parameter is mandatory for AK/SK authentication.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

publish_domain

Yes

String

Ingest domain name.

app

Yes

String

Application name. To match any application, set this parameter to a wildcard character (*). Exact application matching is preferred. If no application is matched, all applications will be matched.

notify_callback_url

No

String

Callback URL for sending recording notifications.

notify_event_subscription

No

Array of strings

Type of recording notifications. RECORD_NEW_FILE_START: Recording started. RECORD_FILE_COMPLETE: Recording file generated. RECORD_OVER: Recording completed. RECORD_FAILED: Recording failed. The default value is RECORD_FILE_COMPLETE.

sign_type

No

String

Encryption type. The options are as follows:

  • HMACSHA256

  • MD5

If this parameter is not specified, the default value HMACSHA256 is used.

key

No

String

Callback key, which is used for authentication. To ensure user data security, you are advised to set this parameter.

Response Parameters

Status code: 201

Table 4 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. Format: *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* indicates the current timestamp, and *hostname* is the name of the server that processes the current API.)
Table 5 Response body parameters

Parameter

Type

Description

id

String

Recording callback ID, which is returned by the server. This parameter does not need to be carried during creation or modification.

publish_domain

String

Ingest domain name.

app

String

Application name. To match any application, set this parameter to a wildcard character (*). Exact application matching is preferred. If no application is matched, all applications will be matched.

notify_callback_url

String

Callback URL for sending recording notifications.

notify_event_subscription

Array of strings

Type of recording notifications. RECORD_NEW_FILE_START: Recording started. RECORD_FILE_COMPLETE: Recording file generated. RECORD_OVER: Recording completed. RECORD_FAILED: Recording failed. The default value is RECORD_FILE_COMPLETE.

sign_type

String

Encryption type. The options are as follows:

  • HMACSHA256

  • MD5

create_time

String

Creation time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time).

update_time

String

Modification time in the format of yyyy-mm-ddThh:mm:ssZ (UTC time).

Status code: 400

Table 6 Response header parameters

Parameter

Type

Description

X-request-id

String

Request ID for task tracing. Format: *request_id-timestamp-hostname*. (*request_id* is the UUID generated on the server. *timestamp* indicates the current timestamp, and *hostname* is the name of the server that processes the current API.)
Table 7 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Creates a recording callback configuration.

POST https://{endpoint}/v1/{project_id}/record/callbacks

{
  "publish_domain" : "publish.example.com",
  "app" : "**",
  "notify_callback_url" : "https://mycallback.com.cn/record_notify",
  "notify_event_subscription" : [ "RECORD_FILE_COMPLETE" ]
}

Example Responses

Status code: 400

Failed to create the recording callback.

{
  "error_code" : "LIVE.100011001",
  "error_msg" : "Request Illegal"
}

Status Codes

Status Code

Description

201

Recording callback created.

400

Failed to create the recording callback.

Error Codes

See Error Codes.

Parent Topic: Recording Callback Management