Emergency Calling Provisioning API

The Emergency Calling Provisioning API lets you manage emergency calling configuration

OpenAPI-Spezifikation herunterladen
Verfügbare Operationen

Get number emergency information

Get number emergency information

gethttps://api.nexmo.com/v1/emergency/numbers/:number

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Pfad Parameter

number
string
Erforderlich
Beispiel15500900000

Filter by number

Antworten
Inhalt Typ
application/json

OK

number
string
Erforderlich
Beispiel15500900000

An available inbound virtual number.

contact_name
string
BeispielJohn Smith

Person of contact in case of emergency

address
object
id
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

{
   "number": "15500900000",
   "contact_name": "John Smith",
   "address": {
      "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"
   }
}

Assign emergency address to number.

Assign emergency address to number. Use empty string as id to disassociate

patchhttps://api.nexmo.com/v1/emergency/numbers/:number

Authentifizierung

SchlüsselBeschreibungWoBeispiel
Authorization

Base64-kodierter API-Schlüssel und Geheimnis, verbunden durch einen Doppelpunkt.
Mehr lesen

Headers

Basic <base64>

Pfad Parameter

number
string
Erforderlich
Beispiel15500900000

Update emergency address of number

Anfrage Körper
Inhalt Typ
application/json

Einer der
address
object
Erforderlich
id
string
Erforderlich
Beispielc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

contact_name
string
BeispielJohn Smith

Person of contact in case of emergency

Beispiel Anfrage

{
   "address": {
      "id": "c49f3586-9b3b-458b-89fc-3c8beb58865c"
   },
   "contact_name": "John Smith"
}

Antworten
Inhalt Typ
application/json

OK

number
string
Erforderlich
Beispiel15500900000

An available inbound virtual number.

contact_name
string
BeispielJohn Smith

Person of contact in case of emergency

address
object
id
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

{
   "number": "15500900000",
   "contact_name": "John Smith",
   "address": {
      "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"
   }
}