Child pages
  • Voicemail Web Service
Skip to end of metadata
Go to start of metadata

All requests are authenticated using DIGEST authentication and SSL protected.

API

Base URL: https://{host name}:8085/mailbox/{user id}

URL

METHOD

Description

/mwi

PUT w/no body

Updates the MWI for this mailbox (i.e. tells the status server

 

GET

Returns the MWI status for this mailbox in RFC-3842 format.
Content-Type is set to application/simple-message-summary

/messages

GET

returns all messages in mailbox

/message/{messageid}

GET

where {messageid} is the unique message ID for the message, an 8 digit number.

/heard

PUT (no body)

Marks the message heard (and updates MWI

 

GET

returns message heard status. The body returned is the XML fragment: <heard>true|false</heard>

 

DELETE

DELETE Marks the message unheard (and updates MWI)

/delete

PUT (no body)

Moves the message to Trash folder

/preferences/activegreeting

PUT with body

<activegreeting>{value}\</activegreeting>

where {value} is one of :
none
standard
out of office
extended absence

sets the active greeting

 

GET

returns the active greeting (returns above fragment)

 

DELETE

sets the active greeting to none

Examples

Example getting voicemail messages using curl from CLI
$curl --digest -k --request GET https://200:123@localhost:8085/mailbox/200/mwi
Messages-Waiting: no
Voice-Message: 0/3 (0/0)
To mark User 200's message 00000080 as heard
$curl  --digest -k --request PUT https://200:123@localhost:8085/mailbox/200/message/00000080/heard
To delete a message
$curl --digest -k --request PUT https://200:123@localhost:8085/mailbox/200/message/00000018/delete
Get all messages
$curl --digest -k --request GET https://200:123@localhost:8085/mailbox/200/messages
<message id=00000018 heard=true urgent=false folder=deleted duration=0 received=1171062204000/>
User 200's active greeting preference
$curl  --digest -k --request GET https://200:123@localhost:8085/mailbox/200/preferences/activegreeting
standard
  • No labels