api:pbx:voicemail:send
Table of Contents
API : PBX : Voicemail Send (M2M)
Request
This request is invoked by the PBX servers to e-mail a voicemail to an address - the voicemail menu uses it when the employee chooses to send the message being played to their own e-mail address.
The request is served on two URLs, …/sendToSelf (used by the voicemail menu) and …/send.
To e-mail a voicemail as a user, use Email.
| URL | https://api.telecomx.dk/pbx/voicemail/VOICEMAIL_ID/sendToSelf?email=EMAIL | ||
|---|---|---|---|
| https://api.telecomx.dk/pbx/voicemail/VOICEMAIL_ID/send?email=EMAIL | |||
| Method | GET | ||
| Access level | None - may only be invoked from PBX server IP addresses. | ||
| Param | VOICEMAIL_ID | Id | Id of the voicemail (24 hex-char string). |
| Query | String | E-mail address of the recipient. | |
Query examples
https://api.telecomx.dk/pbx/voicemail/12345678901234567890AAAA/sendToSelf?email=anna@firma.dk
Response
| JSON object | ||
|---|---|---|
| success | Boolean | True on success. |
Example
{ success: true }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Not invoked from a PBX server |
| 404 | not_found | Voicemail not found |
| 422 | E-mail address is invalid | |
| 500 | internal_error | <Unspecified> |
api/pbx/voicemail/send.txt · Last modified: by Telecom X AI