SIP2SIP

SipSettingsApi » History » Revision 4

Revision 3 (Adrian Georgescu, 09/23/2009 02:39 PM) → Revision 4/68 (Adrian Georgescu, 09/23/2009 02:40 PM)

= SIP Settings API = 
 
 [[TOC(WikiStart, Sip*, depth=3)]] 

 Is possible read and write various SIP account settings by making one shot HTTP requests. When you access the SIP settings page the server prompts for the SIP account credentials which are then associated with a web session. To perform one shot HTTP requests to access this API you must use a client X.509 certificate to authorize the request, there is no long lived session. 

 == API address == 

 To access the API the HTTP client must connect to the following address: 

 https://blink.sipthor.net/settings.phtml 
 
 == Client Certificate == 

 Use the web settings page and navigate to Info tab. Download the certificate in the format supported by your HTTP client.  

  * user@domain.crt format can be use by command line tools like curl  
  * user@domain.p12 format contains the same client 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 

 == API calls == 

 You can test all API commands by using the '''curl''' command line utility as follows: 

 {{{ 
 curl -k -E user@domain.crt https://blink.sipthor.net/settings.phtml?export=1&action=name 
 }}} 

 The following actions are supported: 

  1. Return the account information: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=enum 
 }}} 
  1. Return the SIP aliases: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=aliases 
 }}} 
  1. Return the ENUM numbers: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=enum 
 }}} 
  1. Return the last incoming and outgoing calls: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=calls 
 }}} 
  1. Return the prepaid balance and active prepaid calls: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=prepaid 
 }}} 
  1. Return the history of prepaid balance: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=balance_history 
 }}} 
  1. Return the curent monthly usage: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=monthly_usage 
 }}} 
  1. Return the list of diversions: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=diversions 
 }}} 
  1. Return the list of accept rules: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=rules 
 }}} 
  1. Return the list of reject rules: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=reject 
 }}} 
  1. Return the voicemail settings: 
 {{{ 
 https://blink.sipthor.net/settings.phtml?export=1&action=voicemail 
 }}}