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 Whisper is a feature that plays a short message to the call-receiving party prior to the call being connected. This feature is used primarily to inform the call's destination that the call they are about to receive was delivered by your organization; the caller continues to hear ringing in the meanwhile.

When this feature is enabled, recipients of calls from your Tracking Number will hear the notification message you supply. Please note that this feature is enabled at the "call_route" level.

This feature is enabled via the Number Number Resource, and can be configured during the provisioning of a Tracking Number, or applied later as an update.

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)

notification_text

Notification text that will be read to the advertiser

Required if notification_file is not supplied

notification_file

Notification file GUID that corresponds to an audio file to be played to the advertiser. 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 Whisper feature on your Tracking Line when provisioning:

{
    "name": "ABC Company",
    "phone_number_request": {
        "match_type": "tollfree",
        "number_match_filter": "833"
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "termination_number": "4043993433",
            "features": {
                "whisper": {
                    "enabled": true,
                    "notification_text": "this call brought to you by XYZ agency"
                }
            }
        }
    }
}

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

{
    "call_routes": {
        "route_type": "basic",
        "route": {
            "features": {
                "whisper": {
                    "enabled": true,
                    "notification_text": "this call brought to you by XYZ agency"
                }
            }
        }
    }
}

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

{
    "id": 8660483,
    "name": "ABC Company",
    "group_id": 11623282,
    "status": "Active",
    "phone_number": "8332024441",
    "created_datetime": "2018-04-13T00:00:00Z",
    "sms_routes": {
        "route_type": "None"
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30474104,
            "termination_number": "4045553433",
            "features": {
                "whisper": {
                    "enabled": true,
                    "notification_text": "this call brought to you by XYZ agency"
                }
            }
        }
    }
}

Updated 10 months ago

Whisper


Suggested Edits are limited on API Reference Pages

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