deleteVoxnumbersFromAccount¶
Request Method: DELETE
Description: Removes one or more VoxNumbers from your account. The VoxNumber goes back to IOVOX and can no longer be used. It is possible to retrieve a deleted VoxNumber by raising a support ticket with IOVOX provided it has not been recycled by that time.
URL: https://api.iovox.com:444/Voxnumbers?v=3&method=deleteVoxnumbersFromAccount&rm_if_in_use=TRUE&full_voxnumbers=44207100234,33470178899
Parameter | Description | Default Value | Data Type | Mandatory |
v | API version to use | INTEGER | YES | |
rm_if_in_use | If TRUE the VoxNumbers will be removed from any Links if they are attached to. If FALSE a validation message will be thrown if any of the requested VoxNumbers are attached to a Link | FALSE | STRING | NO |
full_voxnumbers | A comma delimited list of all voxnumbers to be removed. These must be in e164 format with no leading zeros or + (e.g. 44207100234 for a London VoxNumber) | STRING | YES |
Result¶
Error Result¶
HTTP Code | Error String | Resolution |
400 | API Version Empty | Add a value for the v parameter in the query string |
400 | API Version Invalid | Correct v parameter |
400 | Request Method must be DELETE. x attempted | Switch request method x to DELETE |
400 | rm_if_in_use Invalid | Change rm_if_in_use to TRUE or FALSE |
400 | VoxNumbers Empty | Add one or more full_voxnumbers to the request |
400 | VoxNumber x of y does not exists | Correct full_voxnumber x (item) of y (total) |
400 | VoxNumber x of y Empty | Correct full_voxnumber x (item) of y (total) |
400 | VoxNumber x of y not an integer | Correct full_voxnumber x (item) of y (total) |
400 | VoxNumber x of y is attached to a Link | Remove full_voxnumber x (item) of y (total) from the request or set remove_if_in_use to TRUE |
400 | You can only remove a maximum of 100 VoxNumbers in a single request | Break the request into single requests of less than 100 each |
500 | Internal Server Error | Retry later |