SIP2SIP

h1. SIP Account API

This API can be used from third party applications that wish to interact with the SIP account data stored on the server. Data can be read or modified by calling various functions.

h2. Server API Address

To access the API, a client must connect using HTTP protocol to the following address:

https://enrollment.sipthor.net/settings.phtml

The return is encoded using "json":http://json.org.

h2. API Functions

You can test the following API commands by using the *curl* command line utility as follows:

h3. Identity

<pre>
curl https://enrollment.sipthor.net/settings.phtml?action=get_identity
</pre>

The following actions are supported:

h3. Identity

# Return identity information:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_identity
</pre>

h3. SIP aliases


# Return the SIP aliases:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_aliases
</pre>

# Add an alias to our own account
<pre>
https://enrollment.sipthor.net/settings.phtml?action=add_alias&username=alice
</pre>

h3. ENUM numbers

# Return the ENUM numbers:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_enum
</pre>

h3. Call history


# Returns call history:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_history
</pre>

h3. Registered devices


# Return the list of registered devices
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_devices
</pre>

h3. Prepaid


# Return the prepaid balance and active calls:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_prepaid
</pre>
# Return the history of prepaid balance:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_balance_history
</pre>
# Return the curent monthly usage:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_monthly_usage
</pre>

h3. Call forwarding


# Return the call forwarding settings:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_call_forwarding
</pre>

# Set call forwarding
<pre>
https://enrollment.sipthor.net/settings.phtml?action=set_call_forwarding&FUNC=target&FBUS=target&...
</pre>
<pre>
FUNC = Forward unconditional all calls
FBUS = Forward on Busy
FNOL = Forward on Not Online
FNOA = Forward on No Answer
FUNV = Forward when Not Available based on Accept rules

Pre-defined keywords for diversion targets:

<voice-mailbox>
<mobile-number>

</pre>

h3. Call filtering

# Return the list of accept rules:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_accept_rules
</pre>
# Return the list of reject rules:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_reject_rules
</pre>

h3. Voicemail settings


# Return the voicemail settings:
<pre>
https://enrollment.sipthor.net/settings.phtml?action=get_voicemail
</pre>

h3. Do not disturb


# Enabled Do Not Disturb
<pre>
https://enrollment.sipthor.net/settings.phtml?action=set_dnd_on
</pre>
# Disable Do Not Disturb
<pre>
https://enrollment.sipthor.net/settings.phtml?action=set_dnd_off
</pre>
# Enable Do Not Disturb for 60 minutes
<pre>
https://enrollment.sipthor.net/settings.phtml?action=set_dnd_on&duration=60
</pre>

h3. Privacy


# Enabled privacy (hide Caller Id for outgoing calls)
<pre>
https://enrollment.sipthor.net/settings.phtml?action=set_privacy_on
</pre>
# Disable privacy
<pre>
https://enrollment.sipthor.net/settings.phtml?action=set_privacy_off
</pre>
# Add an alias to our own account
<pre>
https://enrollment.sipthor.net/settings.phtml?action=add_alias&username=alice
</pre>
# Set call forwarding
<pre>
https://enrollment.sipthor.net/settings.phtml?action=set_call_forwarding&FUNC=target&FBUS=target&...
</pre>
<pre>
FUNC = Forward unconditional all calls
FBUS = Forward on Busy
FNOL = Forward on Not Online
FNOA = Forward on No Answer
FUNV = Forward when Not Available based on Accept rules

Pre-defined keywords for diversion targets:

<voice-mailbox>
<mobile-number>

</pre>