VoIP - Creating an Account (REST API)

CREATING AN ACCOUNT

 

Overview

Accounts can be used either as SIP trunks for Asterisk, Trixbox, OCS or other SIP enabled PBX systems, or as basic SIP accounts to directly connect handsets to Neural’s VoIP network.

 

Sample Query

https://voip.neural.net.au:15000/?user=USERNAME&pass=PASSWORD&action=createuser&transport=udp

 

Field List

Field Name

Required

Sample Value

Description

user

Yes

Jsmith

Your Portal username

pass

Yes

Secret123

Your Portal password

action

Yes

createuser

Must be ‘createuser’

transport

No

udp

Must be ‘udp’ or ‘tcp’ – SIP transport to use

senddest

No

1

Send the destination number in SIP headers 0/1

recordIn

No

0

Record incoming calls 0/1

recordOut

No

0

Record outgoing calls 0/1

desc

No

Test 123

Description of the account – visible in webApp

callerid

No

0298765432

Default callerID  to send.  Must be an authorized number, “anonymous” for silent or “passthrough” for CID passthrough from the remote device

restrict

No

0

Restrict outbound dialing from the account

0 - unrestricted

1 - no international

2 - no mobile

3 - no int. or mob.

4 - no outbound calling

 

Fields are case sensitive; sample value is representative of default value, with the exception of callerid which defaults to “anonymous”

 

Return Values

 

Success:

ok|<Account Username>|<Account Password>

 

Error:

error|<Error code>

Have more questions? Submit a request

0 Comments

Please sign in to leave a comment.
Powered by Zendesk