このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。
Docs Overview/
Live/
Server APIs/
Third-Party Callback/
Callback Configuration/
Create Callback Configuration/

Create Callback Configuration

Feature Overview

App administrators can create callback configurations through this interface.

API Calling Description

Sample request URL

https://console.tim.qq.com/v4/live_config/set_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
v4/live_config/set_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
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 Create room
{
  "Url":"http://www.example.com/callback",
  "CallbackCommandList":[
      "Live.CallbackAfterCreateRoom",
      "Live.CallbackAfterDestroyRoom",
      "Live.CallbackAfterMemberStateChanged"
  ]
}

Request packet fields

Field
Type
Attribute
Description
Url
String
Mandatory
Callback address, must start with http/https, it is recommended to use the more secure https
CallbackCommandList
Array
Mandatory
For the command words that trigger the callback, refer to Callback Command Word List

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.
100300
Callback configuration already exists, you can use the update callback configuration interface to update