Help Center/ Media Processing Center/ API Reference/ Authorization and Configuration APIs/ Configuring Transcoding Server Event Notifications
Updated on 2024-03-14 GMT+08:00
Online Debugging
CLI Examples
View PDF

Configuring Transcoding Server Event Notifications

Function

Configures event notifications on the transcoding server.

Calling Method

For details, see Calling APIs.

URI

PUT /v1/{project_id}/notification

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

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 when AK/SK-based authentication is used.

X-Project_Id

No

String

Project ID. This parameter is mandatory when AK/SK-based authentication is used. It is same as the project ID in path parameters.

X-Sdk-Date

No

String

Time when the request is sent. This parameter is mandatory when AK/SK-based authentication is used.
Table 3 Request body parameters

Parameter

Mandatory

Type

Description

notifications

Yes

Array of Notification objects

Event notification template information
Table 4 Notification

Parameter

Mandatory

Type

Description

event_name

No

String

Name of a message event

status

No

String

Indicates whether an event notification template is selected.

topic

No

String

URN of the event notification topic

msg_type

No

Integer

Subscription message type

Response Parameters

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error code

error_msg

String

Error description

Example Requests

PUT https://{endpoint}/v1/{project_id}/notification

{
  "notifications" : [ {
    "event_name" : "TranscodeComplete",
    "topic" : "test",
    "msg_type" : 2,
    "status" : "on"
  } ]
}

Example Responses

Status code: 400

The message subscription configuration cannot be modified.

{
  "error_code" : "MPC.10202",
  "error_msg" : "Invalid request parameter."
}

Status Codes

Status Code

Description

204

The message subscription configuration has been modified.

400

The message subscription configuration cannot be modified.

Error Codes

See Error Codes.

Parent Topic: Authorization and Configuration APIs