Home > telephony > nts > example-scenarios > func.telecoms.routeplan.delete
function telecoms.routeplan.delete

Deletes an existing route plan.

Note: this function will not allow you to delete a route plan if it is in use (eg if a number or a day parting is routing to it). If you try to delete an in-use route plan, an error will be generated.

Arguments:

argrequired?syntaxinfo
custIDNposintcustID of account containing the routeplan you wish to delete (defaults to your own account)
routeplanIDYposintrouteplanID of the route plan you wish to delete

Example

Delete routeplan with routeplanID of 2434.

JSON example request:

POST https://live.apicontrol.co.uk/1/json
{
    "auth" : {
        "username" : "YOURUSERNAME",
        "password" : "YOURPASSWORD",
    },
    "func" : "telecoms.routeplan.delete",
    "args" : {
       "routeplanID" : 2434
    }
}

JSON example response:

{
   "results" : {
      "eventID" : "548834"
   },
   "success" : "1"
}