Routes v2 API
The url to access the route api is
https://<PABX HOST>/servicemanager/rest/RouteAPI/updateRouteV2
Arguments are:
enabled (true/false)
title
description
brand
did
apiKey
enabled takes true/false
title, description and brand take any text (URL encoded of course)
A route will be matched on the 'did', if there is exactly 1 route for the 'did' the update will take place and you will receive 'OK'.
if there are 0 or more than 1 routes no update will occur and you will recieve a message like
Can not perform the requested operation, there are 0 routes for DID 410
a valid call to the route API looks like this....
https://127.0.0.1/servicemanager/rest/RouteAPI/updateRouteV2?apiKey=f863246a-973e-11e6-8784-08002718f5b5&enabled=true&title=abc123&description=abc123&brand=abc123&did=410
Success response:
{"code":0,"message":"OK"}
Error Responses
{"code":-2,"message":"Can not perform the requested operation, there must be exactly one matching route for DID 1234"}
Routes v1 API - deprecated
The below documents the API for Routes v1. As of Noojee Contact 6.1 the below api is deprecated. Please use the new routes V2 api documented above. Note: this api will be removed in Noojee Contat 6.5 and in 6.1 it is only able to update an Routes v1 entry.
The url to access the route api is
https://<PABX HOST>/servicemanager/rest/RouteAPI/updateRoute
Arguments are:
enabled (true/false)
title
description
brand
did
apiKey
enabled takes true/false
title, description and brand take any text (URL encoded of course)
A route will be matched on the 'did', if there is exactly 1 route for the 'did' the update will take place and you will receive 'OK'.
if there are 0 or more than 1 routes no update will occur and you will recieve a message like
Can not perform the requested operation, there are 0 routes for DID 410
a valid call to the route API looks like this....
https://127.0.0.1/servicemanager/rest/RouteAPI/updateRoute?enabled=false&title=abc123& apiKey=f863246a-973e-11e6-8784-08002718f5b5&description=abc123&brand=abc123&did=410