Callback Overview
To facilitate control over the app's features, LiveKit offers callback capabilities.
Feature Overview
Users can configure a callback to a specified URL via REST API. When the executed CallbackCommand is on the configuration list, it will trigger the callback.
Notes
Only one callback can be set per sdkAppId.
Ensure that the callback URL is accessible.
Callback Protocol
Third-party callbacks are based on HTTP/HTTPS protocols. The app backend must provide a callback URL to the live platform, and Instant Chat uses a POST request to initiate a callback to the app backend. When initiating a callback, Chat adds the following parameters to the URL provided by the app:
Parameter | Meaning |
SdkAppId | SDKAppId assigned by the Chat console when an app is created |
CallbackCommand | Callback Command Word |
contenttype | Optional, usually set to JSON |
ClientIP | Client IP address |
OptPlatform | Client Platform, corresponding to different Platform Types, possible values include: RESTAPI (sending requests using REST API), Web (sending requests using Web SDK), Android, iOS, Windows, Mac, iPad, Unknown (sending requests using an unknown type of device) |