Get a music on hold

Get a music on hold by its ID

Path Parameters

id string required

The ID of the music on hold to retrieve

Query Parameters

language string

The language to retrieve content in. Defaults to the user's language.

Responses

Successfully retrieved the music on hold

application/json

Schema

Example (from schema)

Schema

data object

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

{
  "data": {
    "id": "65438adbfe329346cc4af2f9",
    "name": "Guitar",
    "playUrl": "https://api.rinkel.com/music-on-hold/65438adbfe329346cc4af2f9/stream"
  }
}

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"
    }
  ]
}

Get a music on hold​

Get a music on hold