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    

Auto-Reply

Telmetrics provides the ability to send an Auto-Reply message via SMS when someone texts your Tracking Number or Number Pool. Please note that the auto-reply message will only be sent once per 24 hour period.

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:

FieldValue
sms_routes -> route_typeAutoreply
sms_routes -> route -> autoreply_enabledtrue/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_messageThe content of the message that will be sent to anyone sending a text message to the Tracking Number/Number Pool

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 Auto-Reply feature on your Tracking Line when provisioning:

{
    "name": "SMS - Auto-Reply",
    "phone_number_request": {
        "match_type": "Tollfree"
    },
    "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": {
            "termination_number": "4075552958"
        }
    }
}

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

{    
    "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."
        }
    }
}

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 about a year ago

Auto-Reply


Suggested Edits are limited on API Reference Pages

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