Call Event Callback
To facilitate refined control of your call services, the TRTC Call (TUICallKit) offers call status callbacks. Your business backend can use these callbacks to peek at users' call results in real-time, such as missed calls, rejections, etc., and based on this, perform real-time data analytics and other operations. For calling configuration methods, see Callback Configuration API List.
Use Conditions
Only applications (SDKAppId) that have activated the Group Call Version of TRTC Call can use the call status callback. You can also activate the trial version for a free trial. For version descriptions and activation instructions, see Activate the Service.
Currently, call status callbacks are available only in specific versions of TUICallKit across various platforms, as detailed in the table below:
Platform/Framework | Version number |
Android/iOS/Flutter/uni-app (client) | ≥ 1.7.1 |
Web | ≥ 1.4.6 |
WeChat Mini Program | ≥ 1.5.1 |
Note:
Only after all participating platforms/frameworks are upgraded to the versions mentioned above, can the corresponding call information be peeked at in the console.
Notes
To enable the callback, you must configure the callback URL and enable the switch for this command. Please refer to Create Callback Configuration.
The direction of the callback is from the Callkit backend to the app backend via an HTTP POST request.
After receiving the callback request, the app backend must check whether the SDKAppID contained in the request URL is consistent with its own SDKAppID.
Scenarios that may trigger this callback
Actions generated by an app user during a call via the client, such as answering and hanging up.
Timing of the callback
After operations by the user such as answering and hanging up.
Possible callback results
API description
Request URL
In the following example, the callback URL configured in the app is
https://www.example.com
.
Example:$http://www.example.com?sdkappid=$sdkappid&command=$command&contenttype=json&clientip=$clientip&optplatform=$optplatform
Request parameters
Parameter | Description |
http | Request protocol is HTTPS or HTTP, request method is POST |
www.example.com | Callback URL |
sdkappid | SDKAppID assigned by the Instant Messaging console when an application is created |
command | |
contenttype | Fixed value: json |
clientip | Client IP, such as 127.0.0.1 |
optplatform | Client platforms may include iOS, Android, Web, miniProgram |
The specific callback content is included in the HTTP request body. See the callback examples below for details.
Callback Example
Webhook request example:
POST /?sdkappid=8888888&command=caller_start_call&contenttype=json&clientip=127.0.0.1&optplatform=iOS HTTP/1.1Host: www.example.comContent-Length: 337{"UserId": "Alice","RoomId": "Alice's Room","TotalNum": 2,"MediaType": "audio","CallType": "single","CallId": "aheahfo-eqwnknoihfsd-qweqf","Role": "caller","Event": "start_call","CallResult": "","EventTime": 1704695566,"StartCallTs": 1704856873,"AcceptTs": 1704856876,"EndTs": 1704856885}
Request packet fields
Field | Type | Description |
UserId | String | Operating User ID |
RoomId | String | Operating Room ID |
TotalNum | Integer | Number of Participants in Call |
CallType | String | Call Type: Single Audio CallGroup Video Call |
CallId | String | Call Unique ID |
Role | String | role : Caller User IDCallee User ID |
Event | String | Call Event: start_call Caller initiates callcall_accepted Caller answers callcall_missed Caller missed callcall_rejected Caller rejects callcall_busy Caller line busycancel_call Caller cancels callcall_failed Caller failed to initiate callcall_end Caller call ended normallycall_interrupted Caller call interruptedreceive_call Callee receives callaccept_call Callee answers callnot_answer_call Callee does not answerreject_call Callee rejects callignore_call Called party ignores callcall_canceled Called party cancels callcall_end Normal termination of called party's callcall_interrupted Called party's call abnormally interruptedinvite_user Midway invite userjoin_in_group_call Join the call midway |
StartCallTs | Integer | Timestamp when call is initiated (second-level) only returned on normal_end |
AcceptTs | Integer | Timestamp when call is answered (second-level) only returned on normal_end |
EndTs | Integer | Timestamp when call ends (second-level) only returned on normal_end |
Note:
CallResult field shows all types only for one-on-one calls, group chat only has
normal_end
.