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
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
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. |
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:
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
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.) |
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:
|
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
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.) |
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" }
SDK Sample Code
The SDK sample code is as follows.
Creates a recording callback configuration.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
package com.huaweicloud.sdk.test; import com.huaweicloud.sdk.core.auth.ICredential; import com.huaweicloud.sdk.core.auth.BasicCredentials; import com.huaweicloud.sdk.core.exception.ConnectionException; import com.huaweicloud.sdk.core.exception.RequestTimeoutException; import com.huaweicloud.sdk.core.exception.ServiceResponseException; import com.huaweicloud.sdk.live.v1.region.LiveRegion; import com.huaweicloud.sdk.live.v1.*; import com.huaweicloud.sdk.live.v1.model.*; import java.util.List; import java.util.ArrayList; public class CreateRecordCallbackConfigSolution { public static void main(String[] args) { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment String ak = System.getenv("CLOUD_SDK_AK"); String sk = System.getenv("CLOUD_SDK_SK"); String projectId = "{project_id}"; ICredential auth = new BasicCredentials() .withProjectId(projectId) .withAk(ak) .withSk(sk); LiveClient client = LiveClient.newBuilder() .withCredential(auth) .withRegion(LiveRegion.valueOf("<YOUR REGION>")) .build(); CreateRecordCallbackConfigRequest request = new CreateRecordCallbackConfigRequest(); RecordCallbackConfigRequest body = new RecordCallbackConfigRequest(); List<RecordCallbackConfigRequest.NotifyEventSubscriptionEnum> listbodyNotifyEventSubscription = new ArrayList<>(); listbodyNotifyEventSubscription.add(RecordCallbackConfigRequest.NotifyEventSubscriptionEnum.fromValue("RECORD_FILE_COMPLETE")); body.withNotifyEventSubscription(listbodyNotifyEventSubscription); body.withNotifyCallbackUrl("https://mycallback.com.cn/record_notify"); body.withApp("**"); body.withPublishDomain("publish.example.com"); request.withBody(body); try { CreateRecordCallbackConfigResponse response = client.createRecordCallbackConfig(request); System.out.println(response.toString()); } catch (ConnectionException e) { e.printStackTrace(); } catch (RequestTimeoutException e) { e.printStackTrace(); } catch (ServiceResponseException e) { e.printStackTrace(); System.out.println(e.getHttpStatusCode()); System.out.println(e.getRequestId()); System.out.println(e.getErrorCode()); System.out.println(e.getErrorMsg()); } } } |
Creates a recording callback configuration.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 |
# coding: utf-8 import os from huaweicloudsdkcore.auth.credentials import BasicCredentials from huaweicloudsdklive.v1.region.live_region import LiveRegion from huaweicloudsdkcore.exceptions import exceptions from huaweicloudsdklive.v1 import * if __name__ == "__main__": # The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. # In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak = os.environ["CLOUD_SDK_AK"] sk = os.environ["CLOUD_SDK_SK"] projectId = "{project_id}" credentials = BasicCredentials(ak, sk, projectId) client = LiveClient.new_builder() \ .with_credentials(credentials) \ .with_region(LiveRegion.value_of("<YOUR REGION>")) \ .build() try: request = CreateRecordCallbackConfigRequest() listNotifyEventSubscriptionbody = [ "RECORD_FILE_COMPLETE" ] request.body = RecordCallbackConfigRequest( notify_event_subscription=listNotifyEventSubscriptionbody, notify_callback_url="https://mycallback.com.cn/record_notify", app="**", publish_domain="publish.example.com" ) response = client.create_record_callback_config(request) print(response) except exceptions.ClientRequestException as e: print(e.status_code) print(e.request_id) print(e.error_code) print(e.error_msg) |
Creates a recording callback configuration.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 |
package main import ( "fmt" "github.com/huaweicloud/huaweicloud-sdk-go-v3/core/auth/basic" live "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1" "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/model" region "github.com/huaweicloud/huaweicloud-sdk-go-v3/services/live/v1/region" ) func main() { // The AK and SK used for authentication are hard-coded or stored in plaintext, which has great security risks. It is recommended that the AK and SK be stored in ciphertext in configuration files or environment variables and decrypted during use to ensure security. // In this example, AK and SK are stored in environment variables for authentication. Before running this example, set environment variables CLOUD_SDK_AK and CLOUD_SDK_SK in the local environment ak := os.Getenv("CLOUD_SDK_AK") sk := os.Getenv("CLOUD_SDK_SK") projectId := "{project_id}" auth := basic.NewCredentialsBuilder(). WithAk(ak). WithSk(sk). WithProjectId(projectId). Build() client := live.NewLiveClient( live.LiveClientBuilder(). WithRegion(region.ValueOf("<YOUR REGION>")). WithCredential(auth). Build()) request := &model.CreateRecordCallbackConfigRequest{} var listNotifyEventSubscriptionbody = []model.RecordCallbackConfigRequestNotifyEventSubscription{ model.GetRecordCallbackConfigRequestNotifyEventSubscriptionEnum().RECORD_FILE_COMPLETE, } notifyCallbackUrlRecordCallbackConfigRequest:= "https://mycallback.com.cn/record_notify" request.Body = &model.RecordCallbackConfigRequest{ NotifyEventSubscription: &listNotifyEventSubscriptionbody, NotifyCallbackUrl: ¬ifyCallbackUrlRecordCallbackConfigRequest, App: "**", PublishDomain: "publish.example.com", } response, err := client.CreateRecordCallbackConfig(request) if err == nil { fmt.Printf("%+v\n", response) } else { fmt.Println(err) } } |
For SDK sample code of more programming languages, see the Sample Code tab in API Explorer. SDK sample code can be automatically generated.
Status Codes
Status Code |
Description |
---|---|
201 |
Recording callback created. |
400 |
Failed to create the recording callback. |
Error Codes
See Error Codes.
Feedback
Was this page helpful?
Provide feedbackThank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot