- By Docs
- 2015-01-07 17:23:41
This webservice will allow you to purchase a number.
# Username/Password - your username and password
# Number - the number you are purchasing
# URI - the destination (SIP URI) for this number
# URI2/URI3 - backup destinations for this number
# RingType - how will we ring these numbers?
* RingType => 1 - Sequential - all the URIs will be called in the order they are setup (First we will ring URI, then URI1, then URI2)
* RingType => 2 - Random - only a single URI will be called, selected randomly from the list of provided URIs. If only a single URI is provided, then that'll be the one used
* RingType => 3 - Simultaneously - ring all three URIs at the same time.
# FaxDetect - If FaxDetect is set to 1 , all calls towards this number will automatically be picked up by the system and fax detection will run. Please note that this feature is not free. Its a per account feature, so if you enable it on a single number or 100 numbers - it will cost you the same amount per month. Default value is 0 (not enabled)
# FaxRing - how many seconds should we listen for fax tones before sending the call to URI / URI1 / URI2 ?
# FaxEmail - the email address that will receive the fax messages. Please note that the emails are also stored on the server and you can always view them in your account.
# Vm - If Vm is set to 1 , all unanswered calls will be picked up by our voicemail system. You can record a voicemail greeting in our customer control panel (your web account). Please note that this feature is not free. Its a per account feature, so if you enable it on a single number or 100 numbers - it will cost you the same amount per month. Default value is 0 (not enabled)
# Vmring - How many seconds should we wait for an answer before the voicemail system picks up the call?
# Vmemail - Whats the email address we should be sending this voicemail to?
# Vmtts - Voicemail Text to Speech - This will attempt to translate your VoiceMail messages. Works only for messages in English (US/UK/Australian English) . Please note that this feature is not free. Its a per account feature, so if you enable it on a single number or 100 numbers - it will cost you the same amount per month. Default value is 0 (not enabled). This feature is only charged if you have numbers which have VoiceMail enabled.
# Cnam - enable CNAM lookups for this number - This feature will attempt to identify incoming calls and provide a CallerID Name on the outbound call leg. This feature will charge for successful CNAM lookups.
# Type - type of forward ( 1 is for SIP)
A simplified version is available below:
Successful number purchase output:
Unsuccessful number purchase output (Number not available):
Unsuccessful number purchase output (Not enough credit):
Unsuccessful number purchase output (User or Password incorrect):
SOAP XML Definition