Contents:
1. API Description
API request domain name: live.tencentcloudapi.com.
After a callback template is created and a template ID is successfully returned, you need to call the CreateLiveCallbackRule API and bind the template ID to the domain name/path.
Callback protocol-related document: Event Message Notification.
Default API request rate limit: 200 requests/second.
2. Request Parameters
The following parameters are required for requesting this API, including action-specific parameters and common parameters. For more information about common parameters for all requests, see Common Request Parameters.
Parameter name | Required | Type | Description |
---|---|---|---|
Action | Yes | String | Common parameter; the name of this API: CreateLiveCallbackTemplate |
Version | Yes | String | Common parameter; the version of this API: 2018-08-01 |
Region | No | String | Common parameter; optional for this API |
TemplateName | Yes | String | Template name. Non-empty string. |
Description | No | String | Description information |
StreamBeginNotifyUrl | No | String | Stream start callback URL. Relevant protocol document: Event Message Notification. |
StreamEndNotifyUrl | No | String | Stream end callback URL. Relevant protocol document: Event Message Notification. |
RecordNotifyUrl | No | String | Recording callback URL. Relevant protocol document: Event Message Notification. |
SnapshotNotifyUrl | No | String | screencapture callback URL. Relevant protocol document: Event Message Notification. |
PornCensorshipNotifyUrl | No | String | Porn detection callback URL. Relevant protocol document: Event Message Notification. |
CallbackKey | No | String | Callback key, which is shared by callback URLs. For authentication callback details, see the callback format document |
3. Return Parameters
Parameter name | Type | Description |
---|---|---|
TemplateId | Integer | Template ID. |
RequestId | String | The ID of the request. Each request returns a unique ID. The RequestId is required to troubleshoot issues. |
4. Sample
Request Sample
Input Sample Code
https://live.tencentcloudapi.com/?Action=CreateLiveCallbackTemplate
&TemplateName=testName
&Description=test
&CallbackKey=adasda131312
&StreamBeginNotifyUrl=http://www.qq.com/api/notify?action=streamBegin
&StreamEndNotifyUrl=http://www.qq.com/api/notify?action=streamEnd
&StreamMixNotifyUrl=http://www.qq.com/api/notify?action=streamMix
&RecordNotifyUrl=http://www.qq.com/api/notify?action=record
&SnapshotNotifyUrl=http://www.qq.com/api/notify?action=snapshot
&PornCensorshipNotifyUrl=http://www.qq.com/api/notify?action=porn
&<Common request parameter>
Output Sample Code
{
"Response": {
"TemplateId": 1000,
"RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}
5. Developer Resources
API Explorer
API Explorer is a tool that provides ease of use in requesting APIs, authenticating identities, generating SDK and exploring APIs in Tencent Cloud environment.
SDK
Cloud API 3.0 comes with a set of complementary development toolkits (SDKs) that support multiple programming languages and make it easier to call the API.
- Tencent Cloud SDK 3.0 for Python
- Tencent Cloud SDK 3.0 for Java
- Tencent Cloud SDK 3.0 for PHP
- Tencent Cloud SDK 3.0 for Go
- Tencent Cloud SDK 3.0 for NodeJS
- Tencent Cloud SDK 3.0 for .NET
TCCLI
6. Error Codes
The following error codes are API business logic-related. For other error codes, see Common Error Codes.
Error Code | Description |
---|---|
InternalError | Internal error |
InvalidParameter | Parameter error |
InvalidParameterValue | Incorrect parameter value |
MissingParameter | Missing parameter |