Emergency Calling Provisioning API

The Emergency Calling Provisioning API lets you manage emergency calling configuration

Télécharger la spécification OpenAPI
Opérations disponibles

Get number emergency information

Get number emergency information

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

Authentification

CléDescriptionOù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

number
string
Exigée
exemple15500900000

Filter by number

Réponses
Type de contenu
application/json

OK

number
string
Exigée
exemple15500900000

An available inbound virtual number.

contact_name
string
exempleJohn Smith

Person of contact in case of emergency

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

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

Authentification

CléDescriptionOù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

number
string
Exigée
exemple15500900000

Update emergency address of number

Corps de la demande
Type de contenu
application/json

L'un des
address
object
Exigée
id
string
Exigée
exemplec49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

contact_name
string
exempleJohn Smith

Person of contact in case of emergency

Exemple Demande

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

Réponses
Type de contenu
application/json

OK

number
string
Exigée
exemple15500900000

An available inbound virtual number.

contact_name
string
exempleJohn Smith

Person of contact in case of emergency

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

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