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    

Stop Call

The Stop Call feature is used to temporarily block calls from forwarding to a Tracking Number's termination number. Typically this feature is used during billing disputes where you need to retain the Tracking Number until the dispute is resolved.

When this feature is enabled, callers to your Tracking Number will be played a notification message. Calls made to a Tracking Number with this feature enabled will still appear in reporting.

This feature is enabled via the Number Number Resource, and can be configured during the provisioning of a Tracking Number. 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)

notification_text

Notification text that will be read to the caller

Required if notification_file is not supplied

notification_file

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

{
    "name": "ABC Company",
    "phone_number_request": {
        "match_type": "tollfree",
        "number_match_filter": "833"
    },
    "features": {
        "stop_call": {
            "enabled": true,
            "notification_text": "The number you are calling is not currently avaialble, please try again later."
        }
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "termination_number": "4043993433"
        }
    }
}

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

{
    "call_routes": {
        "route_type": "basic",
        "route": {
            "features": {
                "stop_call": {
                    "enabled": true,
                    "notification_text": "The number you are calling is not currently avaialble, please try again later."
                }
            }
        }
    }
}

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": {
        "stop_call": {
            "enabled": true,
            "notification_text": "The number you are calling is not currently avaialble, please try again later."
        }
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30474101,
            "termination_number": "4045553433"
        }
    }
}

Updated 10 months ago

Stop Call


Suggested Edits are limited on API Reference Pages

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