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

Update Callback Configuration

Feature Overview

Administrators can update callbacks through this interface.

API description

Sample request URL

https://xxxxxx/v1/callback/update?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/update
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

{
    "address": "https://www.example2.com/callback",
    "actions": [
        "call_busy",
        "cancel",
        "normal_end"
    ]
}

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 requiring callback triggering, please refer to the Callback Command Word List

Sample response packets

{
    "errorCode": 0,
    "errorMessage": "Success",
    "requestId": "5b0fa500064397cad3554506e27e18e1",
    "data": "https://www.example2.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
Callback address updated successfully

Error codes

Error code
Description
0
Request succeeded
50001
The current application needs to purchase the TUICallKit Group Call Version Package to use
999
No configuration information