Pricing API

Versão 2

The Pricing API enabled the retrieval of Vonage services 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 pricing.

Retrieves the pricing information for a certain product.

gethttps://api.nexmo.com/v2/account/pricing/:product

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

product
string
Obrigatório

The product for which you want to retrieve pricing information.

Deve ser uma das seguintes opções:sms-outboundvoice-outbound

Consulta Parâmetros

country
string

A two letter country code. For example, CA.

page
integer

The page number of the results to retrieve.

page_size
integer

The number of results to retrieve per page.

Respostas
Tipo de conteúdo
application/json

Pricing information for a specific product.

page_size
string
exemplo100

The number of results per page.

page
string
exemplo1

The page number of the results.

total_items
string
exemplo243

The total number of items.

total_pages
string
exemplo3

The total number of pages.

_embedded
object
countries
array

A list of countries.

country_name
string
exemploCanada

Country name.

dialing_prefix
string
exemplo1

The dialling prefix.

dest_network_type
string
exemploALL

The type of network.

group_internal_start
string
exemplo1s

TBD

rate_increment
string
exemplo60

The rate increment.

currency
string
exemploUSD

The currency that your account is being billed in.

price
string
exemplo0.1

The price.

_links
object
self
object
href
string
exemplohttps://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100

The URL to retrieve the current page.

first
object
href
string
exemplohttps://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100

The URL to retrieve the first page.

last
object
href
string
exemplohttps://api.nexmo.com/account/pricing/sms-outbound?page=3&page_size=100

The URL to retrieve the last page.

next
object
href
string
exemplohttps://api.nexmo.com/account/pricing/sms-outbound?page=2&page_size=100

The URL to retrieve the next page.

prev
object
href
string
exemplohttps://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100

The URL to retrieve the previous page.

Exemplo Resposta

{
   "page_size": "100",
   "page": "1",
   "total_items": "243",
   "total_pages": "3",
   "_embedded": {
      "countries": [
         {
            "country_name": "Canada",
            "dialing_prefix": "1",
            "dest_network_type": "ALL",
            "group_internal_start": "1s",
            "rate_increment": "60",
            "currency": "USD",
            "price": "0.1"
         }
      ]
   },
   "_links": {
      "self": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100"
      },
      "first": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100"
      },
      "last": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=3&page_size=100"
      },
      "next": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=2&page_size=100"
      },
      "prev": {
         "href": "https://api.nexmo.com/account/pricing/sms-outbound?page=1&page_size=100"
      }
   }
}