transferVoxnumbers¶

Request Method: PUT

Description: This function will move the VoxNumbers in the payload from an origin account to a destination account.

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

Note: This function will not transfer a VoxNumber which is still assigned to a 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 version="1.0" encoding="utf-8"?>
<request>
    <origin_partner_name>Account A</origin_partner_name>
    <destination_partner_name>Account B</destination_partner_name>
    <voxnumbers>
        <voxnumber>442035514820</voxnumber>
        ...
    </voxnumbers>
</request>

Parameters¶

Parameter	Description	Default Value	Data Type	Mandatory
origin_partner_name	The origin partner account from where the VoxNumber is allocated		STRING	YES
destination_partner_name	The destination partner account where we want to place the VoxNumber		STRING	YES
voxnumbers > voxnumber	One or multiple VoxNumbers we want to transfer from the origin partner account to the destination partner account		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	Origin Partner Name is empty	Add Origin Partner Name
400	Origin Partner Name does not exist	Correct the Origin Partner Name
400	Destination Partner Name is empty	Add Destination Partner Name
400	Destination Partner Name does not exist	Correct the Destination Partner Name
400	voxnumbers is empty	Correct VoxNumber(s)
400	voxnumber x of y is empty	Add a VoxNumber
400	voxnumber x of y does not exist	Correct VoxNumber
400	voxnumber x of y is not in a international format	Correct VoxNumber
400	voxnumber x of y is not available	Dettach the VoxNumber from link in order to transfer VoxNumber

Success Result¶

HTTP/1.1 204 No Content