/
4.1.14 Rates

4.1.14 Rates

Owned by Tomasz Kozierowski
Last updated: Feb 26, 2025 by Piotr Mrozek

Rates

URL: /rates.ashx

The method returns the rates for calls and text messages for a given country or a specific number, depending on what parameter is sent. If both parameters are provided, country rates will be returned. It is also possible to download rates from a given client's tariff, in which case the client's SIP login and password must also be sent to the server.

Parameter

Description

lLogin - login of SIP account  (optional)
pPassword - password of SIP account SIP (optional)

cc

Country code 

n

Number 


To check rates for specific country:

--header 'User-Agent: vippie;ios;1.2.3' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic cGlvdHIyOndpZWxraXBpb3Ry' \
--header 'X-VIPPIE-DEVICE-ID: ff66fc693846285d' \
--header 'X-VIPPIE-DEVICE-NAME: iPhone8,1'

Returned value

{
    "cr": [
        {
            "d": "Poland-Landline",
            "r": 0.020
        },
        {
            "d": "Poland-Mobile",
            "r": 0.030
        },
        {
            "d": "Poland-Special",
            "r": 0.340
        }
    ],
    "sr": [],
    "pl": []
}


To check destination rate for number you want to dial and display it under the number:

--header 'User-Agent: vippie;ios;1.2.3' \
--header 'Content-Type: text/plain' \
--header 'Authorization: Basic cGlvdHIyOndpZWxraXBpb3Ry' \
--header 'X-VIPPIE-DEVICE-ID: ff66fc693846285d' \
--header 'X-VIPPIE-DEVICE-NAME: iPhone8,1'

Returned value

{
    "cr": {
        "r": 0.010,
        "d": "United Kingdom-Landline"
    },
    "sr": {
        "r": -1,
        "d": ""
    }
}

Response after sending the cc parameter:

{
 "cr": [
  {
   "d" : string,
   "r" : decimal
  }
 ],
 "sr": [
  {
   "d" : string,
   "r" : decimal
  }
 ],
 "pl": [
  {
   "id": int,
   "d" : string,
   "n" : string,
   "pr": bool,
   "pt": int,
   "pn": int,
   "pc": decimal,
   "sc": decimal
  }
 ]
}

where:

  • cr - contains information about call rates (d - description, r - rate),
  • sr - contains information about SMS rates (d - description, r - rate),
  • pl - contains information about the plans that could exist in a given country code (id - plan identifier, d - description, n - name, pr - whether the plan is periodic, pt - period type, pn - period number, pc - period cost, sc - startup cost),

Response after sending the n parameter:

{
	"cr": { r: "0.453", d: "desc"},
	"sr": { r: "0.123", d: "desc"}
}

If an error occurs on the server or any of the parameters contain an incorrect value, the method will return the appropriate 3-digit error code shown below:

Code

Description

400

Incorrect parameters - one of the parameters was not provided

404

Invalid HTTP method - only POST method accepted

500

Internal server error

Related content