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/

OpenAPI-Spezifikation herunterladen

Addresses

Create and modify Addresses in Vonage.

Verfügbare Operationen

Get details of your configured Addresses

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Abfrage Parameter

page

integer

Min1

Beispiel1

Page index

page_size

integer

Min1

Max1000

Standard100

Beispiel100

Number of records per page

Antworten
Inhalt Typ
application/json

page_size

Beispiel100

page

Beispiel3

total_pages

Beispiel15

total_items

Beispiel1450

_embedded

object

A list of Address objects.

addresses

array

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

Beispielmyaddress

A friendly name to identify the address

address_line1

string

Beispiel1 REGAL CT

First line of the full address

address_line2

string

BeispielMerchant's House 205

Second line of the full address

city

string

BeispielNew York

The city where this address is located

region

string

BeispielNJ

The state or region of the address

type

string

Beispielemergency

Type of address

Muss eines der folgenden sein:emergency

address_location_type

string

Standardbusiness

Beispielbusiness

Addrss location type as a business or domestic

Muss eines der folgenden sein:businessresidential

postal_code

string

Beispiel10002

The Postal Code of this address

country

string

Min2

Max2

BeispielUS

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

Beispiel Antwort

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Anfrage Körper
Inhalt Typ
application/json

Einer der

address_name

string

Min2

Max32

Beispielmyaddress

A friendly name to identify the address

address_line1

string

Beispiel1 REGAL CT

First line of the full address

address_line2

string

BeispielMerchant's House 205

Second line of the full address

city

string

BeispielNew York

The city where this address is located

region

string

BeispielNJ

The state or region of the address

type

string

Beispielemergency

Type of address

Muss eines der folgenden sein:emergency

address_location_type

string

Standardbusiness

Beispielbusiness

Addrss location type as a business or domestic

Muss eines der folgenden sein:businessresidential

postal_code

string

Beispiel10002

The Postal Code of this address

country

string

Min2

Max2

BeispielUS

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

Beispiel Anfrage

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

Antworten
Inhalt Typ
application/json

Created

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

Beispielmyaddress

A friendly name to identify the address

address_line1

string

Beispiel1 REGAL CT

First line of the full address

address_line2

string

BeispielMerchant's House 205

Second line of the full address

city

string

BeispielNew York

The city where this address is located

region

string

BeispielNJ

The state or region of the address

type

string

Beispielemergency

Type of address

Muss eines der folgenden sein:emergency

address_location_type

string

Standardbusiness

Beispielbusiness

Addrss location type as a business or domestic

Muss eines der folgenden sein:businessresidential

postal_code

string

Beispiel10002

The Postal Code of this address

country

string

Min2

Max2

BeispielUS

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

Beispiel Antwort

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

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

Filter by address id

Antworten
Inhalt Typ
application/json

string

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

Vonage Address unique ID

address_name

string

Min2

Max32

Beispielmyaddress

A friendly name to identify the address

address_line1

string

Beispiel1 REGAL CT

First line of the full address

address_line2

string

BeispielMerchant's House 205

Second line of the full address

city

string

BeispielNew York

The city where this address is located

region

string

BeispielNJ

The state or region of the address

type

string

Beispielemergency

Type of address

Muss eines der folgenden sein:emergency

address_location_type

string

Standardbusiness

Beispielbusiness

Addrss location type as a business or domestic

Muss eines der folgenden sein:businessresidential

postal_code

string

Beispiel10002

The Postal Code of this address

country

string

Min2

Max2

BeispielUS

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

Beispiel Antwort

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

Authentifizierung

Schlüssel	Beschreibung	Wo	Beispiel
Authorization	Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt. Mehr lesen	Headers	`Basic <base64>`

Pfad Parameter

string

Erforderlich

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

Filter by address id

Antworten

Deleted

Address API

Addresses

Verfügbare Operationen

Get details of your configured Addresses

Authentifizierung

Abfrage Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Create a new Address

Authentifizierung

Anfrage Körper Inhalt Typapplication/json

Beispiel Anfrage

Antworten Inhalt Typapplication/json

Beispiel Antwort

Get details of an Address

Authentifizierung

Pfad Parameter

Antworten Inhalt Typapplication/json

Beispiel Antwort

Delete an Address

Authentifizierung

Pfad Parameter

Antworten

Antworten
Inhalt Typ
application/json

Anfrage Körper
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json

Antworten
Inhalt Typ
application/json