Tariscope 4.6.Tariscope API guide

Tariscope API Methods

This is a GET request that provides a list of active tariffs.

Query parameters:

providerid – identifier of a specific operator. If providerid = 0, then information for all operators is returned.
planid – The identifier of a specific tariff plan. If planid = 0, then information on all tariff plans is returned.
direction – direction, which can have the following values:
in – incoming;
out – outgoing;
all – incoming and outgoing.
rateid – is the tariff identifier. If a specific tariff identifier is specified, then data for only that tariff is returned. If the value 0 is specified, then information for all tariffs that match the other query parameters is returned.

Data returned by the query:

id – tariff plan identifier.
name –tariff name.
providerid – provider identifier.
parametersid – tariff parameters identifier.
planid – tariff plan identifier.
activedate – date from which the tariff is valid.
currencyid – tariff currency identifier.
value – tariff value.
roundto –type of rounding of the call duration.
freeseconds – free seconds.
substractseconds – seconds that are not included in the call.
roundcostto – type of call cost rounding.
rounddurationdown – a sign of rounding the call duration down.
roundcostdown - a sign of rounding the cost of the call down.
roundfirstminute – a sign that the 1st minute of the call is rounded to 1 minute..
noaccount - an indication of the amount being charged to subscribers' accounts.
accountdescription - the content of the record that appears in subscribers' accounts for a specific charge.
accountdns - an indication of charging services to a specific phone number (IP address).
minimumduration - the minimum duration that will be charged.
stages - an indication of the option to use the staged tariff: for all calls or separately for one call.
minimumcost –minimum cost of the call.

Example of a query to get all tariffs of the provider with ID = 84, tariff plan with ID = 43 for all directions: