SipSettingsApi

Version 45 (Adrian Georgescu, 07/13/2011 09:04 am)

1 38 Adrian Georgescu
= Settings API =
2 1 Adrian Georgescu
 
3 1 Adrian Georgescu
[[TOC(WikiStart, Sip*, depth=3)]]
4 1 Adrian Georgescu
5 39 Adrian Georgescu
This API can be used from third party applications that wish to interact with the SIP account settings. Data can be read or modified by calling various functions.
6 1 Adrian Georgescu
7 39 Adrian Georgescu
== API Address ==
8 39 Adrian Georgescu
9 20 Adrian Georgescu
To access the API, a client must connect using HTTP protocol to the following address: 
10 1 Adrian Georgescu
11 29 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml
12 19 Adrian Georgescu
13 23 Adrian Georgescu
The return is encoded using [http://json.org json].
14 1 Adrian Georgescu
15 39 Adrian Georgescu
== API Functions ==
16 1 Adrian Georgescu
17 35 Adrian Georgescu
You can test the following API commands by using the '''curl''' command line utility as follows:
18 35 Adrian Georgescu
19 3 Adrian Georgescu
{{{
20 44 Adrian Georgescu
curl https://enrollment.sipthor.net/settings.phtml?action=get_identity
21 1 Adrian Georgescu
}}}
22 1 Adrian Georgescu
23 1 Adrian Georgescu
The following actions are supported:
24 1 Adrian Georgescu
25 40 Adrian Georgescu
 1. Return identity information:
26 1 Adrian Georgescu
{{{
27 41 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_identity
28 1 Adrian Georgescu
}}}
29 1 Adrian Georgescu
 1. Return the SIP aliases:
30 1 Adrian Georgescu
{{{
31 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_aliases
32 1 Adrian Georgescu
}}}
33 1 Adrian Georgescu
 1. Return the ENUM numbers:
34 1 Adrian Georgescu
{{{
35 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_enum
36 1 Adrian Georgescu
}}}
37 42 Adrian Georgescu
 1. Return the list of last calls:
38 4 Adrian Georgescu
{{{
39 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_calls
40 4 Adrian Georgescu
}}}
41 30 Adrian Georgescu
 1. Return the list of registered devices
42 30 Adrian Georgescu
{{{
43 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_devices
44 30 Adrian Georgescu
}}}
45 40 Adrian Georgescu
 1. Return the prepaid balance and active calls:
46 1 Adrian Georgescu
{{{
47 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_prepaid
48 1 Adrian Georgescu
}}}
49 1 Adrian Georgescu
 1. Return the history of prepaid balance:
50 1 Adrian Georgescu
{{{
51 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_balance_history
52 1 Adrian Georgescu
}}}
53 1 Adrian Georgescu
 1. Return the curent monthly usage:
54 1 Adrian Georgescu
{{{
55 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_monthly_usage
56 1 Adrian Georgescu
}}}
57 42 Adrian Georgescu
 1. Return the call forwarding settings:
58 1 Adrian Georgescu
{{{
59 40 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_call_forwarding
60 1 Adrian Georgescu
}}}
61 1 Adrian Georgescu
 1. Return the list of accept rules:
62 1 Adrian Georgescu
{{{
63 40 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_accept_rules
64 1 Adrian Georgescu
}}}
65 1 Adrian Georgescu
 1. Return the list of reject rules:
66 1 Adrian Georgescu
{{{
67 40 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_reject_rules
68 1 Adrian Georgescu
}}}
69 1 Adrian Georgescu
 1. Return the voicemail settings:
70 1 Adrian Georgescu
{{{
71 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=get_voicemail
72 1 Adrian Georgescu
}}}
73 9 Adrian Georgescu
 1. Enabled Do Not Disturb
74 9 Adrian Georgescu
{{{
75 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=set_dnd_on
76 9 Adrian Georgescu
}}}
77 9 Adrian Georgescu
 1. Disable Do Not Disturb
78 9 Adrian Georgescu
{{{
79 32 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=set_dnd_off
80 9 Adrian Georgescu
}}}
81 17 Adrian Georgescu
 1. Enable Do Not Disturb for 60 minutes
82 9 Adrian Georgescu
{{{
83 33 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=set_dnd_on&duration=60
84 9 Adrian Georgescu
}}}
85 10 Adrian Georgescu
 1. Enabled privacy (hide Caller Id for outgoing calls)
86 10 Adrian Georgescu
{{{
87 33 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=set_privacy_on
88 10 Adrian Georgescu
}}}
89 10 Adrian Georgescu
 1. Disable privacy
90 10 Adrian Georgescu
{{{
91 33 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=set_privacy_off
92 10 Adrian Georgescu
}}}
93 11 Adrian Georgescu
 1. Add an alias to our own account 
94 11 Adrian Georgescu
{{{
95 29 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=add_alias&username=alice
96 11 Adrian Georgescu
}}}
97 42 Adrian Georgescu
 1. Set call forwarding
98 16 Adrian Georgescu
{{{
99 40 Adrian Georgescu
https://enrollment.sipthor.net/settings.phtml?action=set_call_forwarding&FUNC=target&FBUS=target&...
100 16 Adrian Georgescu
}}}
101 16 Adrian Georgescu
{{{
102 16 Adrian Georgescu
FUNC = Forward unconditional all calls
103 16 Adrian Georgescu
FBUS = Forward on Busy
104 16 Adrian Georgescu
FNOL = Forward on Not Online
105 16 Adrian Georgescu
FNOA = Forward on No Answer
106 16 Adrian Georgescu
FUNV = Forward when Not Available based on Accept rules
107 25 Adrian Georgescu
108 27 Adrian Georgescu
Pre-defined keywords for diversion targets:
109 26 Adrian Georgescu
110 24 Adrian Georgescu
<voice-mailbox>
111 25 Adrian Georgescu
<mobile-number>
112 25 Adrian Georgescu
113 24 Adrian Georgescu
}}}