api:pbx:app:notification-send-voicemail
Table of Contents
API : PBX : APP : Notification send voicemail
Introduction
This request is invoked by PBX servers to inform app clients that voicemail status has changed.
Request
| URL | https://api.telecomx.dk/pbx/app/notification/send/voicemail | ||
|---|---|---|---|
| Method | POST | ||
| Access level | PBX servers only | ||
| Body | type | String | Type of notification: NEW - received a new voicemail OLD - a voicemail has been marked as read DELETED - voicemail has been deleted |
| employee | Id | Id of the employee the voicemail belongs to. | |
| newMessages | Number | Current number of unread voicemails. | |
| oldMessages | Number | Current number of read voicemails. | |
| messageId | String | Id of voicemail message that triggered this notification. | |
| callerNumber | String | Phone number of caller the voicemail message is from - E.164 format. Only for type NEW. | |
| callerName | String | Name of caller the voicemail message is from - if available. Only for type NEW. | |
| length | Number | Length of voicemail message in seconds. Only for type NEW. | |
Request example
{ "type": "NEW", "employee: "12345678901234567890ABCD", "newMessages": 2, "oldMessages": 0, "messageId": "1234567890123456780AAAA", "callerNumber": "+4570305050", "callerName": "Telecom X", "length": 23 }
Response
| Json object | ||
|---|---|---|
| success | Boolean | True on success |
Example
{ "success": true }
Errors
| Error code | Message | Description |
|---|---|---|
| 403 | access_denied | Insufficient access level |
| 500 | internal_error | <Unspecified> |
api/pbx/app/notification-send-voicemail.txt · Last modified: 2019/08/09 09:45 by Per Møller