Table of Contents

API : PBX : Voicemail Get

Request

This request will return a single voicemail.

URL https://api.telecomx.dk/pbx/voicemail/VOICEMAIL_ID
Method GET
Access level PERSONAL, VIEWER, MANAGER, OWNER, RESELLER if voicemail belongs to the user or ADMIN.
Param VOICEMAIL_ID Id of the voicemail (24 hex-char string)

Query examples

https://api.telecomx.dk/pbx/voicemail/12345678901234567890AAAA

Response

JSON object
_id Id Unique id of the voicemail
_idUrl String Signed download URL of the voicemail message (MP3), when the user may download it - see Signed file URLs.
customer Id Id of the customer it belongs to.
employee Id Id of the employee it belongs to.
date Date Date and time it was received.
length Number Length in seconds.
old Boolean True if it has been listened to.
aNumber String Number of the caller, can be E.164, can be local extension.
aName String Name of the caller, if available.
aEmployee Id Id of the employee the call came from, if applicable.
transcription String Transcribed text, if made - on request (Transcribe) or automatically when the employee's voicemail.transcribe is set.
transcriptionLanguage String The language of the transcribed text.
ai Object AI summary of the message, if made - automatically when the employee's voicemail.transcribe is TRANSCRIBE_AND_SUMMARIZE.
ai.summary String The AI-generated summary of the message as plain text.
ai.sensitivityLevel String Sensitivity of the message as determined by the AI:
NORMAL - no sensitive information
CONFIDENTIAL - contains confidential information
SENSITIVE - contains personal sensitive information.
ai.sensitivityReasons Array Short texts explaining why the sensitivity level was set.
ai.events Array Calendar events extracted from the message by the AI - title, start, end, location and notes.

Example

{
  _id:'123457801234567890ABCC',
  customer: '12345678901234567890ABCD',
  employee: '12345678901234567890ABCE',
  date: '2019-01-01T00:00:00.000Z',
  length: 34,
  old: false,
  aNumber: '+4515879685',
  aName: 'Donald Duck',
  aEmployee: null,
  transcription: null,
  transcriptionLanguage: null,
  ai: null
}

Errors

Error code Message Description
404 not_found Voicemail not found
403 access_denied Insufficient access level
500 internal_error <Unspecified>