Cisco Unity Connection Provisioning Interface (CUPI) API -- User Send Message Settings

From DocWiki

Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


Send Message Settings API

Listing the Send Message Settings

The following URI can be used to get the Send Message Settings API of user:

GET https://<connection-server>/vmrest/users/<user-objectid>

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

<User>
  <AddressMode>0</AddressMode>
  <SendBroadcastMsg>true</SendBroadcastMsg>
  <UpdateBroadcastMsg>true</UpdateBroadcastMsg>
  <NameConfirmation>false</NameConfirmation>
  <ContinuousAddMode>false</ContinuousAddMode>
  <SendMessageOnHangup>2</SendMessageOnHangup>
</User>
Response Code: 200

JSON Example

GET https://<connection-server>/vmrest/users/<user-objectid>
Accept: application/json
Connection: keep-alive

The following is the response from the above *GET* request and the actual response will depend upon the information given by you:

{
  “AddressMode”: “0”
  “SendBroadcastMsg”: “true”
  “UpdateBroadcastMsg”: “true”
  “NameConfirmation”: “false”
  “ContinuousAddMode”: “false”
  “SendMessageOnHangup”: “2”
}
Response Code: 200

Update Send Message Settings

PUT https://<connection-server>/vmrest/users/<user-objectid>
<User>
  <AddressMode>0</AddressMode>
  <SendBroadcastMsg>true</SendBroadcastMsg>
  <UpdateBroadcastMsg>true</UpdateBroadcastMsg>
  <NameConfirmation>false</NameConfirmation>
  <ContinuousAddMode>false</ContinuousAddMode>
  <SendMessageOnHangup>2</SendMessageOnHangup>
</User>

The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204

JSON Example

PUT https://<connection-server>/vmrest/users/<user-objectid>
Accept: application/json
Content-type: application/json
Connection: keep-alive
{
  "AddressMode":"2",
  "UpdateBroadcastMsg":"true"
}

The following is the response from the above *PUT* request and the actual response will depend upon the information given by you:

Response Code: 204


Explanation of Data Fields

Parameters Data Type Operation Description
SendBroadcastMsg Boolean Read/Write User can send broadcast messages to users on this server.

Possible values:

  • false: Cannot send broadcast messages.
  • true: Can send broadcast messages. Default value: false
UpdateBroadcastMsg Boolean Read/Write User can update broadcast messages stored on this server.

Possible Values:

  • false: Cannot update broadcast messages.
  • true: Can update broadcast messages.

Default value: false

AddressMode Integer Read/Write The default method the subscriber will use to address messages to other subscribers.

Possible Values:

  • 0: Spelling the last name then first name
  • 1: Entering the extension
  • 2: Spelling the first name then last name

Default Value: 0

NameConfirmation Boolean Read/Write Confirm recipient by name.

Possible Values:

  • false: No voice name played.
  • true: Voice name of subscriber or DL is played.

Default value: false

ContinuousAddMode Boolean Read/Write Continue adding names after each recipient.

Possible Values:

  • false: Unity Connection prompts subscribers to press 1 to add more recipients.
  • true: Unity Connection does not prompt subscribers to press 1 to add more recipients. Instead, subscribers continue entering recipient names or extensions (as applicable) until they indicate that they have completed addressing.

Default value: false

UseDynamicNameSearchWeight Boolean Read/Write Automatically add recipients to addressing priority list.

Possible values:

  • true
  • false

Default value: false

EnableSaveDraft Boolean Read/Write Allow users to save draft messages.

Possible values:

  • false: Do not save draft messages.
  • true: Save draft messages.

Default value: false

RetainUrgentMessageFlag Boolean Read/Write Retain urgency flag when forwarding or replying to messages.

Possible Values:

  • false
  • true

Default Value: false

SendMessageOnHangup Integer Read/Write An enum indicating when hanging up while addressing a message that has a recording and at least one recipient, whether the message is discarded, sent or saved as a draft message if the subscriber explicitly issues the command to send the message either via DTMF or voice input.

Possible Values:

  • 1: Send Message
  • 0: Discard Message
  • 2: Save Message as Draft

Default value: 1

Rating: 0.0/5 (0 votes cast)

Personal tools