Pricing API

Versão 1

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

Baixar a especificação OpenAPI
Operações disponíveis

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Caminho Parâmetros

type
string
Obrigatório

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

Consulta Parâmetros

country
string

A two letter country code. For example, CA.

Respostas
Tipo de conteúdo
application/json

Pricing information for a specific country.

countryCode
string
exemploCA

Two letter country code.

countryName
string
exemploCanada

Readable country name.

countryDisplayName
string
exemploCanada

Readable country name.

currency
string
exemploEUR

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

defaultPrice
string
exemplo0.00620000

The default price.

dialingPrefix
string
exemplo1

The dialling prefix.

networks
array

An array of network objects

type
string
exemplomobile

The type of network: mobile or landline.

price
string
exemplo0.00590000

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

currency
string
exemploEUR

The currency used for prices for this network.

mcc
string
exemplo302

The Mobile Country Code of the operator.

mnc
string
exemplo530

The Mobile Network Code of the operator.

networkCode
string
exemplo302530

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

networkName
string
exemploKeewaytinook Okimakanak

The company/organisational name of the operator.

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Caminho Parâmetros

type
string
Obrigatório

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

Respostas
Tipo de conteúdo
application/json

Pricing response

count
string
exemplo243

The number of countries retrieved.

countries
array

A list of countries.

countryName
string
exemploCanada

Readable country name.

countryDisplayName
string
exemploCanada

Readable country name.

currency
string
exemploEUR

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

defaultPrice
string
exemplo0.00620000

The default price.

dialingPrefix
string
exemplo1

The dialling prefix.

networks
array

An array of network objects

type
string
exemplomobile

The type of network: mobile or landline.

price
string
exemplo0.00590000

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

currency
string
exemploEUR

The currency used for prices for this network.

mcc
string
exemplo302

The Mobile Country Code of the operator.

mnc
string
exemplo530

The Mobile Network Code of the operator.

networkCode
string
exemplo302530

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

networkName
string
exemploKeewaytinook Okimakanak

The company/organisational name of the operator.

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Caminho Parâmetros

type
string
Obrigatório

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

Consulta Parâmetros

prefix
string

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

Respostas
Tipo de conteúdo
application/json

Pricing countries response

count
string
exemplo243

The number of countries retrieved.

countries
array

A list of countries.

countryName
string
exemploCanada

Readable country name.

countryDisplayName
string
exemploCanada

Readable country name.

currency
string
exemploEUR

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

defaultPrice
string
exemplo0.00620000

The default price.

dialingPrefix
string
exemplo1

The dialling prefix.

networks
array

An array of network objects

type
string
exemplomobile

The type of network: mobile or landline.

price
string
exemplo0.00590000

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

currency
string
exemploEUR

The currency used for prices for this network.

mcc
string
exemplo302

The Mobile Country Code of the operator.

mnc
string
exemplo530

The Mobile Network Code of the operator.

networkCode
string
exemplo302530

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

networkName
string
exemploKeewaytinook Okimakanak

The company/organisational name of the operator.

Exemplo Resposta

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