tencent cloud

All product documents
APIs
DocumentationAPIsCloud Streaming ServicesLive Stream Mix APIsCancelCommonMixStream
CancelCommonMixStream
Last updated: 2023-09-06 15:06:26
CancelCommonMixStream
Last updated: 2023-09-06 15:06:26

1. API Description

Domain name for API request: live.tencentcloudapi.com.

This API is used to cancel a stream mix. It can be used basically in the same way as mix_streamv2.cancel_mix_stream.

A maximum of 100 requests can be initiated per second for this API.

We recommend you to use API Explorer
Try it
API Explorer provides a range of capabilities, including online call, signature authentication, SDK code generation, and API quick search. It enables you to view the request, response, and auto-generated examples.

2. Input Parameters

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: CancelCommonMixStream.
Version Yes String Common Params. The value used for this API: 2018-08-01.
Region No String Common Params. This parameter is not required for this API.
MixStreamSessionId Yes String ID of stream mix session (from applying for stream mix to canceling stream mix).
This value is the same as the MixStreamSessionId in CreateCommonMixStream.

3. Output Parameters

Parameter Name Type Description
RequestId String The unique request ID, which is returned for each request. RequestId is required for locating a problem.

4. Example

Example1 Canceling stream mix

This example shows you how to cancel a stream mix by session ID.

Input Example

https://live.tencentcloudapi.com/?Action=CancelCommonMixStream
&MixStreamSessionId=test_room
&<Common request parameters>

Output Example

{
    "Response": {
        "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
    }
}

5. Developer Resources

SDK

TencentCloud API 3.0 integrates SDKs that support various programming languages to make it easier for you to call APIs.

Command Line Interface

6. Error Code

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 Operation failed.
FailedOperation.CallOtherSvrError Failed to call the third-party service.
FailedOperation.CallOtherSvrFailed Failed to call the internal service.
FailedOperation.CancelSessionNotExist The canceled stream mix session does not exist.
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameter.CancelSessionNotExist The canceled session does not exist.
InvalidParameter.OtherError Other errors.
ResourceNotFound.ForbidService You are blocked.
ResourceNotFound.FreezeService Service suspended.
ResourceNotFound.StopService The service has been suspended due to account arrears. Please top up it to a positive balance to activate the service first.
ResourceNotFound.UserDisableService You disabled the service.
Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon