SipSettingsApi

Version 22 (Adrian Georgescu, 09/25/2009 09:03 pm)

1 1 Adrian Georgescu
= SIP Settings API =
2 1 Adrian Georgescu
 
3 1 Adrian Georgescu
[[TOC(WikiStart, Sip*, depth=3)]]
4 1 Adrian Georgescu
5 1 Adrian Georgescu
== API address ==
6 1 Adrian Georgescu
7 20 Adrian Georgescu
To access the API, a client must connect using HTTP protocol to the following address: 
8 1 Adrian Georgescu
9 1 Adrian Georgescu
https://blink.sipthor.net/settings.phtml
10 19 Adrian Georgescu
11 20 Adrian Georgescu
To be authorized, the client must use a TLS client certificate, this certificate can be retrieved in the Info tab of the web page for the SIP account settings.
12 1 Adrian Georgescu
 
13 22 Adrian Georgescu
== TLS Certificate ==
14 1 Adrian Georgescu
15 13 Adrian Georgescu
Use the web settings page and navigate to the Info tab. Download the TLS certificate in the format supported by your HTTP client. 
16 1 Adrian Georgescu
17 14 Adrian Georgescu
 * !user@domain.crt format can be use by command line tools like curl 
18 14 Adrian Georgescu
 * !user@domain.p12 format can be imported in web browsers
19 5 Adrian Georgescu
20 7 Adrian Georgescu
The .p12 file contains the same certificate stored in a way that can be loaded by web browsers like Safari on MacOSX or Firefox.  To unlock the .p12 file you must use the password for your SIP account.
21 1 Adrian Georgescu
22 1 Adrian Georgescu
== API calls ==
23 1 Adrian Georgescu
24 1 Adrian Georgescu
You can test all API commands by using the '''curl''' command line utility as follows:
25 1 Adrian Georgescu
26 1 Adrian Georgescu
{{{
27 15 Adrian Georgescu
curl -k -E user@domain.crt https://blink.sipthor.net/settings.phtml?action=name
28 1 Adrian Georgescu
}}}
29 3 Adrian Georgescu
30 3 Adrian Georgescu
The following actions are supported:
31 1 Adrian Georgescu
32 1 Adrian Georgescu
 1. Return the account information:
33 1 Adrian Georgescu
{{{
34 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=enum
35 1 Adrian Georgescu
}}}
36 1 Adrian Georgescu
 1. Return the SIP aliases:
37 1 Adrian Georgescu
{{{
38 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=aliases
39 1 Adrian Georgescu
}}}
40 1 Adrian Georgescu
 1. Return the ENUM numbers:
41 1 Adrian Georgescu
{{{
42 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=enum
43 1 Adrian Georgescu
}}}
44 4 Adrian Georgescu
 1. Return the last incoming and outgoing calls:
45 4 Adrian Georgescu
{{{
46 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=calls
47 4 Adrian Georgescu
}}}
48 1 Adrian Georgescu
 1. Return the prepaid balance and active prepaid calls:
49 1 Adrian Georgescu
{{{
50 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=prepaid
51 1 Adrian Georgescu
}}}
52 1 Adrian Georgescu
 1. Return the history of prepaid balance:
53 1 Adrian Georgescu
{{{
54 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=balance_history
55 1 Adrian Georgescu
}}}
56 1 Adrian Georgescu
 1. Return the curent monthly usage:
57 1 Adrian Georgescu
{{{
58 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=monthly_usage
59 1 Adrian Georgescu
}}}
60 1 Adrian Georgescu
 1. Return the list of diversions:
61 1 Adrian Georgescu
{{{
62 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=diversions
63 1 Adrian Georgescu
}}}
64 1 Adrian Georgescu
 1. Return the list of accept rules:
65 1 Adrian Georgescu
{{{
66 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=accept
67 1 Adrian Georgescu
}}}
68 1 Adrian Georgescu
 1. Return the list of reject rules:
69 1 Adrian Georgescu
{{{
70 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=reject
71 1 Adrian Georgescu
}}}
72 1 Adrian Georgescu
 1. Return the voicemail settings:
73 1 Adrian Georgescu
{{{
74 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=voicemail
75 1 Adrian Georgescu
}}}
76 9 Adrian Georgescu
 1. Enabled Do Not Disturb
77 9 Adrian Georgescu
{{{
78 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=dnd_on
79 9 Adrian Georgescu
}}}
80 9 Adrian Georgescu
 1. Disable Do Not Disturb
81 9 Adrian Georgescu
{{{
82 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=dnd_off
83 9 Adrian Georgescu
}}}
84 17 Adrian Georgescu
 1. Enable Do Not Disturb for 60 minutes
85 9 Adrian Georgescu
{{{
86 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=dnd_on&duration=60
87 9 Adrian Georgescu
}}}
88 10 Adrian Georgescu
 1. Enabled privacy (hide Caller Id for outgoing calls)
89 10 Adrian Georgescu
{{{
90 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=privacy_on
91 10 Adrian Georgescu
}}}
92 10 Adrian Georgescu
 1. Disable privacy
93 10 Adrian Georgescu
{{{
94 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=privacy_off
95 10 Adrian Georgescu
}}}
96 11 Adrian Georgescu
 1. Add an alias to our own account 
97 11 Adrian Georgescu
{{{
98 15 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=add_alias&username=alice
99 11 Adrian Georgescu
}}}
100 16 Adrian Georgescu
 1. Set diversions
101 16 Adrian Georgescu
{{{
102 21 Adrian Georgescu
https://blink.sipthor.net/settings.phtml?action=set_diversions&FUNC=target&FBUS=target&...
103 16 Adrian Georgescu
}}}
104 16 Adrian Georgescu
{{{
105 16 Adrian Georgescu
FUNC = Forward unconditional all calls
106 16 Adrian Georgescu
FBUS = Forward on Busy
107 16 Adrian Georgescu
FNOL = Forward on Not Online
108 16 Adrian Georgescu
FNOA = Forward on No Answer
109 16 Adrian Georgescu
FUNV = Forward when Not Available based on Accept rules
110 16 Adrian Georgescu
}}}