...
Requests are authenticated using DIGEST authentication and SSL protected
curl --digest -k --request GET|PUT|DELETE httphttps://localhost{user}:{password}@localhost:8085/mailbox/{mailbox}/{request}
To test the service with curl use:General URL structure: httphttps://{user}:{password}@localhost:8085/mailbox/{mailbox}
Common prefix: {mailbox} is the mailbox to work with. The mailbox of a user is the user's main <username> as found in validusers.xml
...
Provides the ability to query the status of, and update the Message Waiting Indicators associated with a mailbox
/mwi PUT (no body) Updates the MWI for this mailbox (i.e. tells the status server
to update the MWI status of devices that subscribed to MWI for this
mailbox.
GET Returns the MWI status for this mailbox.
Returns the status in [http://www.ietf.org/rfc/rfc3842.txt RFC-3842] format with
Content-Type set to application/simple-message-summary
Example
| Code Block |
|---|
To get the MWI status for User 200, do this: |
...
curl --digest -k |
...
--request GET https:// |
...
200:123@localhost:8085/mailbox/200/mwi |
...
The response looks like: |
...
Messages-Waiting: no |
...
Voice-Message: 0/3 (0/0) |
Messages Services
Provides the ability to query the status of, and mark a message as heard/unheard.
...
/messages/{messageid} where {messageid} is the unique message ID for the message, an 8 digit number.
/heard 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 Marks the message unheard (and updates MWI)
/delete
PUT (no body) Moves the message to Trash folder
Example
| Code Block |
|---|
To mark User 202's message 00000080 as heard, do this: |
...
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 |
Preferences Services
Provides the ability to query and set the value of the User's Active Voicemail Greeting type.
...
where {value} is one of none, standard, outofoffice, extendedabsence out of office, extended absence
GET returns the active greeting (returns above fragment)
DELETE sets the active greeting to "none"
Example
| Code Block |
|---|
To query User |
...
200's active greeting preference, do this: |
...
curl --digest -k |
...
--request GET https:// |
...
200:123@localhost:8085/mailbox/ |
...
200/preferences/activegreeting |
...
The response looks like: |
...
standard
|