Yay.com loading

Loading

Phone Calls & CDR Data

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Call Costs

Commands to get the cost of making calls from this account

Get your free API Key

Filter:

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

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

  • GET/voip/call-cost?number={number}

    Gets the cost to call a specific number.

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • number

      • String

      • True

      The number you wish to find the cost for, in international format. e.g. '443301226000'

    Response Details

    200 Response

    {
        "result" : {
            "peak_cost" : 0.01,
            "off_peak_cost" : 0.005,
            "weekend_cost" : 0.005,
            "connection_cost" : 0.0,
            "fax_per_page" : 0.05,
            "minimum_charge_period" : 1,
            "charge_increment" : 1,
            "country_iso" : "GB",
            "country_name" : "United Kingdom",
            "service_name" : "Mobile",
            "provider_name" : "BT"
        },
        "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"
    }