Pricing API

Version 1

The API to retrieve pricing information. Please note the Pricing API is rate limited to one request per second.

Télécharger la spécification OpenAPI
Opérations disponibles

Retrieve outbound pricing for a specific country.

Retrieves the pricing information based on the specified country.

gethttps://rest.nexmo.com/account/get-pricing/outbound/:type

Trajectoire Paramètres

type
string
Exigée

The type of service you wish to retrieve data about: either sms, sms-transit or voice.

Demande de renseignements Paramètres

api_key
string

Your Nexmo API key.

api_secret
string

Your Nexmo API secret.

country
string

A two letter country code. For example, CA.

Réponses
Type de contenu
application/json

Pricing information for a specific country.

countryCode
string
exempleCA

Two letter country code.

countryName
string
exempleCanada

Readable country name.

countryDisplayName
string
exempleCanada

Readable country name.

currency
string
exempleEUR

The currency that your account is being billed in (by default Euros—EUR).

defaultPrice
string
exemple0.00620000

The default price.

dialingPrefix
string
exemple1

The dialling prefix.

networks
array

An array of network objects

type
string
exemplemobile

The type of network: mobile or landline.

price
string
exemple0.00590000

The cost to send a message or make a call to this network

currency
string
exempleEUR

The currency used for prices for this network.

mcc
string
exemple302

The Mobile Country Code of the operator.

mnc
string
exemple530

The Mobile Network Code of the operator.

networkCode
string
exemple302530

The Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator.

networkName
string
exempleKeewaytinook Okimakanak

The company/organisational name of the operator.

Exemple Réponse

{
   "countryCode": "CA",
   "countryName": "Canada",
   "countryDisplayName": "Canada",
   "currency": "EUR",
   "defaultPrice": "0.00620000",
   "dialingPrefix": "1",
   "networks": [
      {
         "type": "mobile",
         "price": "0.00590000",
         "currency": "EUR",
         "mcc": "302",
         "mnc": "530",
         "networkCode": "302530",
         "networkName": "Keewaytinook Okimakanak"
      }
   ]
}

Retrieve outbound pricing for all countries.

Retrieves the pricing information for all countries.

gethttps://rest.nexmo.com/account/get-full-pricing/outbound/:type

Trajectoire Paramètres

type
string
Exigée

The type of service you wish to retrieve data about: either sms, sms-transit or voice.

Demande de renseignements Paramètres

api_key
string

Your Nexmo API key.

api_secret
string

Your Nexmo API secret.

Réponses
Type de contenu
application/json

Pricing response

count
string
exemple243

The number of countries retrieved.

countries
array

A list of countries.

countryName
string
exempleCanada

Readable country name.

countryDisplayName
string
exempleCanada

Readable country name.

currency
string
exempleEUR

The currency that your account is being billed in (by default Euros—EUR).

defaultPrice
string
exemple0.00620000

The default price.

dialingPrefix
string
exemple1

The dialling prefix.

networks
array

An array of network objects

type
string
exemplemobile

The type of network: mobile or landline.

price
string
exemple0.00590000

The cost to send a message or make a call to this network

currency
string
exempleEUR

The currency used for prices for this network.

mcc
string
exemple302

The Mobile Country Code of the operator.

mnc
string
exemple530

The Mobile Network Code of the operator.

networkCode
string
exemple302530

The Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator.

networkName
string
exempleKeewaytinook Okimakanak

The company/organisational name of the operator.

Exemple Réponse

{
   "count": "243",
   "countries": [
      {
         "countryName": "Canada",
         "countryDisplayName": "Canada",
         "currency": "EUR",
         "defaultPrice": "0.00620000",
         "dialingPrefix": "1",
         "networks": [
            {
               "type": "mobile",
               "price": "0.00590000",
               "currency": "EUR",
               "mcc": "302",
               "mnc": "530",
               "networkCode": "302530",
               "networkName": "Keewaytinook Okimakanak"
            }
         ]
      }
   ]
}

Retrieve outbound pricing for a specific dialing prefix.

Retrieves the pricing information based on the dialing prefix.

gethttps://rest.nexmo.com/account/get-prefix-pricing/outbound/:type

Trajectoire Paramètres

type
string
Exigée

The type of service you wish to retrieve data about: either sms, sms-transit or voice.

Demande de renseignements Paramètres

api_key
string

Your Nexmo API key.

api_secret
string

Your Nexmo API secret.

prefix
string

The numerical dialing prefix to look up pricing for. Examples include 44, 1 and so on.

Réponses
Type de contenu
application/json

Pricing countries response

count
string
exemple243

The number of countries retrieved.

countries
array

A list of countries.

countryName
string
exempleCanada

Readable country name.

countryDisplayName
string
exempleCanada

Readable country name.

currency
string
exempleEUR

The currency that your account is being billed in (by default Euros—EUR).

defaultPrice
string
exemple0.00620000

The default price.

dialingPrefix
string
exemple1

The dialling prefix.

networks
array

An array of network objects

type
string
exemplemobile

The type of network: mobile or landline.

price
string
exemple0.00590000

The cost to send a message or make a call to this network

currency
string
exempleEUR

The currency used for prices for this network.

mcc
string
exemple302

The Mobile Country Code of the operator.

mnc
string
exemple530

The Mobile Network Code of the operator.

networkCode
string
exemple302530

The Mobile Country Code and Mobile Network Code combined to give a unique reference for the operator.

networkName
string
exempleKeewaytinook Okimakanak

The company/organisational name of the operator.

Exemple Réponse

{
   "count": "243",
   "countries": [
      {
         "countryName": "Canada",
         "countryDisplayName": "Canada",
         "currency": "EUR",
         "defaultPrice": "0.00620000",
         "dialingPrefix": "1",
         "networks": [
            {
               "type": "mobile",
               "price": "0.00590000",
               "currency": "EUR",
               "mcc": "302",
               "mnc": "530",
               "networkCode": "302530",
               "networkName": "Keewaytinook Okimakanak"
            }
         ]
      }
   ]
}