Skip to content

KAZOO Support Channels

This documentation is curated by 2600Hz as part of the KAZOO open source project. Join our community forums here for peer support. Only features in the docs.2600hz.com/supported space are included as part of our 2600Hz Support Services plan.

Locality

Locality#

API Index#

APIs#

Get the Carrier coverage in an area via postal code#

Required Authentication Level: basic

GET http://{SERVER}:{PORT}/v2/locality/coverage/{POSTAL_CODE}

curl -v -X GET \
    -H "X-Auth-Token: {AUTH_TOKEN}" \
    -H "X-Kazoo-Cluster-ID: {CLUSTER_ID}" \
    http://{SERVER}:{PORT}/v2/locality/coverage/{POSTAL_CODE}
{
    "auth_token": "{AUTH_TOKEN}",
    "data": {
        "cdma": 4,
        "lte": 4
    },
    "carrier": "sprint",
    "request_id": "{REQUEST_ID}",
    "status": "success"
}

Note: All the available technologies are returned with a rank from 0 to 4, where 0 means "no coverage" and 4 means "best coverage". Only the technologies available on the carrier will be listed (e.g. Sprint does not support "gsm").