Emergency Calling Provisioning API

The Emergency Calling Provisioning API lets you manage emergency calling configuration

Baixar a especificação OpenAPI
Operações disponíveis

Get number emergency information

Get number emergency information

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Caminho Parâmetros

number
string
Obrigatório
exemplo15500900000

Filter by number

Respostas
Tipo de conteúdo
application/json

OK

number
string
Obrigatório
exemplo15500900000

An available inbound virtual number.

contact_name
string
exemploJohn Smith

Person of contact in case of emergency

address
object
id
string
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

address_name
string
Mín.2
Max32
exemplomyaddress

A friendly name to identify the address

address_line1
string
exemplo1 REGAL CT

First line of the full address

address_line2
string
exemploMerchant's House 205

Second line of the full address

city
string
exemploNew York

The city where this address is located

region
string
exemploNJ

The state or region of the address

type
string
exemploemergency

Type of address

Deve ser uma das seguintes opções:emergency
address_location_type
string
Padrãobusiness
exemplobusiness

Addrss location type as a business or domestic

Deve ser uma das seguintes opções:businessresidential
postal_code
string
exemplo10002

The Postal Code of this address

country
string
Mín.2
Max2
exemploUS

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

Exemplo Resposta

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

Autenticação

ChaveDescriçãoOndeExemplo
Authorization

Chave e segredo da API codificados em Base64, separados por dois pontos.
Leia mais

Headers

Basic <base64>

Caminho Parâmetros

number
string
Obrigatório
exemplo15500900000

Update emergency address of number

Corpo da solicitação
Tipo de conteúdo
application/json

Um dos
address
object
Obrigatório
id
string
Obrigatório
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

contact_name
string
exemploJohn Smith

Person of contact in case of emergency

Exemplo Solicitação

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

Respostas
Tipo de conteúdo
application/json

OK

number
string
Obrigatório
exemplo15500900000

An available inbound virtual number.

contact_name
string
exemploJohn Smith

Person of contact in case of emergency

address
object
id
string
exemploc49f3586-9b3b-458b-89fc-3c8beb58865c

Vonage Address unique ID

address_name
string
Mín.2
Max32
exemplomyaddress

A friendly name to identify the address

address_line1
string
exemplo1 REGAL CT

First line of the full address

address_line2
string
exemploMerchant's House 205

Second line of the full address

city
string
exemploNew York

The city where this address is located

region
string
exemploNJ

The state or region of the address

type
string
exemploemergency

Type of address

Deve ser uma das seguintes opções:emergency
address_location_type
string
Padrãobusiness
exemplobusiness

Addrss location type as a business or domestic

Deve ser uma das seguintes opções:businessresidential
postal_code
string
exemplo10002

The Postal Code of this address

country
string
Mín.2
Max2
exemploUS

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

Exemplo Resposta

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