911

Table of Contents

Overview

Add 911 to a number. Without this, 911 calls will still complete, but a fee is passed to us, and then to you, for manual lookups. Best to just have it set...

Controller: /911
Full Url: https://apiv1.teleapi.net/911/

Functions

/create

Full Url: https://apiv1.teleapi.net/911/create

Arguments:

Info: This will add a 911 address to a phone number. Everything sent to it is verified before we register it, so you may get back a suggested address. Otherwise, a success.

Example Success:

{
    "code": 200,
    "status": "success",
    "data": {
        "id": 42,
        "did_id": 15,
        "did_number": 5555555555,
        "full_name": "Bob McFrob",
        "address": "333 Some Street",
        "city": "Englewood",
        "state": "CO",
        "zip": "80112",
        "unit_type": "SUITE",
        "unit_number": "16B",
        "create_dt": "2016-02-05 12:22:06",
        "modify_dt": "2016-02-05 12:22:06"
    }
}

Example Error

{
    "code": 400,
    "status": "address",
    "data": {
        "address": "123 Some Street",
        "city": "ENGLEWOOD",
        "error": "newaddress",
        "state": "CO",
        "status": "invalid",
        "zip": "80112"
    }
}

/info

Full Url: https://apiv1.teleapi.net/911/info

Arguments:

Info: If you want to look up the address on file (or lack thereof) for a phone number

Example Success:

{
    "code": 200,
    "status": "success",
    "data": {
        "id": 42,
        "did_id": 15,
        "did_number": 5555555555,
        "full_name": "Bob McFrob",
        "address": "333 Some Street",
        "city": "Englewood",
        "state": "CO",
        "zip": "80112",
        "unit_type": "SUITE",
        "unit_number": "16B",
        "create_dt": "2016-02-05 12:22:06",
        "modify_dt": "2016-02-05 12:22:06"
    }
}

Example Error:

{
    "code": 400,
    "status": "error",
    "data": "No 911 Information Found"
}

/update

Full Url: https://apiv1.teleapi.net/911/update

Arguments:

Info: Really, this is just a rehash of /create. Just... this one updates, instead of creates.

Example Success:

{
    "code": 200,
    "status": "success",
    "data": {
        "id": 42,
        "did_id": 15,
        "did_number": 5555555555,
        "full_name": "Bob McFrob",
        "address": "333 Some Street",
        "city": "Englewood",
        "state": "CO",
        "zip": "80112",
        "unit_type": "SUITE",
        "unit_number": "16B",
        "create_dt": "2016-02-05 12:22:06",
        "modify_dt": "2016-02-05 12:22:06"
    }
}

Example Error:

{
    "code": 400,
    "status": "error",
    "data": "No 911 Information Found"
}

/remove

Full Url: https://apiv1.teleapi.net/911/remove

Arguments:

Info: Remove all 911 information from a phone number.

Example Success:

{
    "code": 200,
    "status": "success",
    "data": "Successfully removed 911 information"
}

Example Error:

{
    "code": 400,
    "status": "error",
    "data": "No 911 information found"
}

/validate

Full Url: https://apiv1.teleapi.net/911/validate

Arguments:

Info: If you want to validate that an address before trying to create or update.

Example Success:

{
    "code": 200,
    "status": "success",
    "data": "Address is validated"
}

Example Error:

{
    "code": 300,
    "status": "suggest",
    "data": {
        "address": "123 SOME STREET",
        "city": "ENGLEWOOD",
        "error": "newaddress",
        "state": "CO",
        "status": "invalid",
        "zip": "80112"
    }
}

Example Error 2 (we couldn't find a suggestion):

{
    "code": "500",
    "status": "error",
    "data": "Address is not validated"
}

/groups/create

Full Url: https://apiv1.teleapi.net/911/groups/create

Arguments:

Info: Create a new 911 Alert Group with name group_name

/groups/list

Full Url: https://apiv1.teleapi.net/911/groups/list

Arguments:

Info: List all of your 911 Alert Groups

/groups/get

Full Url: https://apiv1.teleapi.net/911/groups/get

Arguments:

Info: Get all 911 Alert Group information associated with a 911 entry

/groups/remove

Full Url: https://apiv1.teleapi.net/911/groups/remove

Arguments:

Info: Permanently remove all 911 Alert Group information and endpoints (any connected 911 addresses will be left intact)

/groups/assign

Full Url: https://apiv1.teleapi.net/911/groups/assign

Arguments:

Info: Associate a 911 Alert Group with a 911 entry. Groups can be associated with multiple 911 entries, but a 911 entry can only be associated with one group

/groups/unassign

Full Url: https://apiv1.teleapi.net/911/groups/unassign

Arguments:

Info: Unassociate a 911 Alert Group from a 911 entry. Both will still exist, they just won't be connected anymore

/groups/endpoint/add

Full Url: https://apiv1.teleapi.net/911/groups/endpoint/add

Arguments:

Info: Add an endpoint to a group. When a 911 call is made from an associated 911 entry, this endpoint will be notified in the appropriate way

/groups/endpoint/remove

Full Url: https://apiv1.teleapi.net/911/groups/endpoint/remove

Arguments:

Info: Remove an endpoint from a 911 Alert Group. endpoint_id can be found with the /groups/list or /groups/get commands

/groups/conference/set

Full Url: https://apiv1.teleapi.net/911/groups/conference/set

Arguments:

Info: Enable or disable conference calling for anyone who calls to listen in on the 911 call