API : PBX : Voicemail to e-mail list
- Introduction
- Request
  - Query examples
- Response
  - Example
  - Errors

API : PBX : Voicemail to e-mail list

Introduction

A voicemail to e-mail item is a shared answering machine in the dialplan. The caller hears the item's startAudio (if set) followed by a beep, and leaves a message of up to 5 minutes - # or 10 seconds of silence ends it. When the message has been left, the call ends. The message is e-mailed to the item's emails with the message attached as MP3. A message of 1 second or less is not sent.

Nothing is kept: no voicemail is stored, and the message is deleted as soon as the e-mail has been sent. So the e-mail is the only copy of the message. Use it where messages shall go to a shared mailbox, without creating an employee and an extension to own a voicemail box.

With transcribe the message can also be transcribed (TRANSCRIBE), or transcribed and summarized by AI (TRANSCRIBE_AND_SUMMARIZE). The e-mail then holds the transcription and the AI summary with calendar events (also attached as .ics files) and a warning when the content is confidential or sensitive. This is paid from the customer's AI allowance. When the allowance is used up, or the transcription fails, the e-mail is sent anyway - without the transcription or summary, and saying why. The e-mail and the summary are written in English when the PBX default language is English, otherwise in Danish. The e-mail is the message template voicemailToEmail, see Message templates.

An item without e-mail addresses - e.g. one just created in the visual dialplan editor - rejects calls until an address is set.

Request

This request returns a list of all of the customers voicemail to e-mail items.

URL	https://api.telecomx.dk/pbx/voicemailtoemail
Method	GET
Access level	VIEWER, MANAGER, OWNER if voicemail to e-mail items belongs to the customer, RESELLER if customer belongs to the reseller, RESELLER_ADMIN or ADMIN.
Query	offset	`[optional]` Index of the first item to return, default 0.
	limit	`[optional]` The number of items to return, default 50, min 1, max 1000.
	filter	`[optional]` Search query that will match against searchable fields - name, number, redirect, notes and the e-mail addresses.
	customer	`[optional]` Id of customer to show voicemail to e-mail items for. Defaults to the users own customer if not specified.
	sort	`[optional]` Which property to sort result by: number (default), name, redirect.

Query examples

https://api.telecomx.dk/pbx/voicemailtoemail
https://api.telecomx.dk/pbx/voicemailtoemail?customer=123458789012457890ABCD
https://api.telecomx.dk/pbx/voicemailtoemail?customer=123458789012457890ABCD&limit=20&offset=100
https://api.telecomx.dk/pbx/voicemailtoemail?filter=kundeservice

Response

JSON object
Property	Type	Description
offset	Number	Index of the first voicemail to e-mail item returned.
limit	Number	Number of voicemail to e-mail items to return. Note that the actual number of returned items may be lower.
total	Number	Number of voicemail to e-mail items that can be returned when offset and limit is not considered. This is to be used for paging through the data.
voicemailToEmails	Array	List of voicemail to e-mail items, see definition below.

Voicemail to e-mail object
Property	Type	Description
_id	Id	Unique id of the voicemail to e-mail item.
type	String	Always 'VOICEMAIL_TO_EMAIL'.
customer	Id	Id of the customer the voicemail to e-mail item belongs to.
name	String	Name/description of the voicemail to e-mail item. Used as the sender name and in the subject of the e-mail.
number	String	The phone number to dial to reach this voicemail to e-mail item locally, null if it is not dial-able.
startAudio	Id	A PBX audio item to playback before the beep. Null for just the beep.
startAudioUrl	String	Signed download URL of the audio (MP3), when the user may download it - see Signed file URLs.
redirect	String	Number to redirect to when execution starts. Used to quickly circumvent the voicemail to e-mail item.
notes	String	Notes about the voicemail to e-mail item.
emails	Array	E-mail addresses (strings) the messages are sent to, at most 10. Trimmed, lower-cased and without duplicates when saved. Empty until configured.
transcribe	String	What the e-mail holds besides the message: DISABLED - only the message (default). TRANSCRIBE - also a transcription. TRANSCRIBE_AND_SUMMARIZE - also a transcription and an AI summary. Paid from the customer's AI allowance.
x	Number	X position in visual dialplan.
y	Number	Y position in visual dialplan.

Example

{
  offset: 0,
  limit: 50,
  total: 2,
  voicemailToEmails: [
    {
      _id: '12345678901234567890FEED',
      type: 'VOICEMAIL_TO_EMAIL',
      customer: '12345678901234567890ABCD',
      name: 'Kundeservice',
      number: '8890',
      startAudio: '12345678901234567890AAAA',
      redirect: '',
      notes: '',
      emails: [ 'kundeservice@firma.dk', 'salg@firma.dk' ],
      transcribe: 'TRANSCRIBE_AND_SUMMARIZE',
      x: 123,
      y: 456
    },
    {
      ...
    }
  ]
}

Errors

Error code	Message	Description
403	access_denied	Insufficient access level
500	internal_error	<Unspecified>

Table of Contents