Yay.com loading

Loading

Call us on 0330 122 6000

Login to Yay.com

VoIP Phone Provisioning

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Devices

A Device is a hardware phone that is linked to an account and can be remotely configured

Get your free API Key

Filter:

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

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

  • GET/provisioning/device

    Gets all of the active devices 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" : [
            {
                "name" : "Pete's Grandstream",
                "mac_address" : "0123456789AB",
                "use_tcp" : true,
                "use_keep_alive" : true,
                "keep_alive_time" : 20,
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2018-01-17",
                "updated_on" : "2018-01-17"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/provisioning/device/{uuid}

    Gets a specific device on 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 Device to be queried

    Response Details

    200 Response

    {
        "result" : {
            "name" : "Pete's Grandstream",
            "mac_address" : "0123456789AB",
            "use_tcp" : true,
            "use_keep_alive" : true,
            "keep_alive_time" : 20,
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2018-01-17",
            "updated_on" : "2018-01-17"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
View Desktop Site