VoIP - Ordering a Phone Number (REST API)

PROVISIONING A PHONE NUMBER

 

Overview

Single numbers can be ordered and instantly provisioned to accounts where available

 

Sample Query

https://voip.neural.net.au:15000/?user=USERNAME&pass=PASSWORD&action=provision-number&location=LOCATION

 

 

Field List

Field Name

Required

Sample Value

Description

user

Yes

Jsmith

Your Portal username

pass

Yes

Secret123

Your Portal password

action

Yes

provision-number

Must be ‘provision-number

location

Yes

Sydney

Location of the number (see list below)

desc

No

My Number

Description of the number

notes

No

Perth Sales Team

Any notes to be kept against the number

route_type

No

ACT

Route type to be used

route_target

No

090000

Target to route to

Fields are case sensitive

 

Number locations

 

Adelaide Adelaide, SA
Brisbane Brisbane, Queensland
Canberra Canberra, ACT
Hobart Hobart, TAS
Melbourne Melbourne, VIC
Perth Perth, WA
Sydney Sydney, NSW
Cairns Cairns, Queensland
GoldCoast Gold Coast, Queensland
Maroochydore Sunshine Coast, Queensland
Newcastle Newcastle, NSW
PortMacquarie Port Macquarie, QLD
Toowoomba Toowoomba, Queensland
National1300 1300 Number (National Fixed Rate)
Auckland Auckland, New Zealand
HerveyBay Hervey Bay, Queensland
Townsville Townsville, Queensland
Ipswich Ipswich, Queensland
National1800 1800 Number (National Free Call)
Berry Berry, NSW
Mackay Mackay, QLD
Bundaberg Bundaberg, QLD
Wollongong Wollongong, NSW
Geelong Geelong, VIC
Ballarat Ballarat, VIC
Bendigo Bendigo, VIC
Bunbury Bunbury, WA
Wellington Wellington, New Zealand
Christchurch Christchurch, New Zealand
Hamilton Hamilton, New Zealand
Darwin Darwin, NT
Bathurst Bathurst, NSW
Menangle Menangle, NSW
Albury Albury, NSW
Dubbo Dubbo, NSW
Geraldton Geraldton, WA
Rockhampton Rockhampton, QLD

 

Location names should be entered as above, with no spaces and using the capitalization shown.

Locations are updated periodically and specific locations can be ordered on request.  Please contact sales if you require a location not listed here.

 

 

 

Route Types and Targets

 

Type

Target

Description

ACT

090000

Route to an account

DIV

0412345678

Divert to an external number

NONE

(blank)

Reject the call

PBX

090000

Route to account, always send the destination number (ignore account setting)

EXT

090000

Route to account, never send the destination number (ignore account setting)

ACTFO

09000,0412345678

Route to account, failing over to external number if the account is unreachable

FAX

email|sales@company.com.au

Accept incoming calls as faxes and e-mail faxes to the account specified

FAX

post|http://1.2.3.4/fax.php

Accept incoming calls as faxes and HTTP(s) post to the URL specified

 

 

Return Values

 

Success:

ok|<Number>

backorder|0

 

Error:

error|<Error code>

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk