1. API Guide
  2. ISR Provisioning API
  3. Provisioning API Examples
  4. Routes

Routes

GET

 REST URL - https://<IP>:<port>/provapi/routes

SUPPORTED METHOD -  GET

HEADER - Authorization
Sample Request Body -Not required
Sample Response Body 
[ { "accountId": 0, "agentIdEditableFlag": byte, "application": "string", "codecProfileId": 0, "completedEditableFlag": byte, "deleteRecordingPermission": byte, "downloadRecordingPermission": byte, "forceRpdd": 0, "label": "string", "maximumNumberOfPorts": 0, "minimumStorageDays": 0, "notesEditableFlag": byte, "numberOfBurstPorts": 0, "percentToRecord": 0, "playbackRecordingPermission": byte, "priority": 0, "ratingEditableFlag": byte, "recSegmentationState": byte, "recordSaveDTMF": byte, "recordingEnabled": byte, "routeId": 0, "routePattern": "string", "routeType": byte, "storeDtmfSetting": byte, "videoAccessEnabled": byte, "videoRecordingEnabled": byte, "virtualRoutePattern": "string" } ]
Example 
[ { "routeId": 4, "accountId": 1, "routeType": 1, "routePattern": "%", "virtualRoutePattern": "%DNIS%", "label": "", "priority": 5, "application": "conference", "recordingEnabled": 1, "recSegmentationState": 1, "percentToRecord": 100, "forceRpdd": 0, "codecProfileId": 1, "storeDtmfSetting": 1, "videoRecordingEnabled": 1, "videoAccessEnabled": 0, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "recordSaveDTMF": "#", "minimumStorageDays": 90, "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "playbackRecordingPermission": 1, "downloadRecordingPermission": 1, "deleteRecordingPermission": 1 } ]

POST

REST URL - https://<IP>:<port>/provapi/routes

SUPPORTED METHOD -  POST

HEADER - Authorization
Path Parameter - No parameters
Sample Request Body - Create a file with the following data to be imported:
  • route_type
  • route_pattern
  • virtual_route_pattern
  • label
  • priority
  • account_name
  • percent_to_record
  • recording_enabled
  • default_recording_type
  • agent_id_editable_flag
  • rating_editable_flag
  • completed_editable_flag
  • notes_editable_flag
  • application
  • maximum_number_of_ports
  • number_of_burst_ports
  • minimum_storage_days
Sample Output Response 
Routes imported successfully

POST

REST URL - https://<IP>:<port>/provapi/routes

SUPPORTED METHOD -  POST

HEADER - Authorization
Sample Request Body 
{

"accountId": 0,
"label": "string",
"priority": 0,
"routePattern": "string",
"routeType": byte,
"virtualRoutePattern": "string"
}
Sample Response Body 
{ "accountId": 0, "agentIdEditableFlag": byte, "application": "string", "codecProfileId": 0, "completedEditableFlag": byte, "deleteRecordingPermission": byte, "downloadRecordingPermission": byte, "forceRpdd": 0, "label": "string", "maximumNumberOfPorts": 0, "minimumStorageDays": 0, "notesEditableFlag": byte, "numberOfBurstPorts": 0, "percentToRecord": 0, "playbackRecordingPermission": byte, "priority": 0, "ratingEditableFlag": byte, "recSegmentationState": byte, "recordSaveDTMF": byte, "recordingEnabled": byte, "routeId": 0, "routePattern": "string", "routeType": "string", "storeDtmfSetting": byte, "videoAccessEnabled": byte, "videoRecordingEnabled": byte, "virtualRoutePattern": "string" }
Sample Input Body 
{

"accountId": 1,
"label": "New Route",
"priority": 1,
"routePattern": "%%",
"routeType": 1,
"virtualRoutePattern": "%%"
}
Sample Output Response 
{ "routeId": 5, "accountId": 1, "routeType": 1, "routePattern": "%%", "virtualRoutePattern": "%%", "label": "New Route", "priority": 1, "application": "conference", "recordingEnabled": 1, "recSegmentationState": 0, "percentToRecord": 100, "forceRpdd": 0, "codecProfileId": 1, "storeDtmfSetting": -1, "videoRecordingEnabled": 1, "videoAccessEnabled": 1, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 0, "notesEditableFlag": 0, "recordSaveDTMF": "#", "minimumStorageDays": 90, "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "playbackRecordingPermission": 1, "downloadRecordingPermission": 1, "deleteRecordingPermission": 1 }

DELETE

REST URL - https://<IP>:<port>/provapi/routes/{routeID}

SUPPORTED METHOD -  DELETE

HEADER - Authorization

PATH PARAMETER - routeID
Sample Request Body - Not Required
Sample Response Body 
Route with ID <routeID> is deleted
Example 
Route with ID 3 is deleted

GET

REST URL - https://<IP>:<port>/provapi/routes/{routeID}

SUPPORTED METHOD -  GET

HEADER - Authorization

PATH PARAMETER - routeID
Sample Request Body - Not required
Sample Response Body 
{ "accountId": 0, "agentIdEditableFlag": byte, "application": "string", "codecProfileId": 0, "completedEditableFlag": byte, "deleteRecordingPermission": byte, "downloadRecordingPermission": byte, "forceRpdd": 0, "label": "string", "maximumNumberOfPorts": 0, "minimumStorageDays": 0, "notesEditableFlag": byte, "numberOfBurstPorts": 0, "percentToRecord": 0, "playbackRecordingPermission": byte, "priority": 0, "ratingEditableFlag": byte, "recSegmentationState": byte, "recordSaveDTMF": byte, "recordingEnabled": byte, "routeId": 0, "routePattern": "string", "routeType": byte, "storeDtmfSetting": byte, "videoAccessEnabled": byte, "videoRecordingEnabled": byte, "virtualRoutePattern": "string" }
Example 
{ "routeId": 4, "accountId": 1, "routeType": 1, "routePattern": "%", "virtualRoutePattern": "%DNIS%", "label": "", "priority": 5, "application": "conference", "recordingEnabled": 1, "recSegmentationState": 1, "percentToRecord": 100, "forceRpdd": 0, "codecProfileId": 1, "storeDtmfSetting": 1, "videoRecordingEnabled": 1, "videoAccessEnabled": 0, "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/routes/{routeID}

SUPPORTED METHOD -  PATCH

HEADER - Authorization

PATH PARAMETER - routesID
Sample Request Body - Any permissible key values for update
Sample Response Body 
{ "accountId": 0, "agentIdEditableFlag": byte, "application": "string", "codecProfileId": 0, "completedEditableFlag": byte, "deleteRecordingPermission": byte, "downloadRecordingPermission": byte, "forceRpdd": 0, "label": "string", "maximumNumberOfPorts": 0, "minimumStorageDays": 0, "notesEditableFlag": byte, "numberOfBurstPorts": 0, "percentToRecord": 0, "playbackRecordingPermission": byte, "priority": 0, "ratingEditableFlag": byte, "recSegmentationState": byte, "recordSaveDTMF": byte, "recordingEnabled": byte, "routeId": 0, "routePattern": "string", "routeType": "string", "storeDtmfSetting": byte, "videoAccessEnabled": byte, "videoRecordingEnabled": byte, "virtualRoutePattern": "string" }
Sample Input Body 
{

"completedEditableFlag": 1,

"label": "Sample label"

}
Sample Output Response 
{ "routeId": 4, "accountId": 1, "routeType": 1, "routePattern": "%", "virtualRoutePattern": "%DNIS%", "label": "Sample label", "priority": 5, "application": "conference", "recordingEnabled": 1, "recSegmentationState": 1, "percentToRecord": 100, "forceRpdd": 0, "codecProfileId": 1, "storeDtmfSetting": 1, "videoRecordingEnabled": 1, "videoAccessEnabled": 0, "agentIdEditableFlag": 0, "ratingEditableFlag": 0, "completedEditableFlag": 1, "notesEditableFlag": 0, "recordSaveDTMF": "#", "minimumStorageDays": 90, "maximumNumberOfPorts": 24, "numberOfBurstPorts": 6, "playbackRecordingPermission": 1, "downloadRecordingPermission": 1, "deleteRecordingPermission": 1 }

GET

REST URL - https://<IP>:<port>/provapi/routes/{routeID}/routeGroup

SUPPORTED METHOD -  GET

HEADER - Authorization

PATH PARAMETER - routeID
Sample Request Body - Not required
Sample Response Body 
[ { "routeMasterId": 0, "routeMemberId": 0, "routePattern": "string", "virtualRoutePattern": "string" } ]
Example 
[ { "routeMemberId": 2, "routeMasterId": 5, "routePattern": "$", "virtualRoutePattern": "$" } ]

POST

REST URL - https://<IP>:<port>/provapi/routes/{routeID}/routeGroup

SUPPORTED METHOD -  POST

HEADER - Authorization
Sample Request Body 
{

"routePattern": "string",
"virtualPattern": "string"
}
Sample Response Body 
{ "routeMasterId": 0, "routeMemberId": 0, "routePattern": "string", "virtualRoutePattern": "string"  }
Sample Input Body 
{

"routePattern": "%%",
"virtualPattern": "%%"
}
Sample Output Response 
{ "routeMemberId": 3, "routeMasterId": 5, "routePattern": "%$", "virtualRoutePattern": "%$" }

DELETE

REST URL - https://<IP>:<port>/provapi/routes/{routeID}/routeGroup/{memberID}

SUPPORTED METHOD -  DELETE

HEADER - Authorization

PATH PARAMETER - routeID, memberID
Sample Request Body - Not required
Sample Response Body 
Member Route Successfully Removed
Example 
Member Route Successfully Removed