Get Allocated Numbers

API Endpoint

To get available numbers, the API request is made to this endpoint:


GET<https://kpi.knowlarity.com/Basic/v1/account/numbers/AvailablePhoneNumbers?circle_id=1>

Optional Parameters

Parameters	Description
circle_id	The Id of Circle for which a list of available numbers is required
number_type	Type of number required (enum : (LANDLINE, TOLLFREE, MOBILE (default))
how_many	Integer value
dynamic_cli	Available values in sting, upper case
regex	Sting value
offset	String value, default is 40

Sample Request

curl -X GET \
  'https://kpi.knowlarity.com/Basic/v1/account/numbers/AvailablePhoneNumbers?circle_id=<circle_id>' \
  -H 'accept: application/json' \
  -H 'authorization: <authorization-key>' \
  -H 'x-api-key: <x-api-key>'

Sample Response

{
    "numbers": [
        {
            "number_type": "MOBILE",
            "number_rating": 0,
            "circle_id": 1,
            "number": "+9189297XXXXX",
            "provider_name": "Vodafone"
        },
        {
            "number_type": "MOBILE",
            "number_rating": 0,
            "circle_id": 1,
            "number": "+9189297XXXXX",
            "provider_name": "Vodafone"
        }
      ]
}