Retrieving Tracking Numbers

Retrieving a Tracking Number

You may retrieve a tracking number by sending a request to the following end-point:

GET https://api.telmetrics.com/v3/api/numbers/{number_id}

Sample Response:

{
    "id": 9051616,
    "group_id": 11992428,
    "status": "Active",
    "phone_number": "8005558618",
    "created_datetime": "2018-11-09T10:28:42.783",
    "modified_datetime": "2018-11-09T10:28:42.987",
    "sms_routes": {
        "route_type": "None"
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "id": 31028870,
            "termination_number": "9052198277",
            "features": {
                "call_record": {
                    "enabled": true,
                    "notification_file": "51a1de47-681d-4c4e-83f3-4bbf0ca45e6a",
                    "require_confirmation": false,
                    "record": true,
                    "redaction_enabled": true,
                    "authenticate_call_record_access": false,
                    "transcription_settings": {
                        "transcript_enabled": true,
                        "call_scoring_enabled": true,
                        "keyword_list": {
                            "id": 3
                        },
                        "custom_vocabulary": {
                            "id": 9
                        }
                    }
                },
                "whisper": {
                    "enabled": false,
                    "notification_file": "a0f01d0f-6883-496b-955b-f5225e498c98"
                }
            }
        }
    }
}

Retrieving all Tracking Numbers

You may retrieve all tracking number by sending a request to the following end-point:

GET https://webservice.telmetrics.com/v3/api/numbers/

This request will return all Tracking Numbers associated with your account. Please note that the results will be paged; for additional information please see our Paging Documentation

Sample Response:

{
    "paging": {
        "pageNumber": 1,
        "pageSize": 100,
        "total": 504
    },
    "results": [
        {
            "id": 9086030,
            "group_id": 12028336,
            "status": "Active",
            "phone_number": "6475550078",
            "created_datetime": "2018-12-06T09:45:25.183",
            "modified_datetime": "2018-12-10T14:25:54.227",
            "sms_routes": {
                "route_type": "None"
            },
            "call_routes": {
                "route_type": "Basic",
                "route": {
                    "id": 31148350,
                    "termination_number": "9055558291",
                    "features": {
                        "call_record": {
                            "enabled": true,
                            "notification_file": "51a1de47-681d-4c4e-83f3-4bbf0ca45e6a",
                            "require_confirmation": false,
                            "record": true,
                            "redaction_enabled": false,
                            "authenticate_call_record_access": false,
                            "transcription_settings": {
                                "transcript_enabled": false,
                                "call_scoring_enabled": false
                            }
                        },
                        "whisper": {
                            "enabled": false,
                            "notification_file": "a0f01d0f-6883-496b-955b-f5225e498c98"
                        }
                    }
                }
            }
        },
        {
            "id": 9082767,
            "group_id": 12023630,
            "status": "Active",
            "phone_number": "2895550910",
            "created_datetime": "2018-12-04T14:02:19.677",
            "modified_datetime": "2018-12-04T14:02:51.333",
            "sms_routes": {
                "route_type": "Autoreply",
                "route": {
                    "autoreply_enabled": true,
                    "autoreply_message": "Thanks for Texting us."
                }
            },
            "call_routes": {
                "route_type": "Basic",
                "route": {
                    "id": 31145086,
                    "termination_number": "9055558888",
                    "features": {
                        "call_record": {
                            "enabled": false,
                            "notification_file": "51a1de47-681d-4c4e-83f3-4bbf0ca45e6a",
                            "require_confirmation": false,
                            "record": true,
                            "redaction_enabled": false,
                            "authenticate_call_record_access": false,
                            "transcription_settings": {
                                "transcript_enabled": false,
                                "call_scoring_enabled": false
                            }
                        },
                        "whisper": {
                            "enabled": false,
                            "notification_file": "a0f01d0f-6883-496b-955b-f5225e498c98"
                        }
                    }
                }
            }
        }
        ...
    }
}