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/

Télécharger la spécification OpenAPI

Addresses

Create and modify Addresses in Vonage.

Opérations disponibles

Get details of your configured Addresses

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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Demande de renseignements Paramètres

page

integer

Min1

exemple1

Page index

page_size

integer

Min1

Max1000

Défaut100

exemple100

Number of records per page

Réponses
Type de contenu
application/json

page_size

exemple100

page

exemple3

total_pages

exemple15

total_items

exemple1450

_embedded

object

A list of Address objects.

addresses

array

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

exemplemyaddress

A friendly name to identify the address

address_line1

string

exemple1 REGAL CT

First line of the full address

address_line2

string

exempleMerchant's House 205

Second line of the full address

city

string

exempleNew York

The city where this address is located

region

string

exempleNJ

The state or region of the address

type

string

exempleemergency

Type of address

Il doit s'agir de l'un d'entre eux :emergency

address_location_type

string

Défautbusiness

exemplebusiness

Addrss location type as a business or domestic

Il doit s'agir de l'un d'entre eux :businessresidential

postal_code

string

exemple10002

The Postal Code of this address

country

string

Min2

Max2

exempleUS

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

Exemple Réponse

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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Corps de la demande
Type de contenu
application/json

L'un des

address_name

string

Min2

Max32

exemplemyaddress

A friendly name to identify the address

address_line1

string

exemple1 REGAL CT

First line of the full address

address_line2

string

exempleMerchant's House 205

Second line of the full address

city

string

exempleNew York

The city where this address is located

region

string

exempleNJ

The state or region of the address

type

string

exempleemergency

Type of address

Il doit s'agir de l'un d'entre eux :emergency

address_location_type

string

Défautbusiness

exemplebusiness

Addrss location type as a business or domestic

Il doit s'agir de l'un d'entre eux :businessresidential

postal_code

string

exemple10002

The Postal Code of this address

country

string

Min2

Max2

exempleUS

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

Exemple Demande

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

Réponses
Type de contenu
application/json

Created

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

exemplemyaddress

A friendly name to identify the address

address_line1

string

exemple1 REGAL CT

First line of the full address

address_line2

string

exempleMerchant's House 205

Second line of the full address

city

string

exempleNew York

The city where this address is located

region

string

exempleNJ

The state or region of the address

type

string

exempleemergency

Type of address

Il doit s'agir de l'un d'entre eux :emergency

address_location_type

string

Défautbusiness

exemplebusiness

Addrss location type as a business or domestic

Il doit s'agir de l'un d'entre eux :businessresidential

postal_code

string

exemple10002

The Postal Code of this address

country

string

Min2

Max2

exempleUS

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

Exemple Réponse

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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

string

Exigée

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

Filter by address id

Réponses
Type de contenu
application/json

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

exemplemyaddress

A friendly name to identify the address

address_line1

string

exemple1 REGAL CT

First line of the full address

address_line2

string

exempleMerchant's House 205

Second line of the full address

city

string

exempleNew York

The city where this address is located

region

string

exempleNJ

The state or region of the address

type

string

exempleemergency

Type of address

Il doit s'agir de l'un d'entre eux :emergency

address_location_type

string

Défautbusiness

exemplebusiness

Addrss location type as a business or domestic

Il doit s'agir de l'un d'entre eux :businessresidential

postal_code

string

exemple10002

The Postal Code of this address

country

string

Min2

Max2

exempleUS

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

Exemple Réponse

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

Authentification

Clé	Description	Où	Exemple
Authorization	Clé et secret de l'API encodés en Base64 et reliés par deux points. En savoir plus	Headers	`Basic <base64>`

Trajectoire Paramètres

string

Exigée

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

Filter by address id

Réponses

Deleted

Address API

Addresses

Opérations disponibles

Get details of your configured Addresses

Authentification

Demande de renseignements Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Create a new Address

Authentification

Corps de la demande Type de contenuapplication/json

Exemple Demande

Réponses Type de contenuapplication/json

Exemple Réponse

Get details of an Address

Authentification

Trajectoire Paramètres

Réponses Type de contenuapplication/json

Exemple Réponse

Delete an Address

Authentification

Trajectoire Paramètres

Réponses

Réponses
Type de contenu
application/json

Corps de la demande
Type de contenu
application/json

Réponses
Type de contenu
application/json

Réponses
Type de contenu
application/json