telmetricsV3

Marchex Marketing Edge API Developer Documentation

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

Get Started    

Call Recording

Telmetrics provides the ability to record calls with high quality and clarity. This allows you to listen to completed calls to evaluate whether it could be qualified as a lead, determine which sources deliver the best quality callers, or to evaluate service levels and train your sales team.

When this feature is enabled, advertisers receiving calls from your Tracking Number will hear the notification message you supply.

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

Please note that this feature is enabled at the "call_route" level. For additional information on enabling the call record feature for Tracking Numbers with complex routing options, please refer to the Call Routing portion of this documentation.

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

FieldValue
enabledtrue (feature may be disabled at a later date by submitting this value as:false)
notification_textNotification text that will be read to the caller informing them that the call will be recorded

Required if notification_file is not supplied
notification_fileNotification file GUID that corresponds to an audio file to be played to the call informing them that the call will be recorded. Required if a notification_text is not supplied

For additional information on uploading and managing audio notification files, refer to API section: Notification File Management
require_confirmationtrue/false - when 'true', the caller to press "1" before the call is connected to the advertiser
redaction_enabledtrue/false - when 'true', any payment card information (PCI) will be redacted from the file. *Additional fees may apply, contact Customer Success for additional Information
authenticate_call_record_accesstrue/false - when 'true', any attempt to retrieve the call required will require authentication prior to listening to the call

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 Record 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": "4045553433",
            "features": {
                "call_record": {
                    "enabled": true,
                    "notification_text": "this call may be recorded for quality control purposes",
                    "require_confirmation": true,
                    "redaction_enabled": true,
                    "authenticate_call_record_access": true
                }
            }
        }
    }
}

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

{
    "call_routes": {
        "route_type": "basic",
        "route": {
            "features": {
                "call_record": {
                    "enabled": true,
                    "notification_text": "this call may be recorded for quality assurance purposes",
                    "require_confirmation": true,
                    "redaction_enabled": true,
                    "authenticate_call_record_access": true
                }
            }
        }
    }
}

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:00",
    "modified_datetime": "2018-04-13T14:32:13.236398Z",
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30474104,
            "termination_number": "4043993433",
            "features": {
                "call_record": {
                    "enabled": true,
                    "notification_text": "this call may be recorded for quality assurance purposes",
                    "require_confirmation": true,
                    "redaction_enabled": true,
                    "authenticate_call_record_access": true
                }
            }
        }
    }
}

Updated 8 months ago

Call Recording


Suggested Edits are limited on API Reference Pages

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