Open SidemenuAPI Reference
API Reference
Close Sidemenu

Dynamic Emergency Addresses

List dynamic emergency addresseslistDyanmicEmergencyAddresses

get https://api.telnyx.com/v2/dynamic_emergency_addresses

Returns the dynamic emergency addresses according to filters

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/dynamic_emergency_addresses?filter[status]=&filter[country_code]="
Parameters
In query
filter[status]
string
optional

Filter by status.

Options: [ "pending", "activated", "rejected" ]
filter[country_code]
string
optional

Filter by country code.

page[number]
integer (1)
optional

The page number to load

Default: 1
page[size]
integer (1 - 250)
optional

The size of the page

Default: 20
Responses
200

Dynamic Emergency Address Responses

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "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.createDyanmicEmergencyAddress

post https://api.telnyx.com/v2/dynamic_emergency_addresses

Creates a dynamic emergency address.

curl -X POST \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --data '{"administrative_area":"IL","house_number":311}' \
  https://api.telnyx.com/v2/dynamic_emergency_addresses
Parameters
In body (application/json)
administrative_area
string
required
Example: "IL"
house_number
string
required
Example: 311
locality
string
required
Example: "Chicago"
postal_code
string
required
Example: "60654"
street_name
string
required
Example: "Superior"
country_code
string
optional
Example: "US"
Options: [ "US", "CA", "PR" ]
extended_address
string
optional
house_suffix
string
optional
street_post_directional
string
optional
street_pre_directional
string
optional
Example: "W"
street_suffix
string
optional
Responses
201

Dynamic Emergency Address Response

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "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 addressgetDynamicEmergencyAddress

get https://api.telnyx.com/v2/dynamic_emergency_addresses/{id}

Returns the dynamic emergency address based on the ID provided

curl -X GET \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  --globoff "https://api.telnyx.com/v2/dynamic_emergency_addresses/{id}"
Parameters
In path
id
string (uuid)
required

Dynamic Emergency Address id

Responses
200

Dynamic Emergency Address Response

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

Success Response
{
  "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 addressdeleteDynamicEmergencyAddress

delete https://api.telnyx.com/v2/dynamic_emergency_addresses/{id}

Deletes the dynamic emergency address based on the ID provided

curl -X DELETE \
  --header "Content-Type: application/json" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer YOUR_API_KEY" \
  "https://api.telnyx.com/v2/dynamic_emergency_addresses/{id}"
Parameters
In path
id
string (uuid)
required

Dynamic Emergency Address id

Responses
200

Dynamic Emergency Address Response

401

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

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

Was this section helpful?