api:mvno:voicemail:list
Table of Contents
API : MVNO : Voicemail : List
Introduction
This request will return the list of voicemails on a standalone mobile phones for a certain voicemailbox.
Request
| URL | https://api.telecomx.dk/mvno/voicemail/PHONENUMBER/PINCODE | ||
|---|---|---|---|
| Method | GET | ||
| Access level | N/A | ||
| Param | PHONENUMBER | Phonenumber in e.164 format. | |
| PINCODE | Pin code for the account. | ||
| Query | box | Mailbox to return messages from: NEW, OLD, SAVED. Default to NEW. | |
Query example
https://api.telecomx.dk/mvno/voicemail/+4571919998/1234?box=NEW
Response
| JSON Object | ||
|---|---|---|
| newCount | Number | Number of new messages. |
| oldCount | Number | Number of old messages (already listened). |
| savedCount | Number | Number of saved messages. |
| voicemails | Array | List of voicemails. |
| voicemails[]._id | Id | Unique id of the voicemail. |
| voicemails[].voiceAccount | Id | Id of the mvno account the voicemail belongs to. |
| voicemails[].customer | Id | Id of the customer the voicemail belongs to. |
| voicemails[].from | String | Phone number of the caller, in E.164 format. |
| voicemails[].fromName | String | Name of the caller, if available. |
| voicemails[].to | String | The called number, in E.164 format. |
| voicemails[].callId | String | Call-ID for call identification. |
| voicemails[].date | Date | Date and time the voicemail was received. |
| voicemails[].length | Number | Length of the voicemail in seconds. |
| voicemails[].box | String | Box the voicemail is in: INBOX or SAVED. |
| voicemails[].played | Boolean | True if the messages has been played (listened to). |
Example
{ "newCount": 2, "oldCount": 0, "savedCount": 10, "voicemails": [ { "_id": "12345678901234567890BBBB", "voiceAccount": "123457890123457890AAAA", "customer": "12345678901234567890ABCD", "from": "+4599778822", "fromName": "Donald Duck", "to": "+4571919998", "callId": "cu3848vi34jf03hf9ejhfnihw3ihfnnefu93h9r9tg", "date": "2024-01-01T00:00:00.000Z", "length": 37, "box": "INBOX", "played": false }, { ... } ] }
Errors
| Error code | Message | Description |
|---|---|---|
| 404 | id | Not found |
| 404 | pin | Not found |
| 403 | number | Voicemail not enabled for this number |
| 403 | pin | Login via pin disabled due to multiple failed logins |
| 422 | pin | Pin code is invalid |
| 500 | internal_error | <Unspecified> |
api/mvno/voicemail/list.txt · Last modified: 2024/04/02 08:42 by Per Møller