Get a temporary url to stream music on hold file

This endpoint returns a temporary url (3 hours) to stream a music on hold file.

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

• 200
• 400
• 401
• 404
• 500

---

Url to play the music on hold

application/json

Schema

Example (from schema)

---

Schema

data object
url uri

{
  "data": {
    "url": "https://api.rinkel.com/audio/music-on-hold/64a7e60337ee34ea78e5325c?token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjY0YTdlNzBmNz"
  }
}

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

Unauthorized

The music on hold was not found

Internal Server Error

Loading...