api:pbx:recording:email
Table of Contents
API : PBX : Recording E-mail
Request
This request is used to send a recording to an e-mail recipient as a user friendly HTML e-mail.
The e-mail contains, in this order and only when present on the recording:
- A warning box at the top when the AI sensitivity level is not NORMAL.
- The AI summary, formatted for easy reading.
- The calendar events found by the AI, each with an “add to Google Calendar” link and attached to the e-mail as an .ics calendar file.
- The sensitivity level and the reasons the AI chose it, when the level is not NORMAL.
- The recording attached as MP3 - or a link to the portal when the estimated file size exceeds the senders maximum attachment size (recording.notification.maxSize on the employee, 0 = no limit).
- The transcription, folded and expanded by the click of a button (e-mail clients without support for folding show it expanded).
The e-mail is written in the senders language (Danish or English) and sent with the senders name. A caller with a secret number (privacy) is shown as a hidden number - “Hemmeligt nummer” / “Hidden number” - whoever sends the e-mail: the e-mail leaves the platform, so the senders access level does not disclose it. The AI summary is built the same way, so it never contains the number or name of such a caller either.
| URL | https://api.telecomx.dk/pbx/recording/RECORDING_ID/email | ||
|---|---|---|---|
| Method | GET | ||
| Access level | PERSONAL, VIEWER, MANAGER, OWNER, RESELLER or ADMIN. PERSONAL may only access own recordings. | ||
| Params | RECORDING_ID | String | Id of recording to e-mail. |
| Query | String | E-mail address to send the recording to. | |
Query examples
https://api.telecomx.dk/pbx/recording/1234578901234567890ABCD/email?email=donald.duck@disney.com
Response
| JSON object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | not_found | Recording not found |
| 403 | access_denied | Insufficient access level |
| 422 | E-mail address is invalid | |
| 500 | internal_error | <Unspecified> |
api/pbx/recording/email.txt · Last modified: by Per Møller