Retrieving Number Pools

Retrieving a Number Pool

You may retrieve a Number Pool by sending a request to the following end-point:

GET https://webservice.telmetrics.com/v3/api/numberpools/{numberpool_id}

Sample Response:

{
    "id": 199,
    "name": "Boca Raton FL Pool",
    "group_id": 4250816,
    "status": "active",
    "match_period": 30,
    "quantity": 5,
    "numbers": [
        {
            "id": 7373479,
            "phone_number": "4702314693"
        },
        {
            "id": 7373480,
            "phone_number": "4703442203"
        },
        {
            "id": 7373481,
            "phone_number": "4704404556"
        },
        {
            "id": 8413019,
            "phone_number": "4702769424"
        },
        {
            "id": 8413020,
            "phone_number": "4702890302"
        }
    ],
    "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
            }
        }
    },
    "replacement_configuration": {
        "numbers_to_replace": [
            "5555555289",
            "5555555289",
            "5555555289",
            "5555552256",
            "8555614372",
            "8002553224"
        ],
        "tracking_sources": [
            {
                "referrer_domain": "Google",
                "url_triggers": [
                    "gclid=*"
                ]
            }
        ]
    },
    "sms_routes": {
        "route_type": "ChatClient",
        "route": {
            "chat_client_id": "bd33b67d-4027-4ffd-a8eb-851c2c173432"
        }
    },
    "call_routes": {
        "route_type": "Basic",
        "route": {
            "termination_number": "9052198236"
        }
    }
}

Retrieving all Tracking Number Pools

You may retrieve all Number Pools by sending a request to the following end-point:

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

This request will return all Number Pools 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": 63
    },
    "results": [
        {
            "id": 199,
            "name": "Boca Raton FL Pool",
            "group_id": 4250816,
            "status": "active",
            "match_period": 30,
            "quantity": 5,
            "numbers": [
                {
                    "id": 7373479,
                    "phone_number": "4702314693"
                },
                {
                    "id": 7373480,
                    "phone_number": "4703442203"
                },
                {
                    "id": 7373481,
                    "phone_number": "4704404556"
                },
                {
                    "id": 8413019,
                    "phone_number": "4702769424"
                },
                {
                    "id": 8413020,
                    "phone_number": "4702890302"
                }
            ],
            "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
                    }
                }
            },
            "replacement_configuration": {
                "numbers_to_replace": [
                    "5555555289",
                    "5555555289",
                    "5555555289",
                    "5555552256",
                    "8555614372",
                    "8002553224"
                ],
                "tracking_sources": [
                    {
                        "referrer_domain": "Google",
                        "url_triggers": [
                            "gclid=*"
                        ]
                    }
                ]
            },
            "sms_routes": {
                "route_type": "ChatClient",
                "route": {
                    "chat_client_id": "bd33b67d-4027-4ffd-a8eb-851c2c173432"
                }
            },
            "call_routes": {
                "route_type": "Basic",
                "route": {
                    "termination_number": "9052198236"
                }
            }
        }
      ...
      ]
}