Enable Close Push

Last updated: 2018-08-01 21:02:12

1. API Description

  • API
    Live_Channel_SetStatus:
    This API is used to disable, interrupt and enable an LVB stream. Disable means the stream ID is no longer available for push. If the push is in progress, it will be interrupted and cannot be resumed. Interrupt means suspending the stream being pushed, which can be re-pushed later. Enable means enabling the stream ID and allowing it to push streams.
  • URL
    URL for calling API: http://fcgi.video.qcloud.com/common_access
  • Purpose
    This API is used to ban an LVB during porn detection. For example, if a VJ is found to play porny or rebellious content, this LVB stream can be interrupted or disabled at any time.
  • Note
    Once an LVB stream is set as disabled, Tencent Cloud actively disconnects the push linkage and rejects subsequent push requests. A stream can be disabled for up to 3 months. The disabling expires after 3 months.

2. Input Parameters

Parameter Name Description Type Note Required
appid Customer ID int LVB APPID used for identifying customers Y
interface API name string Live_Channel_SetStatus Y
t Validity period int UNIX timestamp (decimal) Y
sign Security signature string MD5(key+t) Y
Param.s.channel_id LVB Code string Y
Param.n.status Status int 0: Disabled; 1: Enabled for push; 2: Stream interrupted Y

Note:
For historical reasons, the LVB Code parameter was defined as channel_id in some earlier APIs, and is defined as stream_id in new APIs.

3. Output Parameters

Parameter Name Description Type Note
ret Error code int 0: Successful; other values: Failed.
message Error message string Error message

4. Example

Purpose: To ban the LVB stream with an LVB Code of 8888_test123 whose content has violated relevant regulations.

Component Example
API URL http://fcgi.video.qcloud.com/common_access?
appid 1234
interface Live_Channel_SetStatus
Param.s.channel_id 8888_test123
Param.n.status 0
t 1471850187
sign b17971b51ba0fe5916ddcd96692e9fb3
//When copying them, remove the invisible line breaks used for improving layout. Otherwise, URL construction errors may occur, such as "appid is invalid".
 URL = http://fcgi.video.qcloud.com/common_access?
            appid=1234&interface=Live_Channel_SetStatus
            &Param.s.channel_id=8888_test123
            &Param.n.status=0
            &t=1471850187&sign=b17971b51ba0fe5916ddcd96692e9fb3