Yay.com loading

Loading

Phone Numbers & Call Routing

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Number Search

Perform lookups for available numbers

Get your free API Key

Filter:

  • All
  • GET
  • POST
  • PUT
  • DELETE
  • Chargeable *

* You will be charged every time this command is run.

  • GET/voip/number-search?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

      • 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)

    Response Details

    200 Response

    {
        "result" : [
            {
                "country_code" : "44",
                "area_code" : "1947",
                "number" : "505505",
                "price_category" : 3
            }
        ],
        "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,
            "status" : "Allocated",
            "provider" : "YayYay Group Ltd"
        },
        "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"
    }