Dynamic Emergency Addresses API

Dynamic emergency address operations

List dynamic emergency addresses

Returns the dynamic emergency addresses according to filters

SecuritybearerAuth
Request
query Parameters
filter[status]
string

Filter by status.

Enum: "pending" "activated" "rejected"
filter[country_code]
string

Filter by country code.

page[number]
integer >= 1
Default: 1

The page number to load

page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

Responses
200

Dynamic Emergency Address Responses

Response Schema: application/json
Array of objects (DynamicEmergencyAddress)
object (Metadata)
401

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

get/dynamic_emergency_addresses
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.DynamicEmergencyAddress.list(filter={"status":"pending","country_code":"string"})
Response samples
application/json
{
  • "data": [
    • {
      • "administrative_area": "IL",
      • "country_code": "US",
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "extended_address": "string",
      • "house_number": 311,
      • "house_suffix": "string",
      • "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f1",
      • "locality": "Chicago",
      • "postal_code": "60654",
      • "record_type": "dynamic_emergency_address",
      • "sip_geolocation_id": "XYZ123",
      • "status": "pending",
      • "street_name": "Superior",
      • "street_post_directional": "string",
      • "street_pre_directional": "W",
      • "street_suffix": "string",
      • "updated_at": "2018-02-02T22:25:27.521Z"
      }
    ],
  • "meta": {
    • "page_number": 3,
    • "page_size": 1,
    • "total_pages": 13,
    • "total_results": 13
    }
}

Create a dynamic emergency address.

Creates a dynamic emergency address.

SecuritybearerAuth
Request
Request Body schema: application/json
required
administrative_area
required
string
country_code
string
Enum: "US" "CA" "PR"
extended_address
string
house_number
required
string
house_suffix
string
locality
required
string
postal_code
required
string
street_name
required
string
street_post_directional
string
street_pre_directional
string
street_suffix
string
Responses
201

Dynamic Emergency Address Response

Response Schema: application/json
object (DynamicEmergencyAddress)
administrative_area
required
string
country_code
string
Enum: "US" "CA" "PR"
created_at
string

ISO 8601 formatted date of when the resource was created

extended_address
string
house_number
required
string
house_suffix
string
id
string
locality
required
string
postal_code
required
string
record_type
string

Identifies the type of the resource.

sip_geolocation_id
string

Unique location reference string to be used in SIP INVITE from / p-asserted headers.

status
string

Status of dynamic emergency address

Enum: "pending" "activated" "rejected"
street_name
required
string
street_post_directional
string
street_pre_directional
string
street_suffix
string
updated_at
string

ISO 8601 formatted date of when the resource was last updated

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

post/dynamic_emergency_addresses
Request samples
application/json
{
  • "administrative_area": "IL",
  • "country_code": "US",
  • "extended_address": "string",
  • "house_number": 311,
  • "house_suffix": "string",
  • "locality": "Chicago",
  • "postal_code": "60654",
  • "street_name": "Superior",
  • "street_post_directional": "string",
  • "street_pre_directional": "W",
  • "street_suffix": "string"
}
Response samples
application/json
{
  • "data": {
    • "administrative_area": "IL",
    • "country_code": "US",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "extended_address": "string",
    • "house_number": 311,
    • "house_suffix": "string",
    • "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f1",
    • "locality": "Chicago",
    • "postal_code": "60654",
    • "record_type": "dynamic_emergency_address",
    • "sip_geolocation_id": "XYZ123",
    • "status": "pending",
    • "street_name": "Superior",
    • "street_post_directional": "string",
    • "street_pre_directional": "W",
    • "street_suffix": "string",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Delete a dynamic emergency address

Deletes the dynamic emergency address based on the ID provided

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Dynamic Emergency Address id

Responses
200

Dynamic Emergency Address Response

Response Schema: application/json
object (DynamicEmergencyAddress)
administrative_area
required
string
country_code
string
Enum: "US" "CA" "PR"
created_at
string

ISO 8601 formatted date of when the resource was created

extended_address
string
house_number
required
string
house_suffix
string
id
string
locality
required
string
postal_code
required
string
record_type
string

Identifies the type of the resource.

sip_geolocation_id
string

Unique location reference string to be used in SIP INVITE from / p-asserted headers.

status
string

Status of dynamic emergency address

Enum: "pending" "activated" "rejected"
street_name
required
string
street_post_directional
string
street_pre_directional
string
street_suffix
string
updated_at
string

ISO 8601 formatted date of when the resource was last updated

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

delete/dynamic_emergency_addresses/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.DynamicEmergencyAddress.retrieve('id')
res.delete()
Response samples
application/json
{
  • "data": {
    • "administrative_area": "IL",
    • "country_code": "US",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "extended_address": "string",
    • "house_number": 311,
    • "house_suffix": "string",
    • "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f1",
    • "locality": "Chicago",
    • "postal_code": "60654",
    • "record_type": "dynamic_emergency_address",
    • "sip_geolocation_id": "XYZ123",
    • "status": "pending",
    • "street_name": "Superior",
    • "street_post_directional": "string",
    • "street_pre_directional": "W",
    • "street_suffix": "string",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Get a dynamic emergency address

Returns the dynamic emergency address based on the ID provided

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Dynamic Emergency Address id

Responses
200

Dynamic Emergency Address Response

Response Schema: application/json
object (DynamicEmergencyAddress)
administrative_area
required
string
country_code
string
Enum: "US" "CA" "PR"
created_at
string

ISO 8601 formatted date of when the resource was created

extended_address
string
house_number
required
string
house_suffix
string
id
string
locality
required
string
postal_code
required
string
record_type
string

Identifies the type of the resource.

sip_geolocation_id
string

Unique location reference string to be used in SIP INVITE from / p-asserted headers.

status
string

Status of dynamic emergency address

Enum: "pending" "activated" "rejected"
street_name
required
string
street_post_directional
string
street_pre_directional
string
street_suffix
string
updated_at
string

ISO 8601 formatted date of when the resource was last updated

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

get/dynamic_emergency_addresses/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.DynamicEmergencyAddress.retrieve("id")
Response samples
application/json
{
  • "data": {
    • "administrative_area": "IL",
    • "country_code": "US",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "extended_address": "string",
    • "house_number": 311,
    • "house_suffix": "string",
    • "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f1",
    • "locality": "Chicago",
    • "postal_code": "60654",
    • "record_type": "dynamic_emergency_address",
    • "sip_geolocation_id": "XYZ123",
    • "status": "pending",
    • "street_name": "Superior",
    • "street_post_directional": "string",
    • "street_pre_directional": "W",
    • "street_suffix": "string",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}