telmetricsV3

Telmetrics v3 API Developer Documentation

Welcome to the Telmetrics v3 developer hub. You'll find comprehensive guides and documentation to help you start working with our API as quickly as possible.

Get Started    

Call Verify

The Call Verify feature prompts callers to supply a keypress before connecting a phone call to an advertiser. This feature is helpful in blocking telemarketer phone calls, as well as being an extra step to qualify a caller before routing a call to the terminating phone number.

Be aware that this number feature cannot be used in conjunction with Advanced Call Routing configruations.

This feature is enabled via the Number Number Resource, rather than the 'call_route' level. All calls to the tracking number (regardless of call route) will be played the call verification notification.

The following fields are used in this request, and must be passed in your request:

Field

Value

enabled

true (feature may be disabled at a later date by submitting this value as:false)

key_press

A number between 1-9 the caller must enter on their phone's keypad to be connected to the advertiser

notification_text

Notification text that will be read to the caller that prompts them to supply a keypress

Required if notification_file is not supplied

notification_file

Notification file GUID that corresponds to an audio file to be played to the caller prompting them for a keypress. Required if notification_text is not supplied

For additional information on uploading and managing audio notification files, refer to API section: Notification File Management

Using the end-point POST https://api.telmetrics.com/v3/api/groups/{groupid}/numbers, submit a request similar to the following to enable the Call Verification feature on your Tracking Line when provisioning:

{
    "name": "ABC Company",
    "phone_number_request": {
        "match_type": "tollfree",
        "number_match_filter": "833"
    },
    "features": {
        "call_verify": {
            "enabled": true,
            "key_press": 1,
            "notification_text": "Thanks for calling Telmetrics.  Press 1 to continue."
        }
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "termination_number": "4045553433"
        }
    }
}

Using the end-point PUT https://api.telmetrics.com/v3/api/numbers/8660482, submit a request similar to the following to enable the Call Verification feature on an existing tracking line:

{
    "features": {
        "call_verify": {
            "enabled": true,
            "key_press" : 1,
            "notification_text": "Thanks for calling Telmetrics.  Press 1 to continue."
        }
    }
}

A successful post will result in the creation of a tracking number:

{
    "id": 8660480,
    "name": "ABC Company",
    "group_id": 11623282,
    "status": "Active",
    "phone_number": "8332018274",
    "created_datetime": "2018-04-13T00:00:00Z",
    "features": {
        "call_verify": {
            "enabled": true,
            "notification_text": "Thanks for calling Telmetrics.  Press 1 to continue."
        }
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30474101,
            "termination_number": "4045553433"
        }
    }
}

Updated 10 months ago

Call Verify


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.