Yay.com loading

Loading

Phone Calls & CDR Data

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Call Packs

Call Packs allow call minutes to be included at a fixed cost

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-pack

    Gets all active call packs on an account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    Response Details

    200 Response

    {
        "result" : [
            {
                "pack_details" : {
                    "id" : 15,
                    "name" : "UK Landline & Mobile 5000",
                    "inc_minutes" : 5000
                },
                "expires_on" : "2017-01-19",
                "history" : [
                    {
                        "seconds_left" : 2000,
                        "effective_from" : "2017-01-19",
                        "effective_to" : "2017-01-19"
                    }
                ],
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-01-19",
                "updated_on" : "2017-01-19"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/call-pack/{uuid}

    Gets the details for a specific call pack

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Pack to query

    Response Details

    200 Response

    {
        "result" : {
            "pack_details" : {
                "id" : 15,
                "name" : "UK Landline & Mobile 5000",
                "inc_minutes" : 5000
            },
            "expires_on" : "2017-01-19",
            "history" : [
                {
                    "seconds_left" : 2000,
                    "effective_from" : "2017-01-19",
                    "effective_to" : "2017-01-19"
                }
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-01-19",
            "updated_on" : "2017-01-19"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • Chargeable *

    POST/voip/call-pack

    Creates a call pack for an account

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • expiry_date

      • Date

      • True

      The date on which this Call Pack should expire

      • pack_id

      • int

      • True

      The ID of the Call Pack Type you wish to create

    JSON all-fields example:

    {
        "pack_id" : 1,
        "expiry_date" : "2017-01-19"
    }

    Response Details

    201 Response

    {
        "result" : {
            "pack_details" : {
                "id" : 15,
                "name" : "UK Landline & Mobile 5000",
                "inc_minutes" : 5000
            },
            "expires_on" : "2017-01-19",
            "history" : [
                {
                    "seconds_left" : 2000,
                    "effective_from" : "2017-01-19",
                    "effective_to" : "2017-01-19"
                }
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-01-19"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    400 Response

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

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • Chargeable *

    PUT/voip/call-pack/{uuid}/renew

    Renews a call pack

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Pack to be renewed

    Response Details

    200 Response

    {
        "result" : {
            "pack_details" : {
                "id" : 15,
                "name" : "UK Landline & Mobile 5000",
                "inc_minutes" : 5000
            },
            "expires_on" : "2017-01-19",
            "history" : [
                {
                    "seconds_left" : 2000,
                    "effective_from" : "2017-01-19",
                    "effective_to" : "2017-01-19"
                }
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-01-19",
            "updated_on" : "2017-01-19"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • DELETE/voip/call-pack/{uuid}

    Deletes the specified call pack from an account

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Call Pack to be deleted

    Response Details

    204 Response

    {
        "result" : {},
        "status_code" : 204,
        "status_message" : "No Content"
    }

    404 Response

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