Dynamic Emergency Endpoints API

Dynamic Emergency Endpoints

List dynamic emergency endpoints

Returns the dynamic emergency endpoints 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 Endpoints Responses

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

Unauthorized

404

Resource not found

422

Unprocessable entity. Check message field in response for details.

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

telnyx.DynamicEmergencyEndpoint.list(filter={"status":"pending","country_code":"string"})
Response samples
application/json
{
  • "data": [
    • {
      • "callback_number": "+13125550000",
      • "caller_name": "Jane Doe Desk Phone",
      • "created_at": "2018-02-02T22:25:27.521Z",
      • "dynamic_emergency_address_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      • "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
      • "record_type": "dynamic_emergency_endpoint",
      • "sip_from_id": "FXDFWEDF",
      • "status": "pending",
      • "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 endpoint.

Creates a dynamic emergency endpoints.

SecuritybearerAuth
Request
Request Body schema: application/json
required
callback_number
required
string
caller_name
required
string
dynamic_emergency_address_id
required
string

An id of a currently active dynamic emergency location.

Responses
201

Dynamic Emergency Endpoint Response

Response Schema: application/json
object (DynamicEmergencyEndpoint)
callback_number
required
string
caller_name
required
string
created_at
string

ISO 8601 formatted date of when the resource was created

dynamic_emergency_address_id
required
string

An id of a currently active dynamic emergency location.

id
string
record_type
string

Identifies the type of the resource.

sip_from_id
string
status
string

Status of dynamic emergency address

Enum: "pending" "activated" "rejected"
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_endpoints
Request samples
application/json
{
  • "callback_number": "+13125550000",
  • "caller_name": "Jane Doe Desk Phone",
  • "dynamic_emergency_address_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0"
}
Response samples
application/json
{
  • "data": {
    • "callback_number": "+13125550000",
    • "caller_name": "Jane Doe Desk Phone",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "dynamic_emergency_address_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    • "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    • "record_type": "dynamic_emergency_endpoint",
    • "sip_from_id": "FXDFWEDF",
    • "status": "pending",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Delete a dynamic emergency endpoint

Deletes the dynamic emergency endpoint based on the ID provided

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Dynamic Emergency Endpoint id

Responses
200

Dynamic Emergency Endpoint Response

Response Schema: application/json
object (DynamicEmergencyEndpoint)
callback_number
required
string
caller_name
required
string
created_at
string

ISO 8601 formatted date of when the resource was created

dynamic_emergency_address_id
required
string

An id of a currently active dynamic emergency location.

id
string
record_type
string

Identifies the type of the resource.

sip_from_id
string
status
string

Status of dynamic emergency address

Enum: "pending" "activated" "rejected"
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_endpoints/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

res = telnyx.DynamicEmergencyEndpoint.retrieve('id')
res.delete()
Response samples
application/json
{
  • "data": {
    • "callback_number": "+13125550000",
    • "caller_name": "Jane Doe Desk Phone",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "dynamic_emergency_address_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    • "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    • "record_type": "dynamic_emergency_endpoint",
    • "sip_from_id": "FXDFWEDF",
    • "status": "pending",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}

Get a dynamic emergency endpoint

Returns the dynamic emergency endpoint based on the ID provided

SecuritybearerAuth
Request
path Parameters
id
required
string <uuid>

Dynamic Emergency Endpoint id

Responses
200

Dynamic Emergency Endpoint Response

Response Schema: application/json
object (DynamicEmergencyEndpoint)
callback_number
required
string
caller_name
required
string
created_at
string

ISO 8601 formatted date of when the resource was created

dynamic_emergency_address_id
required
string

An id of a currently active dynamic emergency location.

id
string
record_type
string

Identifies the type of the resource.

sip_from_id
string
status
string

Status of dynamic emergency address

Enum: "pending" "activated" "rejected"
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_endpoints/{id}
Request samples 
import telnyx
telnyx.api_key = "YOUR_API_KEY"

telnyx.DynamicEmergencyEndpoint.retrieve("id")
Response samples
application/json
{
  • "data": {
    • "callback_number": "+13125550000",
    • "caller_name": "Jane Doe Desk Phone",
    • "created_at": "2018-02-02T22:25:27.521Z",
    • "dynamic_emergency_address_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    • "id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777f0",
    • "record_type": "dynamic_emergency_endpoint",
    • "sip_from_id": "FXDFWEDF",
    • "status": "pending",
    • "updated_at": "2018-02-02T22:25:27.521Z"
    }
}