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/

Descargar la especificación OpenAPI

Addresses

Create and modify Addresses in Vonage.

Operaciones disponibles

Get details of your configured Addresses

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Consulta Parámetros

page

integer

Min1

ejemplo1

Page index

page_size

integer

Min1

Max1000

Por defecto100

ejemplo100

Number of records per page

Respuestas
Tipo de contenido
application/json

page_size

ejemplo100

page

ejemplo3

total_pages

ejemplo15

total_items

ejemplo1450

_embedded

object

A list of Address objects.

addresses

array

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

ejemplomyaddress

A friendly name to identify the address

address_line1

string

ejemplo1 REGAL CT

First line of the full address

address_line2

string

ejemploMerchant's House 205

Second line of the full address

city

string

ejemploNew York

The city where this address is located

region

string

ejemploNJ

The state or region of the address

type

string

ejemploemergency

Type of address

Debe ser uno de:emergency

address_location_type

string

Por defectobusiness

ejemplobusiness

Addrss location type as a business or domestic

Debe ser uno de:businessresidential

postal_code

string

ejemplo10002

The Postal Code of this address

country

string

Min2

Max2

ejemploUS

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

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de

address_name

string

Min2

Max32

ejemplomyaddress

A friendly name to identify the address

address_line1

string

ejemplo1 REGAL CT

First line of the full address

address_line2

string

ejemploMerchant's House 205

Second line of the full address

city

string

ejemploNew York

The city where this address is located

region

string

ejemploNJ

The state or region of the address

type

string

ejemploemergency

Type of address

Debe ser uno de:emergency

address_location_type

string

Por defectobusiness

ejemplobusiness

Addrss location type as a business or domestic

Debe ser uno de:businessresidential

postal_code

string

ejemplo10002

The Postal Code of this address

country

string

Min2

Max2

ejemploUS

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

Ejemplo Solicitar

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

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

Respuestas
Tipo de contenido
application/json

Created

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

ejemplomyaddress

A friendly name to identify the address

address_line1

string

ejemplo1 REGAL CT

First line of the full address

address_line2

string

ejemploMerchant's House 205

Second line of the full address

city

string

ejemploNew York

The city where this address is located

region

string

ejemploNJ

The state or region of the address

type

string

ejemploemergency

Type of address

Debe ser uno de:emergency

address_location_type

string

Por defectobusiness

ejemplobusiness

Addrss location type as a business or domestic

Debe ser uno de:businessresidential

postal_code

string

ejemplo10002

The Postal Code of this address

country

string

Min2

Max2

ejemploUS

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

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

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

Filter by address id

Respuestas
Tipo de contenido
application/json

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

ejemplomyaddress

A friendly name to identify the address

address_line1

string

ejemplo1 REGAL CT

First line of the full address

address_line2

string

ejemploMerchant's House 205

Second line of the full address

city

string

ejemploNew York

The city where this address is located

region

string

ejemploNJ

The state or region of the address

type

string

ejemploemergency

Type of address

Debe ser uno de:emergency

address_location_type

string

Por defectobusiness

ejemplobusiness

Addrss location type as a business or domestic

Debe ser uno de:businessresidential

postal_code

string

ejemplo10002

The Postal Code of this address

country

string

Min2

Max2

ejemploUS

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

Ejemplo Respuesta

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

Autenticación

Clave	Descripción	Dónde	Ejemplo
Authorization	Clave API codificada en Base64 y secreto unidos por dos puntos. Seguir leyendo	Headers	`Basic <base64>`

Ruta Parámetros

string

Requerido

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

Filter by address id

Respuestas

Deleted

Address API

Addresses

Operaciones disponibles

Get details of your configured Addresses

Autenticación

Consulta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Create a new Address

Autenticación

Cuerpo de la solicitud Tipo de contenidoapplication/json

Ejemplo Solicitar

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Get details of an Address

Autenticación

Ruta Parámetros

Respuestas Tipo de contenidoapplication/json

Ejemplo Respuesta

Delete an Address

Autenticación

Ruta Parámetros

Respuestas

Respuestas
Tipo de contenido
application/json

Cuerpo de la solicitud
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json

Respuestas
Tipo de contenido
application/json