ExoVoIPManuale sviluppatori

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"}'
  • Cartelle: INBOX (nuovi), Old (ascoltati), Urgent. Spostare un messaggio in Old equivale 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/audio restituisce l'audio (WAV o MP3), .../transcript la trascrizione, .../meta i dati completi.
  • POST .../messages/:messageId/email invia 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

DescrizioneRichiestaScopeMetodo SDK
Impostazioni segreteria aziendaGET /v1/voicemail/settingsvoicemail:readvoicemail.getSettings() · py: voicemail.get_settings()
Modifica impostazioni segreteriaPUT /v1/voicemail/settingsvoicemail:writevoicemail.setSettings() · py: voicemail.set_settings()
Caselle segreteriaGET /v1/voicemail/boxesvoicemail:readvoicemail.listBoxes() · py: voicemail.list_boxes()
Casella di un internoGET /v1/voicemail/boxes/:extensionIdvoicemail:readvoicemail.getBox() · py: voicemail.get_box()
Modifica casellaPUT /v1/voicemail/boxes/:extensionIdvoicemail:writevoicemail.updateBox() · py: voicemail.update_box()
Messaggi in segreteriaGET /v1/voicemail/boxes/:extensionId/messagesvoicemail:readvoicemail.listMessages() · py: voicemail.list_messages()
Ascolto messaggio (audio/wav o audio/mpeg)GET /v1/voicemail/boxes/:extensionId/messages/:messageId/audiovoicemail:readvoicemail.messageAudio() · py: voicemail.message_audio()
Sposta messaggio (letto/archiviato)PATCH /v1/voicemail/boxes/:extensionId/messages/:messageIdvoicemail:writevoicemail.updateMessage() · py: voicemail.update_message()
Elimina messaggioDELETE /v1/voicemail/boxes/:extensionId/messages/:messageIdvoicemail:writevoicemail.deleteMessage() · py: voicemail.delete_message()
Nome in rubrica, stato trascrizione ed emailGET /v1/voicemail/boxes/:extensionId/messages/:messageId/metavoicemail:readvoicemail.messageMeta() · py: voicemail.message_meta()
Trascrizione del messaggioGET /v1/voicemail/boxes/:extensionId/messages/:messageId/transcriptvoicemail:readvoicemail.messageTranscript() · py: voicemail.message_transcript()
Richiede la trascrizione del messaggioPOST /v1/voicemail/boxes/:extensionId/messages/:messageId/transcribevoicemail:writevoicemail.transcribeMessage() · py: voicemail.transcribe_message()
Reinvia l’email con audio e trascrizionePOST /v1/voicemail/boxes/:extensionId/messages/:messageId/emailvoicemail:writevoicemail.resendEmail() · py: voicemail.resend_email()