Playback Message Settings API
The following URI can be used to view the playback message settings of the specific user:
|
Edit Parameters
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Note |
To sort the message type: |
-
for new message:
<NewMessageSortOrder> 2 </NewMessageSortOrder>
-
for saved message:
<SaveMessageSortOrder> 1 </SaveMessageSortOrder>
-
for deleted message:
<DeletedMessageSortOrder> 1 </DeletedMessageSortOrder>
All the possible values for above three parameters are given in the table.
JSON Example
|
|
The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:
|
Explanation of Data Fields
Parameters | Data Type | Operation | Description |
---|---|---|---|
Volume | Integer | Read/Write | The audio volume expressed as a percentage
that Cisco Unity Connection uses to play back message. The range can vary from
0 to 100.
Possible values:
Default value: 50 |
Speed | Integer | Read/Write | The audio speed system uses to play back
messages to the subscriber. The range can vary from 0 to 200.
Default value: 100 |
SayTotalNew | Boolean | Read/Write | A flag indicating whether system announces
the total number of new messages in the subscriber mailbox.
Possible values:
Default Value: false |
SayTotalNewEmail | Boolean | Read/Write | A flag indicating whether system announces
the total number of new e-mail messages in the subscriber mailbox
Possible values:
Default Value: false |
SayTotalNewFax | Boolean | Read/Write | A flag indicating whether system announces
the total number of new fax messages in the subscriber mailbox.
Default Value: false |
SayTotalNewVoice | Boolean | Read/Write | A flag indicating whether system announces
the total number of new voice messages in the subscriber mailbox.
Default Value: true |
SayTotalReceipts | Boolean | Read/Write | A flag indicating whether system announces
the total number of new receipts in the subscriber mailbox.
Possible values:
Default Value: false |
SayTotalSaved | Boolean | Read/Write | A flag indicating whether system announces
the total number of saved messages in the subscriber mailbox.
Possible values:
Default Value: false |
SayTotalDraftMsg | Boolean | Read/Write | A flag indicating whether Cisco Unity
Connection announces the total number of draft messages in the subscriber
mailbox.
Possible values
Default Value: false |
MessageTypeMenu | Boolean | Read/Write | A flag indicating whether system plays the
message type menu when the subscriber logs on to system over the phone.
Possible values:
Default Value: false |
NewMessageStackOrder | String | Read/Write | The order in which system plays the
following types new messages:
Possible values:
|
SaveMessageOnHangup | Boolean | Read/Write | A flag indicating when hanging up while
listening to a new message, whether the message is marked new again or is
marked read.
Possible Values:
Default Value: false |
SavedMessageStackOrder | String(36) | Read/Write | The order in which system plays the
following types of saved messages:
|
NewMessageSortOrder | Integer | Read/Write | The order in which Cisco Unity Connection
will sort new messages.
Possible values:
Default Value: 1 |
SavedMessageSortOrder | Integer | Read/Write | The order in which Cisco Unity Connection
will sort saved messages..
Possible values:
Default Value: 2 |
DeleteMessageSortOrder | Integer | Read/Write | The order in which Cisco Unity Connection
presents deleted messages to the subscriber.
Possible values:
Default Value: 2 |
SaySender | Boolean | Read/Write | A flag indicating whether system announces
the sender of a message during message playback for the subscriber.
Possible values:
Default Value: true |
SaySenderExtension | Boolean | Read/Write | A flag indicating whether Cisco Unity
Connection during message playback, plays the primary extension information of
the subscriber who sent the message after playing the sender's voice name.
Possible values:
|
SayAni | Boolean | Read/Write | A flag indicating whether Cisco Unity
Connection plays the Automatic Number Identification (ANI) information during
message playback for voice messages from unidentified callers.
Possible Values:
Default value: false |
SayMsgNumber | Boolean | Read/Write | A flag indicating whether system announces
the position of each message in the stack (i.e., 'Message 1', 'Message 2'
,etc.) during message playback for the subscriber.
Possible values:
Default value: true |
SayTimestampBefore | Boolean | Read/Write | A flag indicating whether system announces
the timestamp before it plays back each for the subscriber.
Default value: false |
SayMessageLength | Boolean | Read/Write | A flag indicating whether Cisco Unity
Connection announces the length of each message during message playback.
possible values:
Default value: false |
SkipForwardTime | Integer | Read/Write | Indicates the amount of time (in
milliseconds) to jump forward when skipping ahead in a voice or TTS message
using either DTMF or voice commands while reviewing messages.
Default Value: 5000 The range can vary from 1000 to 60000. |
SkipReverseTime | Integer | Read/Write | Indicates the amount of time (in
milliseconds) to jump backward when skipping in reverse in a voice or TTS
message using either DTMF or voice commands while reviewing messages.
Default Value: 5000 The range can vary from 1000 to 60000. |
EnableMessageBookmark | Boolean | Read/Write | A flag indicating whether Message Bookmark
is enabled for the subscriber
Possible values:
Default value: false |
SaveMessageOnHangup | Boolean | Read/Write | A flag indicating when hanging up while
listening to a new message, whether the message is marked new again or is
marked read.
Default Value: false |
SaySenderAfter | Boolean | Read/Write | This flag works exactly the same as the
SaySender flag on a user, except the conversation plays the sender in the
message footer.
Possible Values:
|
SaySenderExtensionAfter | Boolean | Read/Write | This flag works exactly the same as the
SaySenderExtension flag on a user, except the conversation plays the sender's
extension in the message footer.
Possible Values:
|
SayMsgNumberAfter | Boolean | Read/Write | This flag works exactly the same as the
SayMsgNumber flag on a user, except the conversation plays the message number
in the message footer.
Possible Values:
|
SayAniAfter | Boolean | Read/Write | This flag works exactly the same as the
SayAni flag on a user, except the conversation plays the ani in the message
footer.
Possible Values:
Default value: false |
SayMessageLengthAfter | Boolean | Read/Write | This flag works exactly the same as the
SayMessageLength flag on a user, except the conversation plays the message
length in the message footer.
Possible Values:
Default value: false |
AutoAdvanceMsgs | Boolean | Read/Write | A flag indicating whether the conversation
moves to the next message in the playback stack automatically during playback
after playing the After Message Menu.
Possible Values:
Default Value: false |
ConfirmDeleteMessage | Boolean | Read/Write | A flag indicating whether system will
request confirmation from a subscriber before proceeding with a deletion of a
single new or saved message.
Default Value: false |