SIPBroker

Welcome to the SIP Broker web services home page. This page describes the web services that SIP Broker currently provides.

ENUM Lookup

Overview

This service accepts the submission of a HTTP request containing a e164 number as a parameter and returns an XML document that contains a collection of SIP URIs that match that number. The current behaviour queries 5 ENUM roots (e164.arpa, e164.org, e164.info, e164.televolution.net, and enum.org) but has the capability of querying other roots. All queries are executed in parallel, so there is no penalty for querying more roots. A simple example is:

http://www.sipbroker.com/enum/18005551212

An example of the XML that would be returned would be:

<?xml version="1.0" encoding="UTF-8"?>
<enums xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation=
        "http://www.sipbroker.com/sbXML.xsd">
  <enum>
    <number>18005551212</number>
    <root>e164.arpa</root>
    <uri></uri>
    <time>86</time>
  </enum>
  <enum>
    <number>18005551212</number>
    <root>e164.org</root>
    <uri>sip:18005551212@tf.voipmich.com</uri>
    <time>67</time>
  </enum>
  <enum>
    <number>18005551212</number>
    <root>e164.info</root>
    <uri></uri>
    <time>350</time>
  </enum>
  <enum>
    <number>18005551212</number>
    <root>e164.televolution.net</root>
    <uri></uri>
    <time>105</time>
  </enum>
  <enum>
    <number>18005551212</number>
    <root>enum.org</root>
    <uri></uri>
    <time>287</time>
  </enum>
</enums>

Input Parameters

The basic URL for the HTTP request is http://www.sipbroker.com/enum/xxx where xxx is a valid e164 number.

Parameter Name	Mandatory	Expected Values	Description
format	no	One of: xml (default) csv simple	Determines the format that the response is returned. If xml is chosen, then XML conforming to this schema is returned. If csv is passed, then the values are passed in a comma-separated list (and with a mime-type of application/vnd.ms-excel). If simple is used, then only matching SIP uris are returned (ie. one per line - if no matches are found, then an empty string is returned).
timeout	no	integer (default 350)	The total length of time (in milliseconds) that the SIP Broker server will wait for a response from the ENUM roots.
extraRoots	no	comma-seperated list of other ENUM roots	This is a collection of other roots that you can query. The default list of ENUM roots will always be queried - these are additional candidate roots. Do not use a leading or trailing comma.

Output Values

While the format of the output data may vary depending on the format you requested, the following fields of data are available:

Name	Description
number	The number you searched for
root	The ENUM root that was used to query this result
uri	The uri that was returned from the root
time	The time it took to query that particular root

Examples

Invalid e164 Number

Input

http://www.sipbroker.com/enum/bade164number

Output

<xml version="1.0" encoding="UTF-8"?>
<errors xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation=
        "http://www.sipbroker.com/sbXML.xsd">
  <error>bade164number is not a valid e164 number.<error>
<errors>

Comma Seperated Values

Input

http://www.sipbroker.com/enum/18005551212?format=csv

Output

18005551212,e164.arpa,,63,
18005551212,e164.org,sip:18005551212@tf.voipmich.com,120,
18005551212,e164.info,,164,
18005551212,e164.televolution.net,,84,
18005551212,enum.org,,53,

Simple Output

Input

http://www.sipbroker.com/enum/18005551212?format=simple

Output

sip:18005551212@tf.voipmich.com

SIP Code Lookup

Overview

This service allows for the lookup of one (or all) SIP Codes. A very simple example is:

http://www.sipbroker.com/sipcode/010?username=xxx&password=yyy

And the data that would be returned as a result of that query is:

<?xml version="1.0" encoding="UTF-8"?>
<sipcodes xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation=
        "http://www.sipbroker.com/sbXML.xsd">
  <sipcode>
    <code>010</code>
    <name>Voxalot Communications</name>
    <proxy>voxalot.com</proxy>
    <country>AU</country>
  </sipcode>
</sipcodes>

Input Parameters

The basic URL for the HTTP request is http://www.sipbroker.com/sipcode/xxx where xxx is a valid SIP Code. In addition, you can also omit the SIP Code (http://www.sipbroker.com/sipcode) which will return all SIP Codes.

Parameter Name	Mandatory	Expected Values	Description
format	no	One of: xml (default) csv	Determines the format that the response is returned. If xml is chosen, then XML conforming to this schema is returned. If csv is passed, then the values are passed in a comma-separated list (and with a mime-type of application/vnd.ms-excel).
username	yes	assigned username	contact info@sipbroker.com to get a user name and password
password	yes	password associated with username	contact info@sipbroker.com to get a user name and password

Output Values

While the format of the output data may vary depending on the format you requested, the following fields of data are available:

Name	Description
code	The SIP Code
name	The registered provider name (free format)
proxy	The proxy address for that SIP Code
country	The primary registered country for that SIP Code

Examples

Invalid SIP Code

Input

http://www.sipbroker.com/sipcode/badsipcode

Output

<?xml version="1.0" encoding="UTF-8"?>
<errors xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:noNamespaceSchemaLocation=
        "http://www.sipbroker.com/sbXML.xsd">
  <error>badsipcode is invalid.</error>
</errors>

Comma Seperated Values

Input

http://www.sipbroker.com/sipcode/010?format=csv

Output

010,Voxalot Communications,voxalot.com,,

SIP Broker

Improve your SIP telephone experience!

ENUM Lookup

Overview

Input Parameters

Output Values

Examples

Invalid e164 Number

Comma Seperated Values

Simple Output

SIP Code Lookup

Overview

Input Parameters

Output Values

Examples

Invalid SIP Code

Comma Seperated Values

Login

Sponsors