CallsApi
All URIs are relative to https://business.apis.kesk.app/v1
| Method | HTTP request | Description |
|---|---|---|
| appEndCall | POST /calls/{session_id}/end | End an active call session |
| appGetCallDetails | GET /calls/{session_id} | Get call session details |
| appInitiateCall | POST /calls/initiate | Initiate a new call session |
| appNotifyCallReceiver | POST /calls/{session_id}/notify | Notify receiver of incoming call |
appEndCall
EndCallResponse appEndCall(session_id)
End an active call session
Terminates an ongoing call session and updates the status in both Cloudflare Calls and the local database. Records the end timestamp for duration tracking.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| session_id | String | Unique session ID of the call to end | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
appGetCallDetails
CallSessionDetailsResponse appGetCallDetails(session_id)
Get call session details
Retrieves comprehensive information about a call session including participants, status, and timestamps. Only accessible by users who are participants in the call.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| session_id | String | Unique session ID of the call to retrieve | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8
appInitiateCall
InitiateCallResponse appInitiateCall(InitiateCallRequest)
Initiate a new call session
Creates a new WebRTC call session using Cloudflare Calls and stores session information in the database for tracking and billing purposes.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| InitiateCallRequest | InitiateCallRequest | Call initiation request with participant details and call type |
Return type
Authorization
HTTP request headers
- Content-Type: application/json; charset=utf-8
- Accept: application/json; charset=utf-8
appNotifyCallReceiver
NotifyReceiverResponse appNotifyCallReceiver(session_id)
Notify receiver of incoming call
Sends a push notification to the call receiver alerting them of an incoming call. Should be called immediately after initiating a call session.
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| session_id | String | Unique session ID of the call to notify about | [default to null] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: application/json; charset=utf-8