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    

Toll Free Numbers

International Toll Free numbers may be assigned using the details outlined in this documentation. Calls made to these numbers will not incur toll charges.

To order a Toll Free number, submit a request similar to the following:

POST https://api.telmetrics.com/v3/api/groups/{group_id}/numbers

{
    "name": "ABC Company",
    "phone_number_request": {
      "number_type": "international",
      "match_type": "tollfree",
      "iso_country": "GB"
    },
    "call_routes": {
      "route_type": "Basic",
      "route": {
        "termination_number": "+441634567700",
        "features": {
          "call_record": {
            "enabled": true,
            "notification_text": "this call will be recorded",
            "require_confirmation": false,
            "record": true,
            "redaction_enabled": false
          },
          "whisper": {
            "enabled": true,
            "notification_text": "call brought you be XYZ marketing"
          }
        }
      }
    }
  }

A successful request will return a response similar to the following:

{
    "id": 9570214,
    "name": "ABC Company",
    "group_id": 12462424,
    "status": "Active",
    "phone_number": "+448000885620",
    "created_datetime": "2020-07-30T18:30:39.059Z",
    "modified_datetime": "2020-07-30T18:30:39.059Z",
    "sms_routes": {
        "route_type": "None"
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 31777255,
            "termination_number": "+441634567700",
            "features": {
                "call_record": {
                    "enabled": true,
                    "notification_text": "this call will be recorded",
                    "require_confirmation": false,
                    "record": true,
                    "redaction_enabled": false
                },
                "whisper": {
                    "enabled": true,
                    "notification_text": "call brought you be XYZ marketing"
                }
            }
        }
    }
}

Field Definitions

Field

Description

Required

name

A unique name that identifies the number

Yes

phone_number_request -> number_type

For international number ordering, this field must be set to: international

Yes

phone_number_request -> match_type

For Toll Free numbers, this value must be set to: tollfree

Yes

phone_number_request -> iso_country

Provide the two letter ISO country abbreviation where the number should be provisioned from. For details refer to our list of Supported Countries

Yes

phone_number_request -> owner_address_details

The owner_address_details portion of the request defines a physical address and name for the purposes of number registration.

Yes

phone_number_request -> owner_address_details -> salutation

Salutation of the person the number will be registered to (Mr/Mrs/Ms/etc)

Yes

phone_number_request -> owner_address_details -> first_name

First name of the person the number will be registered

Yes

phone_number_request -> owner_address_details -> last_name

Last name of the person the number will be registered

Yes

phone_number_request -> owner_address_details -> registration_name

Business entity that the number will be registered to

Yes

phone_number_request -> owner_address_details -> building_number

Mailing address building number

Yes

phone_number_request -> owner_address_details -> street

Mailing address street name

Yes

phone_number_request -> owner_address_details -> city

Mailing address city

Yes

phone_number_request -> owner_address_details -> region

Mailing address region

Yes

phone_number_request -> owner_address_details -> postal_code

Mailing address postal code

Yes

phone_number_request -> owner_address_details -> iso_country

Mailing address country. Please note that the owner address details must correspond to the value specified in: phone_number_request -> iso_country

Yes

call_routes -> route_type

At this time, only "Basic" routing is supported for international ordering

Yes

call_routes -> route -> termination_number

The phone number where all calls will be forwarded to. Please note that the termination_number must be located within the country specified in: phone_number_request -> iso_country

Yes

Updated 10 months ago

Toll Free Numbers


Suggested Edits are limited on API Reference Pages

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