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    

SMS-To-Chat

Telmetrics provides the capability to allow two-way communication via SMS messages for your Tracking Number or Number Pool. Visitors to your website can start a conversation via SMS using their mobile device's native SMS application. Message received by Telmetrics will be forwarded to the configured chat client (Slack, Contact At Once, LiveChat Inc, etc.) where they can be handled by a customer service representative. When the customer service representative replies in the chat client, the message will be received by Telmetrics and forwarded the website visitor's mobile device via SMS.

For more details on creating an integration configuration for your chat client, please see:

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

ChatClient

sms_routes -> route -> chat_client_id

A GUID that corresponds to SMS-To-Chat integration for one of the:

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

{
    "name": "SMS to Chat",
    "phone_number_request": {
        "match_type": "Tollfree"
    },
    "sms_routes": {
        "route_type": "ChatClient",
        "route": {
            "chat_client_id": "bd33b67d-4027-4ffd-a8eb-851c2c173432"
        }
    },
    "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": "ChatClient",
        "route": {
            "chat_client_id": "bd33b67d-4027-4ffd-a8eb-851c2c173432"
        }
    }
}

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-09T09:17:05.207",
    "sms_routes": {
        "route_type": "ChatClient",
        "route": {
            "chat_client_id": "bd33b67d-4027-4ffd-a8eb-851c2c173432"
        }
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30703449,
            "termination_number": "4075552958"
        }
    }
}

Updated 10 months ago

SMS-To-Chat


Suggested Edits are limited on API Reference Pages

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