Segreteria
Caselle vocali degli interni, messaggi ricevuti, ascolto, trascrizione e invio via email. Scope voicemail:read / voicemail:write.
Messaggi
curl -s "https://centralino.exovoip.it/api/v1/voicemail/boxes/12/messages?folder=INBOX" -H "X-API-Key: $EXOPBX_API_KEY"
curl -s https://centralino.exovoip.it/api/v1/voicemail/boxes/12/messages/INBOX:3/audio -H "X-API-Key: $EXOPBX_API_KEY" -o messaggio.wav
curl -s -X PATCH https://centralino.exovoip.it/api/v1/voicemail/boxes/12/messages/INBOX:3 \
-H "X-API-Key: $EXOPBX_API_KEY" -H "Content-Type: application/json" -d '{"folder":"Old"}'const { items } = await pbx.voicemail.listMessages(12, { folder: 'INBOX' });
for (const msg of items) {
const audio = await pbx.voicemail.messageAudio(12, msg.id);
await pbx.voicemail.updateMessage(12, msg.id, { folder: 'Old' }); // segna come ascoltato
}$items = $pbx->voicemail->listMessages(12, folder: 'INBOX')['items'];
foreach ($items as $msg) {
$audio = $pbx->voicemail->messageAudio(12, $msg['id']);
$pbx->voicemail->updateMessage(12, $msg['id'], ['folder' => 'Old']);
}for msg in pbx.voicemail.list_messages(12, folder="INBOX")["items"]:
audio = pbx.voicemail.message_audio(12, msg["id"])
pbx.voicemail.update_message(12, msg["id"], {"folder": "Old"})- Cartelle:
INBOX(nuovi),Old(ascoltati),Urgent. Spostare un messaggio inOldequivale a segnarlo come ascoltato. - L'id di un messaggio ha la forma
<cartella>:<numero>(es.INBOX:3) e cambia quando il messaggio viene spostato: dopo uno spostamento rileggi la lista. GET .../messages/:messageId/audiorestituisce l'audio (WAV o MP3),.../transcriptla trascrizione,.../metai dati completi.POST .../messages/:messageId/emailinvia di nuovo il messaggio via email.
Il ruolo "utente" accede solo alla propria casella.
Caselle e impostazioni
GET /v1/voicemail/boxes: tutte le caselle con il numero di messaggi nuovi e vecchi.PUT /v1/voicemail/boxes/:extensionId: email, allegato audio, trascrizione, messaggio di benvenuto, PIN.PUT /v1/voicemail/settings: valori predefiniti dell'azienda (mittente email, durata massima, lingua).
Endpoint
| Descrizione | Richiesta | Scope | Metodo SDK |
|---|---|---|---|
| Impostazioni segreteria azienda | GET /v1/voicemail/settings | voicemail:read | voicemail.getSettings() · py: voicemail.get_settings() |
| Modifica impostazioni segreteria | PUT /v1/voicemail/settings | voicemail:write | voicemail.setSettings() · py: voicemail.set_settings() |
| Caselle segreteria | GET /v1/voicemail/boxes | voicemail:read | voicemail.listBoxes() · py: voicemail.list_boxes() |
| Casella di un interno | GET /v1/voicemail/boxes/:extensionId | voicemail:read | voicemail.getBox() · py: voicemail.get_box() |
| Modifica casella | PUT /v1/voicemail/boxes/:extensionId | voicemail:write | voicemail.updateBox() · py: voicemail.update_box() |
| Messaggi in segreteria | GET /v1/voicemail/boxes/:extensionId/messages | voicemail:read | voicemail.listMessages() · py: voicemail.list_messages() |
| Ascolto messaggio (audio/wav o audio/mpeg) | GET /v1/voicemail/boxes/:extensionId/messages/:messageId/audio | voicemail:read | voicemail.messageAudio() · py: voicemail.message_audio() |
| Sposta messaggio (letto/archiviato) | PATCH /v1/voicemail/boxes/:extensionId/messages/:messageId | voicemail:write | voicemail.updateMessage() · py: voicemail.update_message() |
| Elimina messaggio | DELETE /v1/voicemail/boxes/:extensionId/messages/:messageId | voicemail:write | voicemail.deleteMessage() · py: voicemail.delete_message() |
| Nome in rubrica, stato trascrizione ed email | GET /v1/voicemail/boxes/:extensionId/messages/:messageId/meta | voicemail:read | voicemail.messageMeta() · py: voicemail.message_meta() |
| Trascrizione del messaggio | GET /v1/voicemail/boxes/:extensionId/messages/:messageId/transcript | voicemail:read | voicemail.messageTranscript() · py: voicemail.message_transcript() |
| Richiede la trascrizione del messaggio | POST /v1/voicemail/boxes/:extensionId/messages/:messageId/transcribe | voicemail:write | voicemail.transcribeMessage() · py: voicemail.transcribe_message() |
| Reinvia l’email con audio e trascrizione | POST /v1/voicemail/boxes/:extensionId/messages/:messageId/email | voicemail:write | voicemail.resendEmail() · py: voicemail.resend_email() |
