Storefronts
- Invoices
- Credit Notes
Customer Management
VoIP Bundle (Subscriptions)
- VoIP Subscription Bundle
SIP Account Management
Audio Management
- Sounds
- Playlists
Phone Numbers & Call Routing
Phone Calls & CDR Data
VoIP Phone Short Code
- Short Codes
eFax Management
- Fax Messages
- Fax Authorized Senders
Voicemails & Mailboxes
Caller ID
- Caller IDs
- Caller ID Requests
SIP Trunks
- Trunk Authentication
- VoIP Trunks
Wallboard Statistics
VoIP Phone Provisioning
- Devices
Call Queueing
Phone Books
- Phone Book
- Phone Book Contact
VoIP Phone Speed Dial
- Speed Dials
Text (SMS) Messaging
- Text Message Campaign

API Access

Build custom apps using our JSON API

Configure API

Playlists

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

Become a Reseller

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

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

Response Details

200 Response

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

GET/voip/playlist/{uuid}

Gets the details for a specific playlist

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" : {
        "created_on" : "2023-06-04",
        "default" : true,
        "name" : "On Hold Playlist",
        "random" : true,
        "sounds" : [
            "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
            "cb3e4406-8e83-46e9-9048-f35e00381da1"
        ],
        "updated_on" : "2023-06-04",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "status_code" : 200,
    "status_message" : "OK"
}

404 Response

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

POST/voip/playlist

Creates a new playlist

Request Details

Response Details

Request Details

This command has no URL/Query String parameters

POST body

Name
Type
Required

- default
- boolean
- False
Whether or not this is the default playlist
- 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:

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

Response Details

201 Response

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

404 Response

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

PUT/voip/playlist/{uuid}

Updates the specified playlist

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

- default
- boolean
- False
Whether or not this is the default playlist
- 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:

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

Response Details

200 Response

{
    "result" : {
        "created_on" : "2023-06-04",
        "default" : true,
        "name" : "On Hold Playlist",
        "random" : true,
        "sounds" : [
            "aab8348d-deca-416f-ba67-c6c6ee03a1ca",
            "cb3e4406-8e83-46e9-9048-f35e00381da1"
        ],
        "updated_on" : "2023-06-04",
        "uuid" : "31347d42-00bd-44a5-9b5c-20dc4197a2f6"
    },
    "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"
}
```