Number Search

Perform lookups for available numbers

• GET/voip/number-search?country_code={country_code}&area_code={area_code}&pattern={pattern}&limit={limit}&page={page}&type={type}

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • country_code

    • int

    • False

    The country code to search for available numbers under

  • • area_code

    • int

    • True

    The area code to search for available numbers under

  • • pattern

    • String

    • False

    The pattern to match available numbers against

  • • limit

    • int

    • False

    How many results to return

  • • page

    • int

    • True

    Which page of results to return

  • • type

    • String

    • False

    What type of number to search for (Premium, Standard, All)

  • • include_price

    • String

    • False

    Should the price of the number be returned, this will include both the retail cost, and the cost to yourself if you have reseller

  Response Details

  200 Response

  {
      "result" : [
          {
              "area_code" : "1947",
              "number" : "505505",
              "price" : 199,
              "price_category" : 1
          }
      ],
      "status_code" : 200,
      "status_message" : "OK"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }

• GET/voip/number/provider/{number}

  Gets the provider who manages a UK phone number

  Back to top

  Request Details

  Response Details

  Request Details

  URL and Query String Parameters

  • Name

  • Type

  • Required

  • • number

    • String

    • True

    The UK phone number who's provider is being queried

  Response Details

  200 Response

  {
      "result" : {
          "area_code" : 1947,
          "provider" : "YayYay Group Ltd",
          "status" : "Allocated"
      },
      "status_code" : 200,
      "status_message" : "OK"
  }

  400 Response

  {
      "result" : {},
      "status_code" : 400,
      "status_message" : "Bad Request"
  }

  404 Response

  {
      "result" : {},
      "status_code" : 404,
      "status_message" : "Not Found"
  }