Pricing API

Version 1

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

OpenAPI-Spezifikation herunterladen
Verfügbare Operationen

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

Pfad Parameter

type
string
Erforderlich

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

Abfrage Parameter

api_key
string

Your Nexmo API key.

api_secret
string

Your Nexmo API secret.

country
string

A two letter country code. For example, CA.

Antworten
Inhalt Typ
application/json

Pricing information for a specific country.

countryCode
string
BeispielCA

Two letter country code.

countryName
string
BeispielCanada

Readable country name.

countryDisplayName
string
BeispielCanada

Readable country name.

currency
string
BeispielEUR

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

defaultPrice
string
Beispiel0.00620000

The default price.

dialingPrefix
string
Beispiel1

The dialling prefix.

networks
array

An array of network objects

type
string
Beispielmobile

The type of network: mobile or landline.

price
string
Beispiel0.00590000

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

currency
string
BeispielEUR

The currency used for prices for this network.

mcc
string
Beispiel302

The Mobile Country Code of the operator.

mnc
string
Beispiel530

The Mobile Network Code of the operator.

networkCode
string
Beispiel302530

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

networkName
string
BeispielKeewaytinook Okimakanak

The company/organisational name of the operator.

Beispiel Antwort

{
   "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

Pfad Parameter

type
string
Erforderlich

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

Abfrage Parameter

api_key
string

Your Nexmo API key.

api_secret
string

Your Nexmo API secret.

Antworten
Inhalt Typ
application/json

Pricing response

count
string
Beispiel243

The number of countries retrieved.

countries
array

A list of countries.

countryName
string
BeispielCanada

Readable country name.

countryDisplayName
string
BeispielCanada

Readable country name.

currency
string
BeispielEUR

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

defaultPrice
string
Beispiel0.00620000

The default price.

dialingPrefix
string
Beispiel1

The dialling prefix.

networks
array

An array of network objects

type
string
Beispielmobile

The type of network: mobile or landline.

price
string
Beispiel0.00590000

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

currency
string
BeispielEUR

The currency used for prices for this network.

mcc
string
Beispiel302

The Mobile Country Code of the operator.

mnc
string
Beispiel530

The Mobile Network Code of the operator.

networkCode
string
Beispiel302530

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

networkName
string
BeispielKeewaytinook Okimakanak

The company/organisational name of the operator.

Beispiel Antwort

{
   "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

Pfad Parameter

type
string
Erforderlich

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

Abfrage Parameter

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.

Antworten
Inhalt Typ
application/json

Pricing countries response

count
string
Beispiel243

The number of countries retrieved.

countries
array

A list of countries.

countryName
string
BeispielCanada

Readable country name.

countryDisplayName
string
BeispielCanada

Readable country name.

currency
string
BeispielEUR

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

defaultPrice
string
Beispiel0.00620000

The default price.

dialingPrefix
string
Beispiel1

The dialling prefix.

networks
array

An array of network objects

type
string
Beispielmobile

The type of network: mobile or landline.

price
string
Beispiel0.00590000

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

currency
string
BeispielEUR

The currency used for prices for this network.

mcc
string
Beispiel302

The Mobile Country Code of the operator.

mnc
string
Beispiel530

The Mobile Network Code of the operator.

networkCode
string
Beispiel302530

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

networkName
string
BeispielKeewaytinook Okimakanak

The company/organisational name of the operator.

Beispiel Antwort

{
   "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"
            }
         ]
      }
   ]
}