List all music on hold options

Query Parameters

page integer

Default value: 1

The page number to retrieve

perPage integer

Possible values: >= 1 and <= 50

Default value: 10

The number of items per page, max 50

Responses

Successfully retrieved the music on hold options

application/json

Schema

Example (from schema)

Schema

data object[]

Array [

id string

The ID of the music on hold

name string

The name of the music on hold (localized)

playUrl uri

The url to the audio stream of the music on hold

]

meta object

pagination object

totalItems integer

The number of items in the collection

totalPages integer

The number of pages in the collection

currentPage integer

The current page

perPage integer

Possible values: >= 1 and <= 50

The number of items per page

links object

self uri

The url to the first page

first uri

The url to the first page

last uri

The url to the last page

previous uri nullable

The url to the previous page

next uri nullable

The url to the next page

{
  "data": [
    {
      "id": "65438adbfe329346cc4af2f9",
      "name": "Guitar",
      "playUrl": "https://api.rinkel.com/music-on-hold/65438adbfe329346cc4af2f9/stream"
    }
  ],
  "meta": {
    "pagination": {
      "totalItems": 100,
      "totalPages": 10,
      "currentPage": 1,
      "perPage": 10
    },
    "links": {
      "self": "https://api.rinkel.com/users?page=1",
      "first": "https://api.rinkel.com/users?page=1",
      "last": "https://api.rinkel.com/users?page=10",
      "previous": null,
      "next": "https://api.rinkel.com/users?page=2"
    }
  }
}

Bad request

application/json

Schema

Example (from schema)

Schema

errors object[]

Array [

code string

Human readable error code

message string

Human readable error message

detail string

Human readable error detail

]

{
  "errors": [
    {
      "code": "ERROR_CODE",
      "message": "An error occurred while calling the endpoint",
      "detail": "View more info at developers.rinkel.com"
    }
  ]
}

List all music on hold options​

List all music on hold options