Emergency Calling Provisioning API

The Emergency Calling Provisioning API lets you manage emergency calling configuration

Descargar la especificación OpenAPI
Operaciones disponibles

Get number emergency information

Get number emergency information

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Ruta Parámetros

number
string
Requerido
ejemplo15500900000

Filter by number

Respuestas
Tipo de contenido
application/json

OK

number
string
Requerido
ejemplo15500900000

An available inbound virtual number.

contact_name
string
ejemploJohn Smith

Person of contact in case of emergency

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

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

Autenticación

ClaveDescripciónDóndeEjemplo
Authorization

Clave API codificada en Base64 y secreto unidos por dos puntos.
Seguir leyendo

Headers

Basic <base64>

Ruta Parámetros

number
string
Requerido
ejemplo15500900000

Update emergency address of number

Cuerpo de la solicitud
Tipo de contenido
application/json

Uno de
address
object
Requerido
id
string
Requerido
ejemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

contact_name
string
ejemploJohn Smith

Person of contact in case of emergency

Ejemplo Solicitar

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

Respuestas
Tipo de contenido
application/json

OK

number
string
Requerido
ejemplo15500900000

An available inbound virtual number.

contact_name
string
ejemploJohn Smith

Person of contact in case of emergency

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

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