このページは現在英語版のみで提供されており、日本語版も近日中に提供される予定です。ご利用いただきありがとうございます。

Callback after Call Initiation

Feature Description
The App backend can view the start dynamics of a call in real time through this callback.	
Must-Knows
To enable the callback, you must configure the callback URL through the REST API and turn on the switch corresponding to this callback protocol. For the configuration method, see Set Callback Configuration.
The direction of the callback is that the Call backend initiates an HTTP POST request to the App backend.
After receiving a callback request, the App backend needs to verify whether the value of the SDKAppID parameter in the request URL is its own SDKAppID.
Callback Triggering Scenarios
App user initiates a successful call through the client.
Callback Triggering Timing
After call initiation.
API Description
Sample Request URL
In the following example, the callback URL configured for the App is https://www.example.com.
Example:
https://www.example.com?SdkAppid=$SDKAppID&CallbackCommand=$CallbackCommand&contenttype=json&ClientIP=$ClientIP&OptPlatform=$OptPlatform
Request Parameters
Parameter
Description
https
The request protocol is HTTPS, and the request method is POST
www.example.com
Callback URL
SdkAppid
Assigned SDKAppID in the Chat console when creating an application
CallbackCommand
Fixed as Call.CallbackAfterStartCall
contenttype
The fixed value is json
ClientIP
Client IP address, in the format of 127.0.0.1
OptPlatform
Client platform. For the parameter meaning, see OptPlatform in Third-Party Callback Introduction: Callback Protocol﻿
Sample Request Packet
{
    "CallbackCommand":"Call.CallbackAfterStartCall",
    "CallInfo":{
        "CallId":"055662e1-bc8a-469c-a334-1126c8c17d58",
        "CallMediaType":"Audio",
        "ChatGroupId":"",
        "RoomId":"",
        "RoomIdType":1
    },
    "UserList":[
        {
            "User_Account":144115212830834855,
            "Status":"Calling"
        },
        {
            "User_Account":144115212948889925,
            "Status":"Waiting"
        }
    ],
    "EventTime":1740464128807
}
Request Packet Fields
Field
Type
Description
CallbackCommand
String
Callback command
CallId
String
Call ID
MediaType
String
Media type:
Video video call
Audio audio call
ChatGroupId
String
Chat Group ID
RoomId
String
TRTC Room ID
RoomIdType
Integer
TRTC room ID type:
1digit room number
2string Room Number
UserList
Array
Call Member List
User_Account
String
Calling User ID
Status
String
Call status
Calling in a call
Waiting waiting to connect
EventTime
Integer
Event-triggered millisecond timestamp
Sample Response Packet
The response packet is returned after the App backend synchronizes the data.
{
    "ActionStatus": "OK",
    "ErrorInfo": "",
    "ErrorCode": 0 // Ignore callback result
}
Response Packet Fields
Field
Type
Required
Description
ActionStatus
String
Required
Request processing result. OK indicates successful processing; FAIL indicates failure
ErrorInfo
String
Required
Error message
ErrorCode
Integer
Required
Error code. Enter 0 here to ignore the callback result
﻿
﻿

Parameter	Description
https	The request protocol is HTTPS, and the request method is POST
www.example.com	Callback URL
SdkAppid	Assigned SDKAppID in the Chat console when creating an application
CallbackCommand	Fixed as `Call.CallbackAfterStartCall`
contenttype	The fixed value is `json`
ClientIP	Client IP address, in the format of `127.0.0.1`
OptPlatform	Client platform. For the parameter meaning, see OptPlatform in Third-Party Callback Introduction: Callback Protocol

Field	Type	Description
CallbackCommand	String	Callback command
CallId	String	Call ID
MediaType	String	Media type: `Video` video call `Audio` audio call
ChatGroupId	String	Chat Group ID
RoomId	String	TRTC Room ID
RoomIdType	Integer	TRTC room ID type: `1`digit room number `2`string Room Number
UserList	Array	Call Member List
User_Account	String	Calling User ID
Status	String	Call status `Calling` in a call `Waiting` waiting to connect
EventTime	Integer	Event-triggered millisecond timestamp

Field	Type	Required	Description
ActionStatus	String	Required	Request processing result. OK indicates successful processing; FAIL indicates failure
ErrorInfo	String	Required	Error message
ErrorCode	Integer	Required	Error code. Enter 0 here to ignore the callback result