Retrieve all Calls
This function retrieves all calls from the client account.
URL
GET {baseURL}/calls
Parameters
None.
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Returned Data (200 OK)
A JSON Structure containing the following fields:
| Field | Type | Data |
|---|---|---|
| records | Call [] | An array of Call objects. |
| count | Integer | The number of records returned. |
| orderBy | String | Currently, calls are ordered by UFN. |
| status | Integer | The return code (also provided by the http status code). |
Example
{
"records": [
{
"bOutbound": 0,
"CurrentAgentCountLoggedInToAcd": null,
"AcdCallMonitoring_bCallRequest": null,
"AcdSecondaryDistributionAlgorithmID": 1,
"LanguagesID": 2,
...
"dtCallStart": "2022-07-08T11:33:18.900977Z",
"CallingPartyNumberType": 1,
"dtAcdFirstQueueStart": null,
"ResellersID": 1,
"dtAcdCallRecordingAnnouncementStart": null
}
],
"count": 1,
"orderBy": "UFN",
"status": 200
}
Answer a Call
This function issues the answer call function to the PBX / PBX Connector. Note, not all PBX connectors support this function.
URL
GET {baseURL}/calls/{UFN}/answer
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| UFN | URL | String | The UFN of the call. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Hangup a Call
This function issues the hangup call function to the jtel System (on the primary call). This will also result in a disconnect to an agent call, if currently active.
URL
GET {baseURL}/calls/{UFN}/hangup
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| UFN | URL | String | The UFN of the call. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Hangup a Call Leg 2
This function issues the hangup call function to the jtel System on the secondary call if present.
This function can be used to disconnect a call to an external destination (for example, an external voicebot), and also provide information to the jtel system which will be parsed into variables for further use within the callflow.
URL
POST {baseURL}/calls/{UFN}/disconnectChannel2
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| UFN | URL | String | The UFN of the call. |
Data
The provided data can be anything. It will be provided in:
- the variable restCallControl.json if the call is a normal call
- the variables voicebot.* if the "Connect VoiceBot" object was used
Example:
{
"result":"TRANSFER_AGENT",
"reason":"VOICEBOT_CANNOT_COMPLETE"
}
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Provide Call Data
FROM RELEASE 3.43
This function can be used to provide information to the jtel system which will be parsed into variables for further use within the callflow.
Note, it does not disconnect the call like Hangup a Call Log 2 does. This function can be used in scenarios where the external voice bot would prefer to disconnect the call.
URL
POST {baseURL}/calls/{UFN}/provideCallData
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| UFN | URL | String | The UFN of the call. |
Data
The provided data can be anything. It will be provided in:
- the variable restCallControl.json if the call is a normal call
- the variables voicebot.* if the "Connect VoiceBot" object was used
Example:
{
"result":"TRANSFER_AGENT",
"reason":"VOICEBOT_CANNOT_COMPLETE"
}
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Hold a Call
This function issues the call hold function to the jtel system.
URL
GET {baseURL}/calls/{UFN}/hold
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| UFN | URL | String | The UFN of the call. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Retrieve a Call
This function issues the retrieve call function to the jtel System.
URL
GET {baseURL}/calls/{UFN}/retrieve
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| UFN | URL | String | The UFN of the call. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.
Make a Call
This function starts an outbound call for an agent using a particular ACD group.
URL
GET {baseURL}/calls/makeCall?usersID={usersID}&acdGroupsID={acdGroupsID}&serviceNumbersID={serviceNumbersID}&destinationNumber={destinationNumber}&maxRingTime={maxRingTime}&userData={userData}&bSuppressPreview={bSuppressPreview}
Parameters
Parameter | Where | Type | Data |
|---|---|---|---|
| usersID | URL | Integer | The ID of the user for which the call should be made. Note, the telActive setting will be the destination for the agent leg of the call. |
| acdGroupsID | URL | Integer | The ID of a standalone ACD group or configuration ACD group for which the call should be made. |
| serviceNumbersID | URL | Integer | The ID of the service number on which the call should be made. This will be used in the signalling (calling party number). |
| destinationNumber | URL | String | The destination number in E.164 format. Note, it may be possible to dial non E.164 strings in some systems, however, this behaviour is not supported so if you use it, then good luck! |
| maximumRingTime | URL | Integer | The maximum ring time for the call, before it is ended with a "no answer" result. |
| userData | URL | String | Any user data associated with the call can be entered here. Usually a foreign system ID or identifier. |
| bSuppressPreview | URL | Boolean | Currently not supported, for future use in combination with the dialler. |
Responses
If the request is performed, 200 OK is returned. See Return Codes for further possible status codes.