api:pbx:voicemail:read
Table of Contents
API : PBX : Voicemail Read
Request
This request will mark a voicemail as read (listened to).
| URL | https://api.telecomx.dk/pbx/voicemail/VOICEMAIL_ID/read | |
|---|---|---|
| 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/read
Response
| JSON object | ||
|---|---|---|
| _id | Id | Unique id of the voicemail |
| 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. |
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 }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | not_found | Voicemail not found |
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/voicemail/read.txt · Last modified: 2021/05/06 22:48 by Per Møller