Accounts
GET
REST URL - https://<IP>:<port>/provapi/accounts SUPPORTED METHOD - GET HEADER - AuthorizationSample Request Body - Not required
Sample Response Body
[ { "accountDescription": "string", "accountId": 0, "accountMisc": "string", "accountName": "string", "acctPortLimit": 0, "agentIdEditableFlag": byte, "announceEnabled": byte, "application": "string", "callMetaDataSrc": byte, "codecProfileId": 0, "completedEditableFlag": byte, "defaultAnnounceAudioFile": "string", "defaultAnnounceAudioText": "string", "defaultOptOutVxmlFile": "string", "defaultRecordingType": byte, "deleteRecordingPermission": byte, "downloadRecordingPermission": byte, "forceRpdd": 0, "maximumNumberOfPorts": 0, "notesEditableFlag": byte, "numberOfBurstPorts": 0, "optOutEnabled": byte, "percentToRecord": 0, "playBackRecordingPermission": byte, "playBeepBeforeRecord": byte, "ratingEditableFlag": byte, "recSegmentationState": byte, "recordSaveDTMF": "string", "recorderState": 0, "recordingEnabled": byte, "recurringBeepEnabled": byte, "recurringBeepFile": "string", "recurringBeepInterval": 0, "showApplianceTabinRouteView": byte, "storeDTMFSetting": byte, "terminateOnDTMF": byte, "terminateOnEOS": byte, "videoAccessEnabled": byte, "videoRecordingEnabled": byte } ]Example
[ { "accountId": 1, "accountName": "System", "accountDescription": "System", "accountMisc": "System", "percentToRecord": 100, "recordingEnabled": 1, "announceEnabled": 0, "defaultAnnounceAudioFile": "", "defaultAnnounceAudioText": "", "defaultOptOutVxmlFile": "opt_out.jsp", "optOutEnabled": 0, "recorderState": 1, "defaultRecordingType": 8, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "application": "conference", "playBeepBeforeRecord": 0, "terminateOnDTMF": 0, "terminateOnEOS": -1, "recurringBeepEnabled": 0, "recurringBeepInterval": 30, "recurringBeepFile": "beep.wav", "recordSaveDTMF": "#", "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "acctPortLimit": -1, "showApplianceTabinRouteView": 0, "codecProfileId": 1, "forceRpdd": 0, "storeDTMFSetting": -1, "downloadRecordingPermission": 1, "playBackRecordingPermission": 1, "deleteRecordingPermission": 1, "videoRecordingEnabled": 1, "videoAccessEnabled": 1, "recSegmentationState": 0, "callMetaDataSrc": 0 }]
POST
REST URL - https://<IP>:<port>/provapi/accounts SUPPORTED METHOD - POST HEADER - AuthorizationSample Request Body
{ "accountDescription": "string", "accountMisc": "string", "accountName": "string", "acctPortLimit": 0, "recSegmentationState": byte, "recorderState": 0 }
Sample Response Body
{ "accountDescription": "string", "accountId": 0, "accountMisc": "string", "accountName": "string", "acctPortLimit": 0, "agentIdEditableFlag": "string", "announceEnabled": "string", "application": "string", "callMetaDataSrc": "string", "codecProfileId": 0, "completedEditableFlag": "string", "defaultAnnounceAudioFile": "string", "defaultAnnounceAudioText": "string", "defaultOptOutVxmlFile": "string", "defaultRecordingType": "string", "deleteRecordingPermission": "string", "downloadRecordingPermission": "string", "forceRpdd": 0, "maximumNumberOfPorts": 0, "notesEditableFlag": "string", "numberOfBurstPorts": 0, "optOutEnabled": "string", "percentToRecord": 0, "playBackRecordingPermission": "string", "playBeepBeforeRecord": "string", "ratingEditableFlag": "string", "recSegmentationState": "string", "recordSaveDTMF": "string", "recorderState": 0, "recordingEnabled": "string", "recurringBeepEnabled": "string", "recurringBeepFile": "string", "recurringBeepInterval": 0, "showApplianceTabinRouteView": "string", "storeDTMFSetting": "string", "terminateOnDTMF": "string", "terminateOnEOS": "string", "videoAccessEnabled": "string", "videoRecordingEnabled": "string" }Sample Input Body
{ "accountDescription": "New Account", "accountMisc": "Misc", "accountName": "New Account", "acctPortLimit": -1, "recSegmentationState": 1, "recorderState": 0 }Sample Output Response
{ "accountId": 4, "accountName": "New Account", "accountDescription": "New Account", "accountMisc": "Misc", "percentToRecord": 100, "recordingEnabled": 1, "announceEnabled": 0, "defaultAnnounceAudioFile": null, "defaultAnnounceAudioText": null, "defaultOptOutVxmlFile": null, "optOutEnabled": 0, "recorderState": 0, "defaultRecordingType": 8, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "application": null, "playBeepBeforeRecord": 0, "terminateOnDTMF": 0, "terminateOnEOS": -1, "recurringBeepEnabled": 0, "recurringBeepInterval": 30, "recurringBeepFile": "beep.wav", "recordSaveDTMF": "#", "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "acctPortLimit": -1, "showApplianceTabinRouteView": 0, "codecProfileId": 1, "forceRpdd": 0, "storeDTMFSetting": -1, "downloadRecordingPermission": 1, "playBackRecordingPermission": 1, "deleteRecordingPermission": 1, "videoRecordingEnabled": 0, "videoAccessEnabled": 1, "recSegmentationState": 1, "callMetaDataSrc": 0 }
DELETE
REST URL - https://<IP>:<port>/provapi/accounts/{accountID} SUPPORTED METHOD - DELETE HEADER - Authorization PATH PARAMETER - accountIDSample Request Body - Not required
Sample Response Body
Account with ID <accountID> has been deletedExample
Account with ID 3 has been deleted
POST
REST URL - https://<IP>:<port>/provapi/accounts/search SUPPORTED METHOD - POST HEADER - Authorization
Sample Request Body
{"accountName": "System"}
Sample Response Body
{ "accountId": 1, "accountName": "System", "accountDescription": "System", "accountMisc": "System", "percentToRecord": 100, "recordingEnabled": 1, "callMetaDataSrc": 0, "announceEnabled": 0, "defaultAnnounceAudioFile": "", "defaultAnnounceAudioText": "", "defaultOptOutVxmlFile": "opt_out.jsp", "optOutEnabled": 0, "recorderState": 1, "defaultRecordingType": 8, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "application": "conference", "playBeepBeforeRecord": 0, "terminateOnDTMF": 0, "terminateOnEOS": -1, "recurringBeepEnabled": 0, "recurringBeepInterval": 30, "recurringBeepFile": "beep.wav", "recordSaveDTMF": "#", "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "acctPortLimit": -1, "showApplianceTabinRouteView": 0, "codecProfileId": 1, "forceRpdd": 0, "storeDTMFSetting": 0, "downloadRecordingPermission": 1, "playBackRecordingPermission": 1, "deleteRecordingPermission": 1, "videoRecordingEnabled": 0, "videoAccessEnabled": 1, "recSegmentationState": 0 }Sample Output Response
[ { "accountId": 1, "accountName": "System", "accountDescription": "System", "accountMisc": "System", "percentToRecord": 100, "recordingEnabled": 1, "callMetaDataSrc": 0, "announceEnabled": 0, "defaultAnnounceAudioFile": "", "defaultAnnounceAudioText": "", "defaultOptOutVxmlFile": "opt_out.jsp", "optOutEnabled": 0, "recorderState": 1, "defaultRecordingType": 8, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "application": "conference", "playBeepBeforeRecord": 0, "terminateOnDTMF": 0, "terminateOnEOS": -1, "recurringBeepEnabled": 0, "recurringBeepInterval": 30, "recurringBeepFile": "beep.wav", "recordSaveDTMF": "#", "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "acctPortLimit": -1, "showApplianceTabinRouteView": 0, "codecProfileId": 1, "forceRpdd": 0, "storeDTMFSetting": 0, "downloadRecordingPermission": 1, "playBackRecordingPermission": 1, "deleteRecordingPermission": 1, "videoRecordingEnabled": 0, "videoAccessEnabled": 1, "recSegmentationState": 0 } ]
POST
REST URL - https://<IP>:<port>/provapi/accounts/upload SUPPORTED METHOD - POST HEADER - Authorization PATH PARAMETER -No paramsSample Request Body - Create a CSV file with the following data to be imported:
- account_name
- account_description
- account_misc
- percent_to_record
- recording_enabled
- recorder_state
- default_recording_type
- agent_id_editable_flag
- rating_editable_flag
- completed_editable_flag
- notes_editable_flag
- application
- maximum_number_of_ports
- number_of_urst_ports
- acct_port_limit
Output Response
Accounts imported successfully
GET
REST URL - https://<IP>:<port>/provapi/accounts/{accountID} SUPPORTED METHOD - GET HEADER - Authorization PATH PARAMETER - accountIDSample Request Body - Not required
Sample Resonse Body
{ "accountDescription": "string", "accountId": 0, "accountMisc": "string", "accountName": "string", "acctPortLimit": 0, "agentIdEditableFlag": "string", "announceEnabled": "string", "application": "string", "callMetaDataSrc": "string", "codecProfileId": 0, "completedEditableFlag": "string", "defaultAnnounceAudioFile": "string", "defaultAnnounceAudioText": "string", "defaultOptOutVxmlFile": "string", "defaultRecordingType": "string", "deleteRecordingPermission": "string", "downloadRecordingPermission": "string", "forceRpdd": 0, "maximumNumberOfPorts": 0, "notesEditableFlag": "string", "numberOfBurstPorts": 0, "optOutEnabled": "string", "percentToRecord": 0, "playBackRecordingPermission": "string", "playBeepBeforeRecord": "string", "ratingEditableFlag": "string", "recSegmentationState": "string", "recordSaveDTMF": "string", "recorderState": 0, "recordingEnabled": "string", "recurringBeepEnabled": "string", "recurringBeepFile": "string", "recurringBeepInterval": 0, "showApplianceTabinRouteView": "string", "storeDTMFSetting": "string", "terminateOnDTMF": "string", "terminateOnEOS": "string", "videoAccessEnabled": "string", "videoRecordingEnabled": "string" }Sample Output Response
{ "accountId": 3, "accountName": "OC", "accountDescription": "Oracle as an company", "accountMisc": "", "percentToRecord": 50, "recordingEnabled": 1, "announceEnabled": 0, "defaultAnnounceAudioFile": null, "defaultAnnounceAudioText": null, "defaultOptOutVxmlFile": null, "optOutEnabled": 0, "recorderState": 1, "defaultRecordingType": 8, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "application": "conference", "playBeepBeforeRecord": 0, "terminateOnDTMF": 0, "terminateOnEOS": -1, "recurringBeepEnabled": 0, "recurringBeepInterval": 30, "recurringBeepFile": "beep.wav", "recordSaveDTMF": "#", "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "acctPortLimit": 6, "showApplianceTabinRouteView": 0, "codecProfileId": 1, "forceRpdd": 0, "storeDTMFSetting": -1, "downloadRecordingPermission": 1, "playBackRecordingPermission": 1, "deleteRecordingPermission": 1, "videoRecordingEnabled": 1, "videoAccessEnabled": 1, "recSegmentationState": 1, "callMetaDataSrc": 0 }
GET
REST URL - https://<IP>:<port>/provapi/accounts/{accountID}/routes SUPPORTED METHOD - GET HEADER - Authorization PATH PARAMETER - accountIDSample Request Body - Not required
Sample Response Body
{ "routeId": 0, "accountId": 0, "routeType": 0, "routePattern": "string", "virtualRoutePattern": "string", "label": "", "priority": 0, "application": "string", "recordingEnabled": 0, "recSegmentationState": 0, "percentToRecord": 0, "forceRpdd": 0, "codecProfileId": 0, "storeDtmfSetting": 0, "videoRecordingEnabled": 0, "videoAccessEnabled": 0, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "recordSaveDTMF": "#", "minimumStorageDays": 1, "maximumNumberOfPorts": 0, "numberOfBurstPorts": 0, "playbackRecordingPermission": 0, "downloadRecordingPermission": 0, "deleteRecordingPermission": 0 }Sample Output Response
[ { "routeId": 74930, "accountId": 1, "routeType": 1, "routePattern": "asdasdasd", "virtualRoutePattern": "asdasdasd", "label": "", "priority": 5, "application": "conference", "recordingEnabled": 1, "recSegmentationState": 0, "percentToRecord": 100, "forceRpdd": 0, "codecProfileId": 1, "storeDtmfSetting": 0, "videoRecordingEnabled": 0, "videoAccessEnabled": 1, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "recordSaveDTMF": "#", "minimumStorageDays": 90, "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "playbackRecordingPermission": 1, "downloadRecordingPermission": 1, "deleteRecordingPermission": 1 }, { "routeId": 74931, "accountId": 1, "routeType": 1, "routePattern": "sdfsdfsdf", "virtualRoutePattern": "sdfsdfsdf", "label": "", "priority": 5, "application": "conference", "recordingEnabled": 1, "recSegmentationState": 0, "percentToRecord": 100, "forceRpdd": 0, "codecProfileId": 1, "storeDtmfSetting": 0, "videoRecordingEnabled": 0, "videoAccessEnabled": 1, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "recordSaveDTMF": "#", "minimumStorageDays": 90, "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "playbackRecordingPermission": 1, "downloadRecordingPermission": 1, "deleteRecordingPermission": 1 } ]
PATCH
REST URL - https://<IP>:<port>/provapi/accounts/{accountID} SUPPORTED METHOD - PATCH HEADER - Authorization PATH PARAMETER - accountIDSample Request Body - Any permissible key values for update
Sample Response Body
{ "accountDescription": "string", "accountId": 0, "accountMisc": "string", "accountName": "string", "acctPortLimit": 0, "agentIdEditableFlag": "string", "announceEnabled": "string", "application": "string", "callMetaDataSrc": "string", "codecProfileId": 0, "completedEditableFlag": "string", "defaultAnnounceAudioFile": "string", "defaultAnnounceAudioText": "string", "defaultOptOutVxmlFile": "string", "defaultRecordingType": "string", "deleteRecordingPermission": "string", "downloadRecordingPermission": "string", "forceRpdd": 0, "maximumNumberOfPorts": 0, "notesEditableFlag": "string", "numberOfBurstPorts": 0, "optOutEnabled": "string", "percentToRecord": 0, "playBackRecordingPermission": "string", "playBeepBeforeRecord": "string", "ratingEditableFlag": "string", "recSegmentationState": "string", "recordSaveDTMF": "string", "recorderState": 0, "recordingEnabled": "string", "recurringBeepEnabled": "string", "recurringBeepFile": "string", "recurringBeepInterval": 0, "showApplianceTabinRouteView": "string", "storeDTMFSetting": "string", "terminateOnDTMF": "string", "terminateOnEOS": "string", "videoAccessEnabled": "string", "videoRecordingEnabled": "string" }Sample Input Body
{ "accountDescription": "Updated desc", "accountMisc": "misc has been updated" }
Sample Output Response
{ "accountId": 3, "accountName": "OC", "accountDescription": "Updated desc", "accountMisc": "misc has been updated", "percentToRecord": 50, "recordingEnabled": 1, "announceEnabled": 0, "defaultAnnounceAudioFile": null, "defaultAnnounceAudioText": null, "defaultOptOutVxmlFile": null, "optOutEnabled": 0, "recorderState": 1, "defaultRecordingType": 8, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "application": "conference", "playBeepBeforeRecord": 0, "terminateOnDTMF": 0, "terminateOnEOS": -1, "recurringBeepEnabled": 0, "recurringBeepInterval": 30, "recurringBeepFile": "beep.wav", "recordSaveDTMF": "#", "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "acctPortLimit": 6, "showApplianceTabinRouteView": 0, "codecProfileId": 1, "forceRpdd": 0, "storeDTMFSetting": -1, "downloadRecordingPermission": 1, "playBackRecordingPermission": 1, "deleteRecordingPermission": 1, "videoRecordingEnabled": 1, "videoAccessEnabled": 1, "recSegmentationState": 1, "callMetaDataSrc": 0 }
PUT
REST URL - https://<IP>:<port>/provapi/accounts/{accountID} SUPPORTED METHOD - PUT HEADER - Authorization PATH PARAMETER - accountIDSample Request Body
{ "accountDescription": "string", "accountId": 0, "accountMisc": "string", "accountName": "string", "acctPortLimit": 0, "agentIdEditableFlag": "string", "application": "string", "codecProfileId": 0, "completedEditableFlag": "string", "deleteRecordingPermission": "string", "downloadRecordingPermission": "string", "forceRpdd": 0, "maximumNumberOfPorts": 0, "notesEditableFlag": "string", "numberOfBurstPorts": 0, "percentToRecord": 0, "playBackRecordingPermission": "string", "ratingEditableFlag": "string", "recSegmentationState": "string", "recordSaveDTMF": "string", "recorderState": 0, "recordingEnabled": "string", "storeDTMFSetting": "string", "videoAccessEnabled": "string", "videoRecordingEnabled": "string" }Sample Response Body
{ "accountDescription": "string", "accountId": 0, "accountMisc": "string", "accountName": "string", "acctPortLimit": 0, "agentIdEditableFlag": "string", "announceEnabled": "string", "application": "string", "callMetaDataSrc": "string", "codecProfileId": 0, "completedEditableFlag": "string", "defaultAnnounceAudioFile": "string", "defaultAnnounceAudioText": "string", "defaultOptOutVxmlFile": "string", "defaultRecordingType": "string", "deleteRecordingPermission": "string", "downloadRecordingPermission": "string", "forceRpdd": 0, "maximumNumberOfPorts": 0, "notesEditableFlag": "string", "numberOfBurstPorts": 0, "optOutEnabled": "string", "percentToRecord": 0, "playBackRecordingPermission": "string", "playBeepBeforeRecord": "string", "ratingEditableFlag": "string", "recSegmentationState": "string", "recordSaveDTMF": "string", "recorderState": 0, "recordingEnabled": "string", "recurringBeepEnabled": "string", "recurringBeepFile": "string", "recurringBeepInterval": 0, "showApplianceTabinRouteView": "string", "storeDTMFSetting": "string", "terminateOnDTMF": "string", "terminateOnEOS": "string", "videoAccessEnabled": "string", "videoRecordingEnabled": "string" }Sample Input Body
{ "accountId": 3, "accountName": "OC", "accountDescription": "Updated desc", "accountMisc": "misc has been updated", "percentToRecord": 50, "recordingEnabled": 1, "announceEnabled": 0, "defaultAnnounceAudioFile": null, "defaultAnnounceAudioText": null, "defaultOptOutVxmlFile": null, "optOutEnabled": 0, "recorderState": 1, "defaultRecordingType": 8, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "application": "conference", "playBeepBeforeRecord": 0, "terminateOnDTMF": 0, "terminateOnEOS": -1, "recurringBeepEnabled": 0, "recurringBeepInterval": 30, "recurringBeepFile": "beep.wav", "recordSaveDTMF": "#", "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "acctPortLimit": 6, "showApplianceTabinRouteView": 0, "codecProfileId": 1, "forceRpdd": 0, "storeDTMFSetting": -1, "downloadRecordingPermission": 1, "playBackRecordingPermission": 1, "deleteRecordingPermission": 1, "videoRecordingEnabled": 1, "videoAccessEnabled": 1, "recSegmentationState": 1, "callMetaDataSrc": 0 }
Sample Output Response
{ "accountId": 3, "accountName": "OC", "accountDescription": "Updated desc", "accountMisc": "misc has been updated", "percentToRecord": 50, "recordingEnabled": 1, "announceEnabled": 0, "defaultAnnounceAudioFile": null, "defaultAnnounceAudioText": null, "defaultOptOutVxmlFile": null, "optOutEnabled": 0, "recorderState": 1, "defaultRecordingType": 8, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "application": "conference", "playBeepBeforeRecord": 0, "terminateOnDTMF": 0, "terminateOnEOS": -1, "recurringBeepEnabled": 0, "recurringBeepInterval": 30, "recurringBeepFile": "beep.wav", "recordSaveDTMF": "#", "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "acctPortLimit": 6, "showApplianceTabinRouteView": 0, "codecProfileId": 1, "forceRpdd": 0, "storeDTMFSetting": -1, "downloadRecordingPermission": 1, "playBackRecordingPermission": 1, "deleteRecordingPermission": 1, "videoRecordingEnabled": 1, "videoAccessEnabled": 1, "recSegmentationState": 1, "callMetaDataSrc": 0 }
PATCH
REST URL - https://<IP>:<port>/provapi/accounts/{accountID}/archiveByAccount SUPPORTED METHOD - PATCH HEADER - Authorization PATH PARAMETER - accountIDSample Request Body
{ "sourceDirectory": "sring", "name": "string", "converterIp": "string", "wwwServedFrom": null, "converterWebServiceSSLEnabled": 0, "accountId": 0, "accessType": 0, "deleteEnabled": 0, "dirDateStructure": 0, "dirAccountStructure": 0, "moveNonExistingRecord": 0, "createEmptyRecordings": 0, "conversionMode": 0, "conversionPercentage": 0, "host": "string", "credentialsUser": "string", "credentialsPass": "string", "checksumOptions": 0 }Sample Response Body
{ "sourceDirectory": "sring", "name": "string", "converterIp": "string", "wwwServedFrom": null, "converterWebServiceSSLEnabled": 0, "accountId": 0, "accessType": 0, "deleteEnabled": 0, "dirDateStructure": 0, "dirAccountStructure": 0, "moveNonExistingRecord": 0, "createEmptyRecordings": 0, "conversionMode": 0, "conversionPercentage": 0, "host": "string", "credentialsUser": "string", "credentialsPass": "string", "checksumOptions": 0 }Sample Input Body
{ "sourceDirectory" : "/opt/isr/recordings", "name" : "System" , "accessType": 0 }
Sample Output Body
{ "sourceDirectory": "/opt/isr/recordings", "name": "System", "converterIp": "10.178.248.21", "wwwServedFrom": null, "converterWebServiceSSLEnabled": 1, "accountId": 1, "accessType": 0, "deleteEnabled": 1, "dirDateStructure": 1, "dirAccountStructure": 0, "moveNonExistingRecord": 0, "createEmptyRecordings": 0, "conversionMode": 2, "conversionPercentage": 100, "host": "10.178.248.22", "credentialsUser": "root", "credentialsPass": "isradm", "checksumOptions": 0 }