Call

Web
- Overview
  - Product Introduction
  - Activate the Service
  - Pricing
    - Free Minutes
    - Call Monthly Packages
    - Billing Explanation for Subscription Package Duration
- Get Started
  - Run Sample Code
  - Integration (React)
  - Integration (Vue3)
  - Secure authentication with userSig
- Basic Features
  - UI Customization
  - Configuring Nickname and Avatar
  - GroupCall
  - Floating Window
  - Custom Ringtone
  - Configure Resolution and Fill Mode
  - Monitoring Call Status
  - Language Settings
- Advanced Features
  - Virtual Background
  - AI Noise Suppression
  - On-Cloud Recording
- Client APIs
  - UIKit APIs
    - API Overview
    - TUICallKit
  - Engine APIs
    - TUICallEngine
    - TUICallEvent
- Server APIs
  - Call Status Callback
    - Call Status Callback
    - Call Event Callback
    - Callback Configuration
      - API List for Callback Configuration
      - Establishing Callback Configuration
      - Retrieving Callback Configuration
      - Update Callback Configuration
      - Remove Callback Configuration
  - REST API
    - Introduction to REST API
    - Retrieve records via callId
    - Retrieve Records Based on Conditions
- FAQs
  - All Platfroms
  - Web
  - ErrorCode
  - Release Notes
Android
- Overview
  - Product Introduction
  - Activate the Service
  - Pricing
    - Free Minutes
    - Call Monthly Packages
    - Billing Explanation for Subscription Package Duration
- Get Started
  - Run Sample Code
  - Integration
  - Secure authentication with userSig
- Basic Features
  - UI Customization
  - Offline Call Push
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- Advanced Features
  - Virtual Background
  - AI Noise Suppression
  - On-Cloud Recording
- Client APIs
  - UIKit APIs
    - API Overview
    - TUICallKit
    - TUICallObserver
    - Type Definition
  - Engine APIs
    - TUICallEngine
- Server APIs
  - Call Status Callback
    - Call Status Callback
    - Call Event Callback
    - Callback Configuration
      - API List for Callback Configuration
      - Establishing Callback Configuration
      - Retrieving Callback Configuration
      - Update Callback Configuration
      - Remove Callback Configuration
  - REST API
    - Introduction to REST API
    - Retrieve records via callId
    - Retrieve Records Based on Conditions
- FAQs
  - All Platforms
  - Android
  - ErrorCode
  - Release Notes
iOS
- Overview
  - Product Introduction
  - Activate the Service
  - Pricing
    - Free Minutes
    - Call Monthly Packages
    - Billing Explanation for Subscription Package Duration
- Get Started
  - Run Sample Code
  - Integration
  - Secure authentication with userSig
- Basic Features
  - UI Customization
  - Offline Call Push
    - VoIP
    - APNs
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- Advanced Features
  - Virtual Background
  - AI Noise Suppression
  - On-Cloud Recording
- Client APIs
  - UIKit APIs
    - API Overview
    - TUICallKit
    - TUICallObserver
    - Type Definition
  - Engine APIs
    - TUICallEngine
- Server APIs
  - Call Status Callback
    - Call Status Callback
    - Call Event Callback
    - Callback Configuration
      - API List for Callback Configuration
      - Establishing Callback Configuration
      - Retrieving Callback Configuration
      - Update Callback Configuration
      - Remove Callback Configuration
  - REST API
    - Introduction to REST API
    - Retrieve records via callId
    - Retrieve Records Based on Conditions
- FQAs
  - All Platform
  - iOS
  - ErrorCode
  - Release Notes
Flutter
- Overview
  - Product Introduction
  - Activate the Service
  - Pricing
    - Free Minutes
    - Call Monthly Packages
    - Billing Explanation for Subscription Package Duration
- Get Started
  - Run Sample Code
  - Integration
  - Secure authentication with userSig
- Basic Features
  - UI Customization
  - offline Call Push
    - Notification
    - VoIP (Optional)
  - Configuring Nicknames and Avatars
  - Group Call
  - Floating Window
  - Custom Ringtone
  - Monitoring Call Status
- Advanced Features
  - Virtual Background
  - AI Noise Suppression
  - On-Cloud Recording
  - Beauty Effects
- Client APIs
  - API Overview
  - TUICallKit
  - TUICallEngine
  - TUICallObserver
  - Type Definition
- Server APIs
  - Call Status Callback
    - Call Status Callback
    - Call Event Callback
    - Callback Configuration
      - API List for Callback Configuration
      - Establishing Callback Configuration
      - Retrieving Callback Configuration
      - Update Callback Configuration
      - Remove Callback Configuration
  - REST API
    - Introduction to REST API
    - Retrieve records via callId
    - Retrieve Records Based on Conditions
- FQAs
  - All Platform
  - Flutter
  - ErrorCode
  - Upgrading
  - Release Notes

Call

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=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 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
﻿
﻿

Feature Overview
API description
Error codes

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`

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 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