Address API

The Address API lets you create and modify Addresses in Vonage. These addresses may be linked to numbers

More details at https://developer.vonage.com/

Baixar a especificação OpenAPI

Addresses

Create and modify Addresses in Vonage.

Operações disponíveis

Get details of your configured Addresses

gethttps://api.nexmo.com/v1/addresses/

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Consulta Parâmetros

page

integer

Mín.1

exemplo1

Page index

page_size

integer

Mín.1

Max1000

Padrão100

exemplo100

Number of records per page

Respostas
Tipo de conteúdo
application/json

page_size

exemplo100

page

exemplo3

total_pages

exemplo15

total_items

exemplo1450

_embedded

object

A list of Address objects.

addresses

array

string

exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

address_name

string

Mín.2

Max32

exemplomyaddress

A friendly name to identify the address

address_line1

string

exemplo1 REGAL CT

First line of the full address

address_line2

string

exemploMerchant's House 205

Second line of the full address

city

string

exemploNew York

The city where this address is located

region

string

exemploNJ

The state or region of the address

type

string

exemploemergency

Type of address

Deve ser uma das seguintes opções:emergency

address_location_type

string

Padrãobusiness

exemplobusiness

Addrss location type as a business or domestic

Deve ser uma das seguintes opções:businessresidential

postal_code

string

exemplo10002

The Postal Code of this address

country

string

Mín.2

Max2

exemploUS

The two character country code in ISO 3166-1 alpha-2 format

Exemplo Resposta

{
   "page_size": 100,
   "page": 3,
   "total_pages": 15,
   "total_items": 1450,
   "_embedded": {
      "addresses": [
         {
            "id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
            "address_name": "myaddress",
            "address_line1": "1 REGAL CT",
            "address_line2": "Merchant's House 205",
            "city": "New York",
            "region": "NJ",
            "type": "emergency",
            "address_location_type": "business",
            "postal_code": "10002",
            "country": "US"
         }
      ]
   }
}

Create a new Address

posthttps://api.nexmo.com/v1/addresses/

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos

address_name

string

Mín.2

Max32

exemplomyaddress

A friendly name to identify the address

address_line1

string

exemplo1 REGAL CT

First line of the full address

address_line2

string

exemploMerchant's House 205

Second line of the full address

city

string

exemploNew York

The city where this address is located

region

string

exemploNJ

The state or region of the address

type

string

exemploemergency

Type of address

Deve ser uma das seguintes opções:emergency

address_location_type

string

Padrãobusiness

exemplobusiness

Addrss location type as a business or domestic

Deve ser uma das seguintes opções:businessresidential

postal_code

string

exemplo10002

The Postal Code of this address

country

string

Mín.2

Max2

exemploUS

The two character country code in ISO 3166-1 alpha-2 format

Exemplo Solicitação

{
   "address_name": "myaddress",
   "address_line1": "1 REGAL CT",
   "address_line2": "Merchant's House 205",
   "city": "New York",
   "region": "NJ",
   "type": "emergency",
   "address_location_type": "business",
   "postal_code": "10002",
   "country": "US"
}

Respostas
Tipo de conteúdo
application/json

Created

string

exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

address_name

string

Mín.2

Max32

exemplomyaddress

A friendly name to identify the address

address_line1

string

exemplo1 REGAL CT

First line of the full address

address_line2

string

exemploMerchant's House 205

Second line of the full address

city

string

exemploNew York

The city where this address is located

region

string

exemploNJ

The state or region of the address

type

string

exemploemergency

Type of address

Deve ser uma das seguintes opções:emergency

address_location_type

string

Padrãobusiness

exemplobusiness

Addrss location type as a business or domestic

Deve ser uma das seguintes opções:businessresidential

postal_code

string

exemplo10002

The Postal Code of this address

country

string

Mín.2

Max2

exemploUS

The two character country code in ISO 3166-1 alpha-2 format

Exemplo Resposta

{
   "id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "address_name": "myaddress",
   "address_line1": "1 REGAL CT",
   "address_line2": "Merchant's House 205",
   "city": "New York",
   "region": "NJ",
   "type": "emergency",
   "address_location_type": "business",
   "postal_code": "10002",
   "country": "US"
}

Get details of an Address

gethttps://api.nexmo.com/v1/addresses/:id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Filter by address id

Respostas
Tipo de conteúdo
application/json

string

exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

address_name

string

Mín.2

Max32

exemplomyaddress

A friendly name to identify the address

address_line1

string

exemplo1 REGAL CT

First line of the full address

address_line2

string

exemploMerchant's House 205

Second line of the full address

city

string

exemploNew York

The city where this address is located

region

string

exemploNJ

The state or region of the address

type

string

exemploemergency

Type of address

Deve ser uma das seguintes opções:emergency

address_location_type

string

Padrãobusiness

exemplobusiness

Addrss location type as a business or domestic

Deve ser uma das seguintes opções:businessresidential

postal_code

string

exemplo10002

The Postal Code of this address

country

string

Mín.2

Max2

exemploUS

The two character country code in ISO 3166-1 alpha-2 format

Exemplo Resposta

{
   "id": "c49f3586-9b3b-458b-89fc-3c8beb58865c",
   "address_name": "myaddress",
   "address_line1": "1 REGAL CT",
   "address_line2": "Merchant's House 205",
   "city": "New York",
   "region": "NJ",
   "type": "emergency",
   "address_location_type": "business",
   "postal_code": "10002",
   "country": "US"
}

Delete an Address

deletehttps://api.nexmo.com/v1/addresses/:id

Autenticação

Chave	Descrição	Onde	Exemplo
Authorization	Chave e segredo da API codificados em Base64, separados por dois pontos. Leia mais	Headers	`Basic <base64>`

Caminho Parâmetros

string

Obrigatório

exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Filter by address id

Respostas

Deleted

Address API

Addresses

Operações disponíveis

Get details of your configured Addresses

Autenticação

Consulta Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Create a new Address

Autenticação

Corpo da solicitação Tipo de conteúdoapplication/json

Exemplo Solicitação

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Get details of an Address

Autenticação

Caminho Parâmetros

Respostas Tipo de conteúdoapplication/json

Exemplo Resposta

Delete an Address

Autenticação

Caminho Parâmetros

Respostas

Respostas
Tipo de conteúdo
application/json

Corpo da solicitação
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json

Respostas
Tipo de conteúdo
application/json