Adding and Modifying Stream Notification Configurations
Function
Adds and modifies stream notification configurations.
Calling Method
For details, see Calling APIs.
URI
PUT /v1/{project_id}/notifications/publish
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
project_id |
Yes |
String |
Project ID. For details about how to obtain the project ID, see Obtaining a Project ID. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
domain |
Yes |
String |
Ingest domain name. |
Request 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. |
|
Parameter |
Mandatory |
Type |
Description |
|---|---|---|---|
|
url |
Yes |
String |
Callback URL. |
|
auth_sign_key |
No |
String |
Authentication key. |
|
call_back_area |
No |
String |
Area where the server for receiving callback notifications is located. The options are as follows:
|
Response Parameters
Status code: 400
|
Parameter |
Type |
Description |
|---|---|---|
|
error_code |
String |
Error Code |
|
error_msg |
String |
Error description |
Example Requests
PUT https://{endpoint}/v1/{project_id}/notifications/publish?domain=push.example.com
{
"url" : "https://endpoint.com/v1/test"
}
Example Responses
Status code: 400
Modify the stream notification configuration failed.
{
"error_code" : "LIVE.100011001",
"error_msg" : "Request Illegal"
}
Status Codes
|
Status Code |
Description |
|---|---|
|
200 |
Stream notification configuration modified. |
|
201 |
Stream notification configuration added. |
|
400 |
Modify the stream notification configuration failed. |
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.
