tencent cloud

All product documents
Tencent Real-Time Communication
DocumentationTencent Real-Time CommunicationMulti-Participant Conference (with UI)Server APIs (TUIRoomKit)Third-Party CallbackCallback ConfigurationQuery Callback Configuration
Query Callback Configuration
Download PDF
Last updated: 2024-06-12 11:46:26
Query Callback Configuration
Last updated: 2024-06-12 11:46:26
Download PDF

Feature Overview

App administrators can get a callback through this API.

API Calling Description

Sample Request URL

https://xxxxxx/v4/room_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. For more details, please refer to RESTful API Overview.
Parameter
Description
xxxxxx
The reserved domain name for the country/region where the SDKAppID is located:
Singapore :adminapisgp.im.qcloud.com
v4/room_config/get_callback
Request API
sdkappid
The SDKAppID assigned by the Chat console when an app is created
identifier
Must be an App administrator account. For more details, please refer to App Administrator.
usersig
The Signature generated by the App administrator account. For more details, please refer to Generating UserSig.
random
Enter a random 32-bit unsigned integer ranging from 0 to 4294967295
contenttype
The request format fixed value is json

Maximum Calling Frequency

200 times per second.

Sample Request Packets

Basic Form Just pass it empty.
{
}

Request Packet Field Description

Sample Response Packets

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

Response Packet Field Description

Field
Type
Description
ActionStatus
String
The result of the request process. OK for success, FAIL for failure.
ErrorCode
Integer
Error code. 0 for success, others for failure.
ErrorInfo
String
Error message
RequestId
String
The 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. For 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
The parameter is invalid, please check the request for correctness based on the error description.
100301
Callback configuration does not exist, you can create it using the Create Callback Configuration interface.



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

Feedback

Contact Us

Contact our sales team or business advisors to help your business.

Contact Us
Technical Support

Open a ticket if you're looking for further assistance. Our Ticket is 7x24 avaliable.

Submit a Ticket
7x24 Phone Support
Hong Kong, China
+852 800 906 020 (Toll Free)
United States
+1 844 606 0804 (Toll Free)
United Kingdom
+44 808 196 4551 (Toll Free)
Canada
+1 888 605 7930 (Toll Free)
Australia
+61 1300 986 386 (Toll Free)
EdgeOne hotline
+852 300 80699
More local hotlines coming soon