View or modify mailbox MWI
Resource URI: /mwi
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: GET
Returns the MWI status for this mailbox in RFC-3842 format. The content type is set to application/simple-message-summary.
Example: N/A
HTTP Method: PUT
Updates the MWI for this mailbox.
Unsupported HTTP Method: GET, POST, DELETE
View all messages
Resource URI: /messages
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:
Property | Description |
message id | Unique identification number of the message. |
heard | Displays False if the message has not been heard and True it it has already been heard.. |
urgent | Displays False if the message has not been flagged as urgent and True if it is flagged as urgent. |
folder | The folder where the message is located. Options are: Inbox, Saved, Deleted. |
duration | The duration of the call. |
contentLength | |
received | |
author | The name of the caller |
authorExtension | The extension of the caller. |
username | The username of the caller. |
format | Format type of the audio file. |
Status Values:
Specific Response Codes:
HTTP Method: GET
Returns all messages in mailbox.
Examples: XML format only
<messages>
<message id="100001038" heard="false" urgent="false" folder="inbox" duration="10" contentlength="20880" received="1387567094000" author="2014" authorExtension="2014" username="2011" format="mp3"/>
<message id="100001037" heard="false" urgent="false" folder="inbox" duration="10" contentlength="20736" received="1387566754000" author="2014" authorExtension="2014" username="2011" format="mp3"/>
<message id="100001036" heard="false" urgent="false" folder="inbox" duration="10" contentlength="20880" received="1387566688000" author="2014" authorExtension="2014" username="2011" format="mp3"/>
</messages>
cURL command to retrieve all messages:
$curl --digest -k --request GET https://200:123@<admin_host>/sipxconfig/rest/my/redirect/mailbox/200/messages
<message id=00000018 heard=true urgent=false folder=deleted duration=0 received=1171062204000/>
Unsupported HTTP Method: PUT, POST, DELETE
View or modify the Heard message status
Resource URI: /message/{messageid}/heard
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:
Property | Description |
heard | Displays False if the message has not been heard and True it it has been heard.. |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves information on user with the specified ID
Example: XML format
<heard>true|false</heard>
HTTP Method: PUT
Marks the message heard and updates MWI. A message with no body is required.
Example: To mark User 200's message 00000080 as heard
$curl --digest -k --request PUT https://200:123@<admin_host>/sipxconfig/rest/my/redirect/mailbox/200/message/00000080/heard
HTTP Method: DELETE
Marks the message unheard and updates the MWI.
Unsupported HTTP Method: POST
Delete messages
Resource URI: /message/{messageid}/delete
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: PUT
Moves the message to Trash folder. A message with no body is required.
Unsupported HTTP Method: GET, POST, DELETE
Update message subject
Resource URI: /message/{messageid}/subject
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: PUT
Updates message subject given input stream. A message with a body is required.
Unsupported HTTP Method: GET, POST, DELETE
Move messages in folders
Resource URI: /message/{messageid}/move/{folder}
Default Resource Properties: N/A
Specific Response Codes: N/A
HTTP Method: PUT
Moves the specified message into the desired folder.
Unsupported HTTP Method: GET, POST, DELETE
Mailbox active greeting
Resource URI: /preferences/activegreeting
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:
Property | Description |
activeGreeting | Values can be None, Standard, Out of office or Extended absence. |
Specific Response Codes: N/A
HTTP Method: GET
returns the active greeting (returns above fragment)
Example: XML format
<activegreeting>{standard}\</activegreeting>
User 200's active greeting preference
$curl --digest -k --request GET https://200:123@<admin_host>/sipxconfig/rest/my/redirect/mailbox/200/preferences/activegreeting
standard
TP Method: PUT
Set an active greeting. You can set the Value to None, Standard, Out of office or Extended absence.
Example:
<activegreeting>{value}\</activegreeting>
HTTP Method: DELETE
Sets the active greeting to None.
Unsupported HTTP Method: POST
View call ID
Resource URI: /uuid
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes: N/A
HTTP Method: GET
Returns the call ID of the original call.
Unsupported HTTP Method: PUT, POST, DELETE
View messages in Inbox folder
Resource URI: /inbox
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes: N/A
HTTP Method: GET
Retrieves all the voice mail messages in the Inbox folder.
Unsupported HTTP Method: PUT, POST, DELETE
View messages in Saved folder
Resource URI: /saved
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes: N/A
HTTP Method: GET
Returns all messages contained in the "saved" folder.
Unsupported HTTP Method: PUT, POST, DELETE
View messages in Deleted folder
Resource URI: /deleted
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes:
HTTP Method: GET
Returns all messages contained in the "deleted" folder.
Unsupported HTTP Method: PUT, POST, DELETE
View messages in Conference folder
Resource URI: /conference
Default Resource Properties
The resource is represented by the following properties when the GET request is performed:
Property | Description |
Specific Response Codes:
HTTP Method: GET
Returns all messages contained in the Conference folder.
Unsupported HTTP Method: PUT, POST, DELETE