Domain name for API request: iss.intl.tencentcloudapi.com.
Forbid the live preview of video channels for root accounts and sub-accounts.
A maximum of 5 requests can be initiated per second for this API.
The following request parameter list only provides API request parameters and some common parameters. For the complete common parameter list, see Common Request Parameters.
| Parameter Name | Required | Type | Description |
|---|---|---|---|
| Action | Yes | String | Common Params. The value used for this API: SetForbidPlayChannels. |
| Version | Yes | String | Common Params. The value used for this API: 2023-05-17. |
| Region | Yes | String | Common Params. For more information, please see the list of regions supported by the product. |
| Channels.N | Yes | Array of SetForbidplayChannelParam | Channel parameters to be disabled. Up to 200 channels can be set at a time. |
| UserId | Yes | String | User uin, which can be the uin of a sub-user or a root user |
| Parameter Name | Type | Description |
|---|---|---|
| RequestId | String | The unique request ID, generated by the server, will be returned for every request (if the request fails to reach the server for other reasons, the request will not obtain a RequestId). RequestId is required for locating a problem. |
POST / HTTP/1.1
Host: iss.intl.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: SetForbidPlayChannels
<Common request parameters>
{
"UserId": "10********02",
"Channels": [
{
"ChannelId": "0001a415-****-****-****-b13cfb96c778",
"Enable": true
},
{
"ChannelId": "00037e5f-****-****-****-f30b13a86b02",
"Enable": false
}
]
}{
"Response": {
"RequestId": "fba7981b-d6a4-4177-b11d-e53a6110e4cd"
}
}TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.
The following only lists the error codes related to the API business logic. For other error codes, see Common Error Codes.
| Error Code | Description |
|---|---|
| FailedOperation.NotHaveSubUser | No such sub-user |
| InternalError.ServerInternalError | Internal server error. |
| InvalidParameter.InvalidChannels | Invalid channel parameters |
| InvalidParameterValue.ChannelsExceedsRange | Number of channels exceeds the limit range. |
| InvalidParameterValue.IllegalChannelId | Channel ID contains illegal characters |
| InvalidParameterValue.InvalidChannelId | Invalid channel ID |
| InvalidParameterValue.InvalidEnalbeValue | Invalid enable parameter |
| InvalidParameterValue.InvalidUserParam | Invalid user parameter |
| MissingParameter.MissingMustParameter | Lack of required parameters |
| MissingParameter.MissingUserInfo | Lack of user information |
| OperationDenied.NoWhitelist | The feature requires allowlist configuration. To use it, you need to apply. |
| OperationDenied.PlayAuthNotEnabled | Playback authentication is not enabled |
Was this page helpful?
You can also Contact sales or Submit a Ticket for help.
Help us improve! Rate your documentation experience in 5 mins.
Feedback