tencent cloud

Feedback

Query Callback Configuration

Last updated: 2024-09-24 15:07:19

    Feature Overview

    App administrators can create a callback through this interface.

    API Calling Description

    Sample request URL

    https://xxxxxx/v4/live_config/get_callback?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 RESTful API Overview.
    Parameter
    Description
    xxxxxxx
    The reserved domain for the country/region where the SDKAppID is located:
    China: console.tim.qq.com
    Singapore :adminapisgp.im.qcloud.com
    v4/livee_config/get_callback
    Request API
    sdkappid
    SDKAppID assigned by the Chat console when an app is created
    identifier
    Must be an App admin account. For more details, see App Administrator
    usersig
    Signature generated by the App admin account. For detailed instructions, see Generating UserSig
    random
    A random 32-bit unsigned integer ranging from 0 to 4294967295
    contenttype
    The request format fixed value is json

    Maximum calling frequency

    200 queries/sec.

    Sample request packets

    Basic form Create room
    {
    }

    Request packet fields

    Sample response packets

    Basic Form
    {
    "ErrorCode": 0,
    "ErrorInfo": "",
    "ActionStatus": "OK",
    "RequestId": "Id-1cc8828fd3d84795ac866ced43b15b5c-O-Seq-61309",
    "Response": {
    "Url": "http://www.example.com/callback",
    "CallbackCommandList": [
    "Live.CallbackAfterCreateRoom",
    "Live.CallbackAfterDestroyRoom"
    ]
    }
    }

    Response Packet Field Description

    Field
    Type
    Description
    ActionStatus
    String
    The result of the request process: OK indicates success; FAIL indicates failure
    ErrorCode
    Integer
    Error code. 0: success; other values: failure
    ErrorInfo
    String
    Error message
    RequestId
    String
    Unique Request ID is returned with each request and required to provide this RequestId when locating issues
    Url
    String
    Callback address, must start with http/https, it is recommended to use the more secure https
    CallbackCommandList
    Array
    For the command words that trigger the callback, refer to Callback Command Word List

    Error codes

    Unless a network error occurs (e.g., 502 error), the HTTP status code for this interface will always be 200. The actual error codes and messages are conveyed through ErrorCode and ErrorInfo in the response body. Common error codes (60000 to 79999) see Error Code documentation. The private error codes for this API are as follows:
    Error code
    Description
    100001
    Internal server error, please retry
    100002
    Invalid parameter. Please check the request according to the error description.
    100301
    Callback configuration does not exist, you can create it using the Create Callback Configuration interface
    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