Help Center/ Live/ Cloud Live API Reference/ Notification Management/ Querying Stream Notification Configurations
Updated on 2025-11-06 GMT+08:00
View PDF

Querying Stream Notification Configurations

Function

Queries stream notification configurations.

Calling Method

For details, see Calling APIs.

Authorization Information

Each account has all the permissions required to call all APIs, but IAM users must be assigned the required permissions.

  • If you are using role/policy-based authorization, see Permissions Policies and Supported Actions for details on the required permissions.
  • If you are using identity policy-based authorization, the following identity policy-based permissions are required.

    Action

    Access Level

    Resource Type (*: required)

    Condition Key

    Alias

    Dependencies

    live:domain:getStreamNotifications

    Read

    -

    -

    -

    -

URI

GET /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

Ingest domain name.

Request Parameters

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.

Response Parameters

Status code: 200

Table 4 Response body parameters

Parameter

Type

Description

url

String

Callback URL.

auth_sign_key

String

Authentication key.

call_back_area

String

Area where the server for receiving callback notifications is located.

The options are as follows:

  • mainland_china: Chinese mainland

  • outside_mainland_china: outside the Chinese mainland

Status code: 400

Table 5 Response body parameters

Parameter

Type

Description

error_code

String

Error Code

error_msg

String

Error description

Example Requests

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

Example Responses

Status code: 200

Stream notification configurations queried.

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

Status code: 400

Query stream notification configurations failed.

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

Status Codes

Status Code

Description

200

Stream notification configurations queried.

400

Query stream notification configurations failed.

Error Codes

See Error Codes.

Parent topic: Notification Management