FreedomAPI
FreedomVOICE WebService API
The following operations are supported. For a formal definition, please review the Service Description.
- AddExtension
-
CallUserForOutboundCall
Calls a user and then places an outbound call to the specified phone number. This function is deprecated for CloudPBX for the updated version please use CallUserForOutboundCallUUID -
CallUserForOutboundCallUUID
Calls a user and then places an outbound call to the specified phone number. This version uses the UUID instead of relying on the display phone number to be on the same system. - CopyMessageItem
-
CreateGAStoredRecord
Create a record by providing all relevant key/value pairs -
DeleteGAStoredRecord
Delete a record by providing an ID or Sequence number -
FindActiveCall
Finds the phone number of the caller the user is speaking to currently - GetAssignedMailboxesForExtension
-
GetClientSoftwareLatestInfo
Get latest version numbers and current the download location for Client Software -
GetCurrentStatus
Lists all statuses for each DID on a system - GetCustomerContactInformation
- GetFolderList
- GetFolderMessageCount
-
GetGAStoredRecord
Retrieve a record by providing an ID or Sequence number -
GetGAStoredRecords
Retrieve all current records - GetMLSandDescriptionForExtension
- GetMessageItemAsMP3
- GetMessageItemAsTIFF
- GetMessageItemAsVOX
- GetMessageItemNotes
- GetMessageList
- GetNameAddressCaptureUsage
- GetPaymentHistory
- GetProductList
-
GetReportReviewCalls
Gets a list of call parts where people were speaking together -
GetStaffDIDCalls
Lists all calls to or from a VoIP DID -
GetTextFile
Provide a valid filename and receive the contents of the file - GetTranscriptionUsage
-
IQLogin
Login function for User-based systems - ListMailboxes
-
Login
Explicit Login function -- used to set the authentication cookie for the duration of those WebService session - MoveMessageItem
- RemoveExtension
- SendFax
- SetAssignedMailboxesForExtension
- SetMLSandDescriptionForExtension
- SetMessageItemName
- SetMessageItemNotes
- TestLoginValid
-
UpdateGAStoredRecord
Update a record by providing new key/value pairs and the key/valuse pair to modify - UploadExtensionRecording