API docs by Redocly

e911 API (v2.1.6)

Download OpenAPI specification:Download

E-mail: support@voicetel.com License: Apache 2.0

e911 emergency services provisioning

e911

e911 emergency address provisioning.

Provision e911 Address

Provisions an e911 address to a telephone number using a pre-validated addressid. The dn must be a number owned by the account.

Authorizations:
apikey
Request Body schema: application/json
required

Body for provision e911 address.

apikey
required
string
addressid
required
integer

Address ID from a prior validateAddress call.

dn
required
string
callername
required
string

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "addressid": 123456,
  • "dn": "2015551234",
  • "callername": "JOHN DOE"
}

Response samples

Content type
application/json
{
  • "entry_added": {
    },
  • "statusCode": "200",
  • "status": "Success"
}

Query All e911 Records

Returns all e911 records provisioned for telephone numbers on the account.

Authorizations:
apikey
Request Body schema: application/json
required

Body for query all e911 records.

apikey
required
string

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key"
}

Response samples

Content type
application/json
{
  • "entry_all": [ ],
  • "statusCode": "200",
  • "status": "Success"
}

Query e911 Record

Returns the e911 record provisioned for a specific telephone number on the account.

Authorizations:
apikey
Request Body schema: application/json
required

Body for query e911 record.

apikey
required
string
dn
required
string

10-digit telephone number in NPANXXXXXX format.

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "dn": "2015551234"
}

Response samples

Content type
application/json
{
  • "entry_query": {
    },
  • "statusCode": "200",
  • "status": "Success"
}

Remove e911 Record

Removes the e911 record provisioned for a specific telephone number on the account.

Authorizations:
apikey
Request Body schema: application/json
required

Body for remove e911 record.

apikey
required
string
dn
required
string

10-digit telephone number in NPANXXXXXX format.

Responses

Request samples

Content type
application/json
{
  • "apikey": "Your API Key",
  • "dn": "2015551234"
}

Response samples

Content type
application/json
{
  • "entry_removed": {
    },
  • "statusCode": "200",
  • "status": "Success"
}

Validate e911 Address

Validates a street address for e911 provisioning. Returns a validated address entry including an addressid for use with provisionAddress.

Authorizations:
apikey
Request Body schema: application/json
required

Body for validate e911 address.

city
required
string
address2
string
zip
required
string
state
required
string
apikey
required
string
address1
required
string

Responses

Request samples

Content type
application/json
{
  • "city": "HACKENSACK",
  • "address2": "STE 200",
  • "zip": "07601",
  • "state": "NJ",
  • "apikey": "Your API Key",
  • "address1": "411 HACKENSACK AVENUE"
}

Response samples

Content type
application/json
{
  • "entry_valid": {
    },
  • "statusCode": "200",
  • "status": "Success"
}

Validate and Provision e911 Address

Combines validateAddress and provisionAddress in a single call. The dn must be a number owned by the account.

Authorizations:
apikey
Request Body schema: application/json
required

Body for validate and provision e911 address.

city
required
string
address2
string
dn
required
string
zip
required
string
state
required
string
callername
required
string
apikey
required
string
address1
required
string

Responses

Request samples

Content type
application/json
{
  • "city": "HACKENSACK",
  • "address2": "STE 200",
  • "dn": "2015551234",
  • "zip": "07601",
  • "state": "NJ",
  • "callername": "JOHN DOE",
  • "apikey": "Your API Key",
  • "address1": "411 HACKENSACK AVENUE"
}

Response samples

Content type
application/json
{
  • "entry_added": {
    },
  • "statusCode": "200",
  • "status": "Success"
}