setCallStatus¶

Request Method: PUT

Description: Sets the Call Status of a VoxNumber ("ON" or "OFF"). A VoxNumber whose Call Status is set to "OFF" will not have any Calling Rules actioned when called and any incoming calls will be dropped. Setting a status to "ON" will cause any incoming calls to action the attached Calling Rule Template.Only VoxNumbers that are attached to a Link can have their Call Status set.

URL: https://api.iovox.com:444/Voxnumbers?v=3&method=setCallStatus

Note: This function does not send a VoxNumber back to the pool, it is still attached to the link

The following parameters can be sent in the querystring

Parameter	Description	Default Value	Data Type	Mandatory
v	API version to use		INTEGER	YES

Payload¶


        xml
        
            
        
     
<?xml version="1.0" encoding="utf-8"?>
<request>
    <call_status>OFF</call_status>
     <voxnumbers>
         <voxnumber>448001020304</voxnumber>
         <voxnumber>448451234567</voxnumber>
         <voxnumber>442077277277</voxnumber>
     </voxnumbers>
 </request>

Parameters¶

Parameter	Description	Default Value	Data Type	Mandatory
call_status	Can be ON or OFF		STRING	YES
voxnumbers > voxnumber	One or multiple VoxNumbers		INTEGER	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	XML Empty	Correct XML payload
400	XML Parse Error	Correct XML payload
400	VoxNumber x of y does not exist	Correct VoxNumber
400	VoxNumber x of y is not attached to a Link	Attach VoxNumber to a link in order to set the call status
400	Call Status Invalid	Correct call_status parameter
400	VoxNumbers Empty	Correct VoxNumber(s)