CreateLiveCallbackTemplate

Last updated: 2020-08-10 16:56:34

    1. API Description

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

    This API is used to create a callback template. After a template ID is successfully returned, you need to call the CreateLiveCallbackRule API to bind the template ID to the domain name/path.

    Callback protocol document: Event Message Notification.

    A maximum of 200 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 parameter. The value used for this API: CreateLiveCallbackTemplate.
    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.
    TemplateName Yes String Template name.
    Maximum length: 255 bytes.
    Only letters, digits, underscores, and hyphens can be contained.
    Description No String Description.
    Maximum length: 1,024 bytes.
    Only letters, digits, underscores, and hyphens can be contained.
    StreamBeginNotifyUrl No String Stream starting callback URL,
    Protocol document: Event Message Notification.
    StreamEndNotifyUrl No String Interruption callback URL,
    Protocol document: Event Message Notification.
    RecordNotifyUrl No String Recording callback URL,
    Protocol document: Event Message Notification.
    SnapshotNotifyUrl No String Screencapturing callback URL,
    Protocol document: Event Message Notification.
    PornCensorshipNotifyUrl No String Porn detection callback URL,
    Protocol document: Event Message Notification.
    CallbackKey No String Callback key. The callback URL is public. For the callback signature, please see the event message notification document.
    Event Message Notification.

    3. Output Parameters

    Parameter Name Type Description
    TemplateId Integer Template ID.
    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=CreateLiveCallbackTemplate
    &TemplateName=testName
    &Description=test
    &CallbackKey=adasda131312
    &StreamBeginNotifyUrl=http://www.yourdomain.com/api/notify?action=streamBegin
    &StreamEndNotifyUrl=http://www.yourdomain.com/api/notify?action=streamEnd
    &RecordNotifyUrl=http://www.yourdomain.com/api/notify?action=record
    &SnapshotNotifyUrl=http://www.yourdomain.com/api/notify?action=snapshot
    &PornCensorshipNotifyUrl=http://www.yourdomain.com/api/notify?action=porn
    &<Common request parameters>

    Output Example

    {
      "Response": {
        "TemplateId": 1000,
        "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
    FailedOperation.ConfInUsed The template is in use.
    FailedOperation.NotFound No records found.
    InternalError Internal error.
    InternalError.ArgsNotMatch For the transcoding template adding API.
    InternalError.ConfInUsed The template is in use.
    InternalError.ConfNotFound The template does not exist.
    InternalError.ConfOutLimit The number of templates exceeds the limit.
    InternalError.InvalidInput Parameter check failed.
    InternalError.NotFound The record does not exist.
    InternalError.RuleAlreadyExist The rule has already been configured.
    InternalError.RuleInUsing The rule is in use.
    InternalError.RuleNotFound The rule does not exist.
    InternalError.RuleOutLimit The rule exceeds the limit.
    InvalidParameter Invalid parameter.
    InvalidParameter.ArgsNotMatch Incorrect template name.
    InvalidParameter.COSCustomFileNameError Incorrect custom COS filename.
    InvalidParameter.InvalidVodFileName Incorrect VodFileName.
    InvalidParameterValue Wrong parameter value.
    MissingParameter Missing parameter.

    Was this page helpful?

    Was this page helpful?

    • Not at all
    • Not very helpful
    • Somewhat helpful
    • Very helpful
    • Extremely helpful
    Send Feedback
    Help