Live chat by BoldChat

 
Information and Sales
1.877.7.VOIP.MS
1.214.615.8599


XML Rates

All rates (~3MB)

XML API

Download documentation (Microsoft Word)

Version: 1.08

Index

Index
Query URL
Main URL
Optional GET Arguments
Wildcard matching
Examples
Results Formating
XML header
Error result example
Results description
Successful result example


Query URL

Main URL

https://www.voip.ms/rates/xmlapi.php

Optional GET Arguments

dest – Destination name
pattern – destination prefix

Wildcard matching

Use % for wildcards. (e.g.:    france%   ,    %Kingdom%,   44%,  %United States%)

Examples

  1. https://www.voip.ms/rates/xmlapi.php?dest=United
    Return no results

  2. https://www.voip.ms/rates/xmlapi.php?dest=%United%
    Return any results containing “United” in the name. Including United States, United Kingdom, United Arabe Emirates etc.

  3. https://www.voip.ms/rates/xmlapi.php?dest=United States%
    Return all results start with United States

  4. https://www.voip.ms/rates/xmlapi.php?dest=%United%&pattern=44%
    Return results from only United Kingdom because even if the destination match other countries, 44 is the country code for England.

  5. https://www.voip.ms/rates/xmlapi.php?pattern=1514
    Return Montreal, Canada only


  6. https://www.voip.ms/rates/xmlapi.php?pattern=441
    Returns result for United Kingdom proper only
    as opposed to
    https://www.voip.ms/rates/xmlapi.php?pattern=44%
    Return the whole United Kingdom results

Results Formatting

 

XML header

<?xml version="1.0" encoding="utf-8" ?>

Error result example

<error>
<code>404</code>
<description>No results found</description>
<dest>some country</dest>
<pattern>some code</pattern> </error>

 

Results description

If successful, main results array contain one or multiple item arrays. Each item childs are described here:

Short_description: Country name
Description: Detailed destination name
Prefix: Dial prefix
Rate: Current rate in US cents
old_rate: If current rate has been changed in the past, show old rate
old_rate_change: Date of last rate update for this item

Successful result example

<results>
  <item>
    <short_description>United Kingdom</short_description>
    <description>United Kingdom - Freephone</description>
    <prefix>44800</prefix>
    <rate>0.021255465</rate>
    <increment>6</increment>
    <old_rate>0.233545</old_rate>
    <old_rate_change>2007-06-02</old_rate_change>
  </item>
  <item>
    <short_description>United Kingdom</short_description>
    <description>United Kingdom - Freephone</description>
    <prefix>44808</prefix>
    <rate>0.021255465</rate>
    <increment>6</increment>
    <old_rate>0.000000</old_rate>
    <old_rate_change>0000-00-00</old_rate_change>
  </item>
  <item>
    <short_description>United Kingdom</short_description>
    <description>United Kingdom - Local Rate</description>
    <prefix>44845</prefix>
    <rate>0.08451366</rate>
    <increment>6</increment>
    <old_rate></old_rate>
    <old_rate_change></old_rate_change>
  </item>
<results>

 

 


 


Information and Sales (mon-fri 9-5)
Fax
Email
Usa/Canada: 1.877.7.VOIP.MS
Usa Toll Free: 1.888.311.7782
VoIP.ms Support (en/fr/es)
Dallas, Texas: 1.214.615.8599
Dallas, Texas: 1.214.723.7555
VoIP.ms Sales (en/fr/es)
Usa/Canada (French):: 1.866.914.5294
Sun 19th Feb, 2017 10:53 pm

Copyright © 2007-2017 VoIP.ms
Terms of service - Privacy policy
All currencies on this website are in USD (US Dollars)