Yay.com loading

Loading

  • My Shopping Cart (0) £0.00

  • Register

Audio Management

API Access

Build custom apps using our JSON API

FREE
Get your free API Key

Playlists

A Playlist is a collection of Sounds that can be used as hold music.

Get your free API Key

Filter:

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

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

  • GET/voip/playlist

    Gets a list of all active playlists 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" : "On Hold Playlist",
                "random" : true,
                "sounds" : [
                    "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
                    "cb3e4406-8e83-46e9-9048-f35e00381da1"
                ],
                "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
                "created_on" : "2017-09-22",
                "updated_on" : "2017-09-22"
            }
        ],
        "status_code" : 200,
        "status_message" : "OK"
    }
  • GET/voip/playlist/{uuid}

    Gets the details for a specific playlist

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Playlist to be queried

    Response Details

    200 Response

    {
        "result" : {
            "name" : "On Hold Playlist",
            "random" : true,
            "sounds" : [
                "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
                "cb3e4406-8e83-46e9-9048-f35e00381da1"
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-09-22",
            "updated_on" : "2017-09-22"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • POST/voip/playlist

    Creates a new playlist

    Back to top

    Request Details

    Response Details

    Request Details

    This command has no URL/Query String parameters

    POST body

    • Name

    • Type

    • Required

      • name

      • String

      • True

      The name of this playlist

      • random

      • boolean

      • False

      Whether or not the playback order of this playlist is randomized

      • sounds

      • Array of String

      • True

      A list of UUIDs of the Sounds used for this playlist

    JSON all-fields example:

    {
        "name" : "On Hold Playlist",
        "random" : true,
        "sounds" : [
            "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
            "cb3e4406-8e83-46e9-9048-f35e00381da1"
        ]
    }

    Response Details

    201 Response

    {
        "result" : {
            "name" : "On Hold Playlist",
            "random" : true,
            "sounds" : [
                "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
                "cb3e4406-8e83-46e9-9048-f35e00381da1"
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-09-22"
        },
        "status_code" : 201,
        "status_message" : "Created"
    }

    404 Response

    {
        "result" : {},
        "status_code" : 404,
        "status_message" : "Not Found"
    }
  • PUT/voip/playlist/{uuid}

    Updates the specified playlist

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the Playlist to be updated

    PUT body

    • Name

    • Type

    • Required

      • name

      • String

      • True

      The name of this playlist

      • random

      • boolean

      • False

      Whether or not the playback order of this playlist is randomized

      • sounds

      • Array of String

      • True

      A list of UUIDs of the Sounds used for this playlist

    JSON all-fields example:

    {
        "name" : "On Hold Playlist",
        "random" : true,
        "sounds" : [
            "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
            "cb3e4406-8e83-46e9-9048-f35e00381da1"
        ]
    }

    Response Details

    200 Response

    {
        "result" : {
            "name" : "On Hold Playlist",
            "random" : true,
            "sounds" : [
                "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
                "cb3e4406-8e83-46e9-9048-f35e00381da1"
            ],
            "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6",
            "created_on" : "2017-09-22",
            "updated_on" : "2017-09-22"
        },
        "status_code" : 200,
        "status_message" : "OK"
    }

    404 Response

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

    Deletes the specified playlist

    Back to top

    Request Details

    Response Details

    Request Details

    URL and Query String Parameters

    • Name

    • Type

    • Required

      • uuid

      • String

      • True

      The UUID of the playlist 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"
    }
View Desktop Site