Message Waiting Indicator (MWI) Settings API
Listing All MWIs
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
Listing Details of a Specific MWI
|
The following is the response from the above *GET* request and the actual response will depend upon the information given by you:
|
|
JSON Example
|
|
Create a New MWI
The mandatory fields for creation of a MWI are DisplayName, MediaSwitchObjectId, and MWIExtension. URI for getting MediaswitchObjectId:
|
|
|
The following is the response from the above *POST* request and the actual response will depend upon the information given by you:
|
JSON Example:
To create MWI
|
|
Update a MWI
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
JSON Example:
To Update MWI
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Delete a MWI
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
JSON Example
|
The following is the response from the above *DELETE* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
Field Name | Data Type | Operations | Description |
---|---|---|---|
Active | Boolean | Read/Write | Flag indicate whether MWI is enabled or
not.
Possible values:
Default value: false (except the default MWI) |
Display Name | String(64) | Read/Write | The unique text name of this notification MWI to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, "Office Phone" or " Lab Phone". |
MwiExtension | String | Read/Write | The phone number (extension) of the MWI to activate.NULL means use the subscriber's extension. |
MediaSwitchObjectId | String(36) | Read/Write | The unique identifier of the MediaSwitch object to use for activating/deactivating the MWI. |
MwiOn | Boolean | Read/Write | A flag indicating whether the MWI is on or
off. This is the state of the MWI from the perspective of Cisco Unity
Connection.
Possible values:
Default value: false |
UsePrimaryExtension | Boolean | Read/Write | A flag indicating that the primary
extension of the subscriber should be used.
Default value: false (but its true for default MWI) |
IncludeTextMessages | Boolean | Read/Write | A flag indicating whether the MWI should be
set for a text message.
Possible values:
Default value: false |
IncludeVoiceMessages | Boolean | Read/Write | A flag indicating whether the MWI should be
set for a voice message.
Possible values: false: Do not set MWI for voice message. true: Set MWI for voice message. Default Value: true |
IncludeFaxMessages | Boolean | Read/Write | A flag indicating whether the MWI should be
set for a FAX message.
Possible values:
Default value: false |
MediaSwitchDisplayName | String | Read/Write | Name of phone system associated with the user. |
ObjectId | String(36) | Read Only | A globally unique, system-generated identifier for a MWI object. |