Adding and Modifying Stream Notification Configurations

This API is used to add and modify stream notification configurations.

For details, see Calling APIs.

PUT /v1/{project_id}/notifications/publish

**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.

**Table 2** Query Parameters
Parameter	Mandatory	Type	Description
domain	Yes	String	Definition Ingest domain name. Constraints N/A Range Length: 1 to 255 characters Default Value N/A

**Table 3** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token. This parameter is mandatory when token authentication is used. It 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.

**Table 4** Request body parameters
Parameter	Mandatory	Type	Description
url	Yes	String	Definition Callback URL. Constraints N/A Range N/A Default Value N/A
auth_sign_key	No	String	Definition Authentication key. Constraints N/A Range Length: 32 to 128 characters Default Value N/A
call_back_area	No	String	Definition Region where the server for receiving callback notifications is located. Constraints N/A Range mainland_china: Chinese mainland outside_mainland_china: outside the Chinese mainland Default Value N/A

Status code: 200

Stream notification configuration modified.

Status code: 201

Stream notification configuration added.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error code.
error_msg	String	Error description.

PUT https://{endpoint}/v1/{project_id}/notifications/publish?domain=push.example.com

{
  "url" : "https://endpoint.com/v1/test"
}

Status code: 400

Modify the stream notification configuration failed.

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

Status Code	Description
200	Stream notification configuration modified.
201	Stream notification configuration added.
400	Modify the stream notification configuration failed.

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.