Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

ParameterRequiredDescription
outputYesOne of :  json , xml , csv
usernameYesYour account username or API username.
passwordYesYour account password or API password.
numberYesThe phone number you wish to purchase - get this from the output of GetDIDs function.
descriptionNoDescription of this phone number (intended usage or end-customer name, etc)
typeNoCall forward destination (scroll down for more info) . Values 1 or 2 should suffice for most users.
ringtypeNo1 - sequential (try uri, uri2,uri3 in order ; 2 - random (try uri, uri2, uri3 randomly) ; 3 - simultaneous (try all uris at the same time)
ringstyleNo1 - just ring ; 2 - replace ring with music on hold
uriNoSIP URI : valid number@domain for "type" => 1 or valid phone number in E164 format for "type" => 2 (no +, no 00, no 011 prefixes)
uri2NoSIP URI : valid number@domain for "type" => 1 or valid phone number in E164 format for "type" => 2 (no +, no 00, no 011 prefixes)
uri3NoSIP URI : valid number@domain for "type" => 1 or valid phone number in E164 format for "type" => 2 (no +, no 00, no 011 prefixes)
callnotifyurlNo

Valid http or https URL - we will send a POST request containing a JSON string
Sample :

{"event": ?, "status": ?, "timestamp": ?, "caller": ?, "called": ?, "callid": ?}
smsringtypeNo1 - E-Mail , 2 - URL ; 3 - SMS Flow ; 4 - Autoreply ; 5 - SIP ; 6 - XMPP ; 7 - RSVP ; 8 - SIP Account ; 9 - Hosted PBX; 11 - MailChimp
smsuriNoValid URI (email address if smsringtype is 1 , valid URL if smsringtype is 2 , valid identifiers for the other options)
faxdetectNo(retired) - If set to 1 , call will be picked up and system will listen for fax tones for up to {faxring} seconds
faxemailNo(retired) - E-Mail address to forward fax message to
faxringNo(retired) - How many seconds should we listen for ring tones?
vmNo(retired) - Should the call be picked up by the VoiceMail system if no answer?
vmringNo(retired) - How many seconds should we ring before forwarding call to VoiceMail?
vms2tNo(retired) - Voicemail Speech 2 Text (convert voicemail messages to text)
vmemailNo(retired) - Send Voicemail as e-mail to this e-mail address
cnamNoSet to 1 to enable CNAM queries (cost of $0.004 applies per CNAM query) ; set to 0 to disable; Defaults to 0
recordNoSet to 1 to record inbound calls ; Set to 0 to disable; Defaults to 0
screeningNo(retired) Enable Call Screening; Each call is picked up by the system which asks the caller to identify themselves. Defaults to 0
channelsNoHow many channels are we purchasing? Defaults to 2 (or in some cases 1, depending what is the number of free channels on that number)
atcdNo(retired) Anti telemarketer call detection : System picks up the calls and listens for automated messages before deciding if call will be further forwarded to you
autorenewNoPossible values: 1: Renew the number automatically ; 2: Do not renew the number (number expires at the end of month). Default value: 1
overflowNoIf your number receives more simultaneous calls than the allocated number of channels, automatically allow the extra calls (a cost per minute applies)

Anchor
callforwarding
callforwarding

...