Docs Overview/
Call/
Web/
Server APIs/
Call Status Callback/
Callback Configuration/
Retrieving Callback Configuration/

Retrieving Callback Configuration

Feature Overview

Administrators can query configured callbacks through this interface.

API description

Sample request URL

https://xxxxxx/v1/callback/get?sdkappid=88888888&identifier=administrator&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:
callkit-intl.trtc.tencent-cloud.com
v1/callback/get
Request API
sdkappid
The sdkappid assigned by the console when creating an application
identifier
Must be an Chat App Administrator Account
usersig
The Signature generated by the App Administrator account, for detailed operations, please refer to 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

10 times per second.

Sample request packets

Passing empty is sufficient.
{

}

Sample response packets

{
    "errorCode": 0, 
    "errorMessage": "Success",
    "requestId": "355c3c394f0602ed81a13c34999abebb", 
    "data": {
        "actions": [ 
            "call_busy",
            "normal_end"
        ],
        "address": "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
actions
Array
Configured callback actions
address
String
Configured callback address

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