This request is invoked by the PBX servers when a caller has left a new message on an employee's voicemail and the employee's voicemail.transcribe is TRANSCRIBE or TRANSCRIBE_AND_SUMMARIZE (see Employee update). The PBX has stored the message and hung up the caller; it invokes this request before it sends the e-mail about the new message.
| URL | https://api.telecomx.dk/pbx/voicemail/VOICEMAIL_ID/transcribe/auto | ||
|---|---|---|---|
| Method | GET | ||
| Access level | None - may only be invoked from PBX server IP addresses. | ||
| Param | VOICEMAIL_ID | Id | Id of the new message (24 hex-char string). |
https://api.telecomx.dk/pbx/voicemail/12345678901234567890AAAA/transcribe/auto
| JSON object | ||
|---|---|---|
| success | Boolean | True on success. |
| transcribe | String | The employee's voicemail.transcribe: DISABLED, TRANSCRIBE or TRANSCRIBE_AND_SUMMARIZE. With DISABLED nothing is done. |
| emailed | Boolean | True when the API has sent the e-mail about the new message. False when the PBX shall send its own. |
{ success: true, transcribe: 'TRANSCRIBE_AND_SUMMARIZE', emailed: true }
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Not invoked from a PBX server |
| 404 | not_found | Voicemail not found |
| 404 | employee | Employee not found |
| 422 | id | Invalid ObjectId |
| 500 | internal_error | <Unspecified> |