Changing the Channel Status

Function

Changes the channel status.

URI

PUT /v1/{project_id}/ott/channels/state

**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	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.
Access-Control-Allow-Internal	No	String	Service authentication token. If authentication is enabled for a service, Access-Control-Allow-Internal must be carried to access the service.
Access-Control-Allow-External	No	String	Service authentication token. If authentication is enabled for a service, Access-Control-Allow-External must be carried to access the service.

**Table 3** Request body parameters
Parameter	Mandatory	Type	Description
domain	Yes	String	Ingest domain name of a channel.
app_name	Yes	String	Group name or application name.
id	Yes	String	Unique ID of a channel. This parameter is mandatory. You are not advised to enter underscores (_) in a channel ID. Otherwise, transcoding and snapshot capturing will be affected.
state	Yes	String	Channel status. ON: After a channel is delivered, functions such as stream pull, transcoding, and recording are automatically enabled. OFF: Only the channel information is saved but the channel is not started.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
result_code	String	Error code.
result_msg	String	Error description.
domain	String	Ingest domain name.
app_name	String	Group name or application name. This parameter is mandatory.
id	String	Unique ID of a channel. This parameter is mandatory.
sources	Array of SourceRsp objects	Ingest URL list. During channel creation, the ingest URL list is returned only when the input stream protocol is RTMP_PUSH.

**Table 5** SourceRsp
Parameter	Type	Description
url	String	RTMP ingest URL.
bitrate	Integer	Bitrate. Unit: bit/s. Value range: 0–104,857,600 (100 Mbit/s)
width	Integer	Width corresponding to the resolution. Value range: 0–4096 (4K)
height	Integer	Height corresponding to the resolution. Value range: 0–2160 (4K)
enable_snapshot	Boolean	Whether to use the stream for snapshot capturing.

Status code: 400

**Table 6** Response body parameters
Parameter	Type	Description
result_code	String	Error code.
result_msg	String	Error description.
domain	String	Ingest domain name.
app_name	String	Group name or application name. This parameter is mandatory.
id	String	Unique ID of a channel. This parameter is mandatory.

Example Requests

PUT https://{endpoint}/v1/{project_id}/ott/channels/state

{
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test",
  "state" : "ON"
}

Example Responses

Status code: 200

Demo Information

{
  "result_code" : "LIVE.100000000",
  "result_msg" : "SUCCESS",
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test"
}

Status code: 400

Error response

{
  "result_code" : "LIVE.100011001",
  "result_msg" : "Request parameters is invalid, channel state has been turned OFF",
  "domain" : "push.testott.hls.com",
  "app_name" : "ott",
  "id" : "test"
}