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    

Transcriptions

Enabling Call Transcriptions on your Tracking Number will provide you with a text transcriptions for calls to your number.

When this feature is enabled, calls to your Tracking Number will be transcribed. Please note that call transcriptions can only be generated when the call recording feature is also enabled. For additional details on how to configure call recording please refer to the Call Recording portion of this documentation. Additional fees may apply for this feature, contact Customer Success for additional Information.

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

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

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

Field

Value

transcription_settings - > transcript_enabled

true (when enabled, transcriptions will be generated for calls made to the Tracking Number)

Using the end-point POST https://api.telmetrics.com/v3/api/groups/{groupid}/numbers, submit a request similar to the following to enable the Transcription 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": "for quality assurance purposes this call may be recorded",
                    "require_confirmation": true,
                    "redaction_enabled": true,
                    "authenticate_call_record_access": true,
                    "transcription_settings": {
                        "transcript_enabled": true
                     }
                }
            }
        }
    }
}

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

{
    "call_routes": {
        "route_type": "basic",
        "route": {
            "features": {
                "call_record": {
                    "enabled": true,
                    "notification_text": "for quality assurance purposes this call may be recorded",
                    "require_confirmation": true,
                    "record": true,
                    "redaction_enabled": true,
                    "authenticate_call_record_access": true,
                    "transcription_settings": {
                        "transcript_enabled": 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-13T17:05:39.746272Z",
    "sms_routes": {
        "route_type": "None"
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 30474104,
            "termination_number": "4043993433",
            "features": {
                "call_record": {
                    "enabled": true,
                    "authenticate_call_record_access": true,
                    "notification_text": "for quality assurance purposes this call may be recorded",
                    "record": true,
                    "redaction_enabled": true,
                    "transcription_settings": {
                        "transcription_enabled": true
                    }
                }
            }
        }
    }
}

Updated 10 months ago

Transcriptions


Suggested Edits are limited on API Reference Pages

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