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

Querying a Recording Callback

Function

This API is used to query details about a recording callback.

Calling Method

For details, see Calling APIs.

URI

GET /v1/{project_id}/record/callbacks/{id}

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.

id

Yes

String

Recording callback 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.

Response Parameters

Status code: 200

Table 3 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 4 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: 404

Table 5 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 6 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

Queries a recording callback configuration.

GET https://{endpoint}/v1/{project_id}/record/callback/e89b76xxxxxx3425ui80af501cdxxxxxx

Example Responses

Status code: 200

Query succeeded.

{
  "id" : "e2fe84def7e476651034ec4b9e92bc30",
  "publish_domain" : "publish.example.com",
  "app" : "*",
  "notify_callback_url" : "http://100.95.129.234:8456/base_record_notify",
  "notify_event_subscription" : [ "RECORD_FILE_COMPLETE", "RECORD_NEW_FILE_START" ],
  "create_time" : "2020-03-02T08:59:45Z",
  "update_time" : "2020-03-09T08:59:45Z"
}

Status code: 404

The record does not exist.

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

Status Codes

Status Code

Description

200

Query succeeded.

404

The record does not exist.

Error Codes

See Error Codes.

Parent Topic: Recording Callback Management