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    

SmartNumber Service

Telmetrics provides the ability to bridge a potential customer and business via SMS. When someone sends a text message to your Tracking Number, the business will receive an SMS notification that a potential customer has texted them. By clicking on the link in the notification they will see the content of the text message from the potential customer, and the ability to reply directly back to the consumer using the native SMS client on their mobile device.

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 SMS-Routing level.

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

Field

Value

sms_routes -> route_type

SmartNumber (not currently supported for Number Pools)

sms_routes -> route -> autoreply_enabled

true/false - when true, the auto-reply message will be sent to anyone sending a text message to the Tracking Number/Number Pool.

Note that an auto-reply message is only sent once per day.

sms_routes -> route -> autoreply_message

The content of the message that will be sent to anyone sending a text message to the Tracking Number/Number Pool. Example: "Thanks for texting, we'll get back to you shortly."

Please not there is a 155 character limit for this field.

sms_routes -> route -> alternate_text_termination

When forwarding notifications to the business owner, the termination number for the Tracking Number/Number Pool may not be SMS capable. Use this field to choose an alternate termination number for text messages. Example: 2125551111

*Note: when using SmartNumber with Number with advanced routing you will need to provide this value

notification_text

Notification text that will be read to the caller informing them that the call will be recorded

Required if notification_file is not supplied

notification_file

Notification 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_confirmation

true/false - when 'true', the caller to press "1" before the call is connected to the advertiser

redaction_enabled

true/false - when 'true', any payment card information (PCI) will be redacted from the file. *Additional fees may apply, contact Customer Success for additional Information

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

{
    "name": "SMS - SmartNumber",
    "phone_number_request": {
        "match_type": "Tollfree"
    },
    "sms_routes": {
        "route_type": "SmartNumber",
        "route": {
            "autoreply_enabled": true,
            "autoreply_message": "Thanks for texting us - we'll get back to you shortly.",
            "mobile_termination": "4075553333"
        }
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30703449,
            "termination_number": "4075554444"
        }
    }
}

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

{    
    "sms_routes": {
        "route_type": "SmartNumber",
        "route": {
            "autoreply_enabled": true,
            "autoreply_message": "Thanks for texting us - we'll get back to you shortly.",
            "mobile_termination": "4075553333"
        }
    }
}

A successful post will result in the creation/update of a tracking number with SMS-To-Chat capabilities:

{
    "id": 8848979,
    "group_id": 11812328,
    "status": "Active",
    "phone_number": "8003979906",
    "created_datetime": "2018-07-06T15:23:17.403",
    "modified_datetime": "2018-07-06T15:41:02.96",
    "sms_routes": {
        "route_type": "Autoreply",
        "route": {
            "autoreply_enabled": true,
            "autoreply_message": "Thanks for texting us - we are currently only accepting phone calls on this number."
        }
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30703449,
            "termination_number": "4075552958"
        }
    }
}

Updated 10 months ago

SmartNumber Service


Suggested Edits are limited on API Reference Pages

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