Skip to content

ExoVoIPDeveloper guide

Music on hold

Music on hold classes define what callers hear while queued, on hold or during a transfer: tracks and periodic announcements. Scopes media:read / media:write.

Creating a class

curl -s -X POST https://centralino.exovoip.it/api/v1/moh \
  -H "X-API-Key: $EXOPBX_API_KEY" -H "Content-Type: application/json" \
  -d '{"name":"Musica aziendale","source":"upload","trackPromptIds":[41,42],"shuffle":true,
       "announcePromptIds":[43],"announceEveryS":45}'

await pbx.moh.create({
  name: 'Musica aziendale',
  source: 'upload',
  trackPromptIds: [41, 42],
  shuffle: true,
  announcePromptIds: [43],
  announceEveryS: 45,
});

$pbx->moh->create([
    'name' => 'Musica aziendale',
    'source' => 'upload',
    'trackPromptIds' => [41, 42],
    'shuffle' => true,
    'announcePromptIds' => [43],
    'announceEveryS' => 45,
]);

pbx.moh.create({
    "name": "Musica aziendale",
    "source": "upload",
    "trackPromptIds": [41, 42],
    "shuffle": True,
    "announcePromptIds": [43],
    "announceEveryS": 45,
})

Field	Description
`source`	`exobyte` (Exobyte collection), `library`, `upload` (uploaded tracks), `ai`
`trackPromptIds`	Uploaded tracks, in order (voice prompts of kind `moh`)
`shuffle`	Random playback
`announcePromptIds`, `announceEveryS`	Announcements played between tracks and their interval
`isDefault`	The tenant's default class

Tracks are uploaded as voice prompts with kind: "moh". The class is used in queues and ring groups (mohClassId).

Endpoints

Request	Scope	SDK method
`GET /v1/moh`	`media:read`	`moh.list()`
`POST /v1/moh`	`media:write`	`moh.create()`
`GET /v1/moh/:id`	`media:read`	`moh.get()`
`PATCH /v1/moh/:id`	`media:write`	`moh.update()`
`DELETE /v1/moh/:id`	`media:write`	`moh.delete()`