Platform/Framework | Version number |
Android/iOS/Flutter/uni-app (client) | ≥ 1.7.1 |
Web | ≥ 1.4.6 |
WeChat Mini Program | ≥ 1.5.1 |
Callback status | Result indication |
Missed call: Recipient timeout before answering | not_answer |
Declined call: Recipient declined the call | reject |
Busy Line: Busy line | call_busy |
Cancel: Caller canceled the call before connecting | cancel |
Completion: Call connected and ended normally | normal_end |
Interruption: Call interrupted due to network or other reasons | interrupt |
https://www.example.com
.
Example:$http://www.example.com?sdkappid=$sdkappid&command=$command&contenttype=json&clientip=$clientip&optplatform=$optplatform
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 |
POST /?sdkappid=8888888&command=call_end&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","CallResult": "normal_end","EventTime": 170485688,"StartCallTs": 1704856873,"AcceptTs": 1704856876,"EndTs": 1704856885}
Field | Type | Description |
UserId | String | Operating User ID |
RoomId | String | Operating Room ID |
TotalNum | Integer | Number of Participants in Call |
MediaType | String | Media Type: Audio Audio CallVideo Video Call |
CallType | String | Call Type: Single Audio CallGroup Video Call |
CallId | String | Call Unique ID |
Role | String | role : Caller User IDCallee User ID |
CallResult | String | Call Result, only filled in during the end event, otherwise empty: Cancel : Caller canceled the call before connectionReject Declined: Recipient declined the callNot_answer Missed call: Recipient did not answer in timeNormal_end Completion: Call connected and ended normallyCall_busy Busy line: Busy line during callInterrupt Interruption: Call interrupted due to network or other reasons |
EventTime | Integer | Timestamp of operation (second-level) |
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 |
normal_end
.{"ErrorCode": 0,"ErrorMessage": "Success"}
Field | Type | Description |
ErrorCode | Integer | 0 indicates success, all other values indicate failure |
ErrorMessage | String | Your server response can carry error information as defined |
0s, 1s, 1s, 2s, 3s, 5s
. If all attempts fail, the process will be abandoned.Error code | Description |
0 | Request succeeded |
50001 | The current application needs to purchase the TUICallKit Group Call Version Package to use |
999 | Callback does not exist |
70001 | Invalid request parameters, please check whether mandatory parameters are missing or incorrectly entered |
70002 | UserSig is invalid |
70003 | UserSig has expired |
70004 | Requesting user is not a Super Administrator |
70005 | Request frequency limited |
Unknown error code |
Was this page helpful?