get device config

This endpoint retrieves the configuration details for a specific device.

Response

The response is a JSON object with the following structure:

• device: An object containing information about the device.

• config: An object containing configuration details for the device.

• shortcuts: An object containing settings related to the button shortcuts for righthand button presses. (beta feature)

Responses

200

200 ok application/json

Schema

deviceobject

configobject

alarmsarray

[items]

ambientColourstring

bluetoothEnabledstring

btHeadphonesEnabledboolean

clockFacestring

dayDisplayBrightnessstring

dayTimestring

dayYotoDailystring

dayYotoRadiostring

displayDimBrightnessstring

displayDimTimeoutstring

headphonesVolumeLimitedboolean

hourFormatstring

maxVolumeLimitstring

nightAmbientColourstring

nightDisplayBrightnessstring

nightMaxVolumeLimitstring

nightTimestring

nightYotoDailystring

nightYotoRadiostring

repeatAllboolean

shutdownTimeoutstring

volumeLevelstring

deviceFamilystring

deviceGroupstring

deviceIdstring

deviceTypestring

errorCode

geoTimezonestring

getPosixstring

macstring

onlineboolean

registrationCodestring

releaseChannelIdstring

releaseChannelVersionstring

shortcutsobject

modesobject

dayobject

contentarray

[items]object

cmdstring

paramsobject

cardstring

chapterstring

trackstring

nightobject

contentarray

[items]object

cmdstring

paramsobject

cardstring

chapterstring

trackstring

versionIdstring

JSON

{
  "device": {
    "config": {
      "alarms": [],
      "ambientColour": "#ff0000",
      "bluetoothEnabled": "0",
      "btHeadphonesEnabled": true,
      "clockFace": "digital-sun",
      "dayDisplayBrightness": "auto",
      "dayTime": "07:30",
      "dayYotoDaily": "3nC80/daily/<yyyymmdd>",
      "dayYotoRadio": "3nC80/radio-day/01",
      "displayDimBrightness": "0",
      "displayDimTimeout": "60",
      "headphonesVolumeLimited": false,
      "hourFormat": "12",
      "maxVolumeLimit": "16",
      "nightAmbientColour": "#ff0000",
      "nightDisplayBrightness": "auto",
      "nightMaxVolumeLimit": "16",
      "nightTime": "19:30",
      "nightYotoDaily": "3nC80/daily/<yyyymmdd>",
      "nightYotoRadio": "3nC80/radio-night/01",
      "repeatAll": false,
      "shutdownTimeout": "3600",
      "volumeLevel": "safe"
    },
    "deviceFamily": "v2",
    "deviceGroup": "",
    "deviceId": "t21KFoWYO48DwzXPIo7ObZ7U",
    "deviceType": "v2",
    "errorCode": null,
    "geoTimezone": "Europe/London",
    "getPosix": "GMT0BST,M3.5.0/1,M10.5.0",
    "mac": "9C-B6-D0-BF-4A-27",
    "online": false,
    "registrationCode": "MATEZRAA",
    "releaseChannelId": "general",
    "releaseChannelVersion": "v2.1.102",
    "shortcuts": {
      "modes": {
        "day": {
          "content": [
            {
              "cmd": "track-play",
              "params": {
                "card": "3nC80",
                "chapter": "daily",
                "track": "<yyyymmdd>"
              }
            },
            {
              "cmd": "track-play",
              "params": {
                "card": "3nC80",
                "chapter": "radio-day",
                "track": "01"
              }
            }
          ]
        },
        "night": {
          "content": [
            {
              "cmd": "track-play",
              "params": {
                "card": "3nC80",
                "chapter": "daily",
                "track": "<yyyymmdd>"
              }
            },
            {
              "cmd": "track-play",
              "params": {
                "card": "3nC80",
                "chapter": "radio-night",
                "track": "01"
              }
            }
          ]
        }
      },
      "versionId": "36645a9463e038d6cb9923257b38d9d9df7a6509"
    }
  }
}

Path Parameters

deviceId string Required

GET

/device-v2/{deviceId}/config

Server URL: https://api.yotoplay.com

Authorization (bearerAuth)

Token

Try it out

cURL

curl "https://api.yotoplay.com/device-v2/{deviceId}/config"
--header "Authorization: Bearer [YOUR_TOKEN]"

JavaScript

const options = {
  method: 'GET',
  headers: {
    'Authorization': 'Bearer [YOUR_TOKEN]'
  }
};

fetch('https://api.yotoplay.com/device-v2/{deviceId}/config', options)
  .then(response => response.json())
  .then(response => console.log(response))
  .catch(err => console.error(err));

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.yotoplay.com/device-v2/{deviceId}/config",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer [YOUR_TOKEN]"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

Python

import requests

url = "https://api.yotoplay.com/device-v2/{deviceId}/config"

headers = {
    "Authorization": "Bearer [YOUR_TOKEN]"
}

response = requests.request("GET", url, headers=headers)

print(response.text)