tencent cloud

Set Webhook Authentication Token​​
Download PDF
Last updated: 2025-06-23 10:17:55
Set Webhook Authentication Token​​
Last updated: 2025-06-23 10:17:55
Download PDF

Feature Overview

App administrators can create or update webhook authentication token through this interface. For detailed usage of Token, see Security Considerations.

API Calling Description

Sample request URL

https://xxxxxx/v4/live_config/set_callback_token?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
America : adminapiusa.im.qcloud.com
v4/live_config/set_callback_token
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
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

200 queries/sec.

Sample request packets

Basic form
{
    "Token" : "kdjsgjdskgjwejsdkkjgkjfklgjdfkjhnkdfhjgkglasdjkfjsekdhgjfsdhgsdjgkdjskgjfhjdfkjgsfdkjgeljsfkjsdkgdfkhgdfjgksdjfsdkjfksdgskhgssss",
    "IsTokenEnable" : true
}

Request packet fields

Field
Type
Attribute
Description
Token
String
Required for first time setup
Webhook authentication token value, The maximum length of the token is 128, and the minimum length is 1, See Security Considerations for usage.
IsTokenEnable
Bool
Required for first time setup
Whether webhook authentication is enabled, true means enabled, false means disabled
Note：
When the webhook authentication token configuration does not exist, all parameters must be filled in. When the webhook authentication token configuration exists, only the options that need to be modified need to be filled in.

Sample response packets

Basic Form
{
  "ActionStatus": "OK",
  "ErrorInfo": "",
  "ErrorCode": 0,
  "RequestId": "Id-8c9858f01e954611ae2d4c1b1ed7d583-O-Seq-52720"
}

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

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.

Was this page helpful?
You can also Contact Sales or Submit a Ticket for help.
Yes
No

Feedback