DescribeLiveCallbackTemplate

Last updated: 2020-05-09 14:26:56

PDF

1. API Description

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

This API is used to get a single callback template.

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

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 parameter. The value used for this API: DescribeLiveCallbackTemplate.
Version Yes String Common parameter. The value used for this API: 2018-08-01.
Region No String Common parameter. This parameter is not required for this API.
TemplateId Yes Integer Template ID.
1. Get the template ID in the returned value of the CreateLiveCallbackTemplate API call.
2. You can query the list of created templates through the DescribeLiveCallbackTemplates API.

3. Output Parameters

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

4. Example

Example1 Sample request

Input Example

https://live.tencentcloudapi.com/?Action=DescribeLiveCallbackTemplate
&TemplateId=1000
&<Common request parameters>

Output Example

{
  "Response": {
    "Template": {
      "TemplateId": 1000,
      "TemplateName": "testName",
      "Description": "test",
      "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=record",
      "PornCensorshipNotifyUrl": "http://www.qq.com/api/notify?action=porn",
      "CallbackKey": "adasdasda1312312"
    },
    "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
  }
}

5. Developer Resources

API Explorer

This tool allows online call, signature authentication, SDK code generation and quick search of APIs to greatly improve the efficiency of using TencentCloud APIs.

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
InternalError Internal error.
InvalidParameter Invalid parameter.
InvalidParameterValue Wrong parameter value.
MissingParameter Missing parameter.