updateBlockedNumbers¶
Request Method: PUT
Description: Update Blocked Number details
URL: https://api.iovox.com:444/Links?v=3&method=updateBlockedNumbers
The following parameters must be sent in the querystring:
| Parameter | Description | Default Value | Data Type | Mandatory |
| v | API version to use | INTEGER | YES |
Payload¶
The following XML payload must be sent with an updateBlockedNumbers request. See createBlockedNumbers for further Rule/Time/Links examples
<?xml version="1.0" encoding="utf-8"?>
<request>
<blocked_number>
<number>447429651522</number> <!-- Update blocking rule number 447429651522 to 447429651521. If rules exist for 447429651521, overwrite them -->
<new_number>447429651521</new_number>
<in_or_out>IN</in_or_out>
<operator>EQUALS</operator>
<default>ALLOW</default>
<if_exist>OVERWRITE</if_exist>
<rules/>
</blocked_number>
<blocked_number>
<number>447429651523</number> <!-- Update blocking rule number inbound calling to be outbound calling. If outbound rules exist for 447429651523, overwrite them with Block calls to Link ID 33 during the Weekend Time Template -->
<in_or_out>IN</in_or_out>
<new_in_or_out>OUT</new_in_or_out>
<operator>EQUALS</operator>
<new_operator>STARTSWITH</new_operator>
<default>ALLOW</default>
<if_exist>OVERWRITE</if_exist>
<rules>
<rule>
<links>
<link_id>33</link_id>
</links>
<time_template>Weekends</time_template>
<blocking_type>BLOCK</blocking_type>
</rule>
</rules>
</blocked_number>
</request>
Payload Description:¶
| Node Name | Description | Default Value | Data Type | Mandatory |
| number | The Blocked Number that has to be changed | STRING | YES | |
| new_number | The new value for the Blocked Number, if updating | STRING | NO | |
| operator | The Operator that has to be changed | STRING | YES, is the identifier together with number and in_or_out | |
| new_operator | The new value for Operator, if updating | STRING | NO | |
| in_or_out | The in_or_out that has to be changed | STRING | YES, is the identifier together with number and operator | |
| new_in_or_out | The new value for In Or Out, if updating | STRING | NO | |
| default | The new default value for this Blocked Number | STRING | NO | |
| if_exists | If the Blocked Number (new_...) already exists, what do we do? OVERWRITE will overwrite, empty will throw an error | STRING | NO | |
| rules>rule>links>link_id | The new Links we want to block this Number for | STRING | NO | |
| rules>rule>time_template | The new Time Template we want to block this Number for | STRING | NO |
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 PUT. x attempted | Switch request method x to PUT |
| 400 | XML Empty | Add xml to the request body |
| 400 | XML parse error. x at line y, column z | Correct XML at point x on line y, column z |
| 400 | Request Empty | Add Blocked Numbers to the request |
| 400 | Number x of y Empty | Add number x (item) of y (total) |
| 400 | In Or Out x of y Empty | Add in_or_out x (item) of y (total) |
| 400 | Operator x of y Empty | Add operator x (item) of y (total) |
| 400 | In Or Out x of y Invalid | Correct in_or_out x (item) of y (total) |
| 400 | Operator x of y Invalid | Correct operator x (item) of y (total) |
| 400 | Combination of Number, In Or Out and Operator in Blocked Number x of y does not exists. | Correct number, in_or_out, operator combination x (item) of y (total) |
| 500 | Internal Server Error | Retry later |