tencent cloud

Feedback

Establishing Callback Configuration

Last updated: 2024-04-18 15:40:48

    Feature Overview

    Administrators can create callbacks through this API.

    API description

    Note:
    If the API is called multiple times, the last result will prevail.

    Sample request URL

    https://xxxxxx/v1/callback/set?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

    Request parameters

    The table below only lists the parameters modified when calling this API and their description. For more information, please refer to REST API Overview.
    Parameter
    Description
    xxxxxx
    The reserved domain for the country/region where the SDKAppID is located:
    China: callkit.trtc.tencent-cloud.com
    v1/callback/set
    Request API
    sdkappid
    The sdkappid assigned by the console when creating an application
    identifier
    Must be an IM App Administrator Account
    usersig
    The Signature generated by the App Administrator account, for detailed operations, please refer to Generating UserSig
    random
    Enter a random 32-bit unsigned integer, range 0 to 4294967295
    contenttype
    The request format fixed value is json

    Maximum calling frequency

    10 times per second.

    Sample request packets

    {
    "address":"http://www.example.com/callback",
    "actions": [
    "call_busy",
    "normal_end",
    "caller_start_call",
    "invite_user",
    "callee_reject_call"
    ]
    }

    Request field description

    Field
    Type
    Attribute
    Description
    address
    String
    Mandatory
    Callback address, must start with http/https, it is recommended to use the more secure https
    actions
    Array
    Mandatory
    Scenarios that require triggering a callback, see the Callback Command List for the list

    Sample response packets

    {
    "errorCode": 0,
    "errorMessage": "Success",
    "requestId": "a1d8543a9b1daef5d0f0c21517a4bc0a",
    "data": "http://www.example.com/callback"
    }

    Response Packet Field Description

    Field
    Type
    Description
    errorCode
    Integer
    Error code, 0 indicates success
    errorMessage
    String
    Error message
    requestId
    String
    Unique Request ID
    data
    String
    Successful callback address configuration

    Error codes

    Error code
    Description
    0
    Request succeeded
    50001
    The current application needs to purchase the TUICallKit Group Call Version Package to use
    70001
    Callback address must start with http or https
    
    Contact Us

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

    Technical Support

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

    7x24 Phone Support