Cisco Unity Connection Provisioning Interface (CUPI) API -- Message Action Template

From DocWiki

Revision as of 09:22, 1 November 2013 by Deeptija (Talk | contribs)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation


Contents


Message Action Template

To edit a message action template, you must get the URI for message action from:

GET https://<connection server>/vmrestvmrest/usertemplates/<usertemplateobjectid>

Message action URI:

GET https://<connection 
server>/vmrestvmrest/usertemplates/<usertemplateobjectid>/usertemplatemessageactions/<usertempl
atemessageactionsobjectid>


Updating Message Actions

Request URI
PUT https://<connection server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatemessageactions/<objectid>
Request Body:
<UserTemplateMessageAction>
    <VoicemailAction>3</VoicemailAction>
    <RelayAddress>%texoma%@tenant.com</RelayAddress> 
</UserTemplateMessageAction>

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

Response Code: 204

JSON Example

To update message actions, do the following:

Request URI:
PUT https://<connection-server>/vmrest/usertemplates/<usertemplateobjectid>/usertemplatemessageactions/<objectid>
Accept: application/json
Content-type: application/json
Connection: keep-alive
Request Body:
{
    "VoicemailAction":"3"
    "RelayAddress":"texoma@tenant.com"
}

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

Note: For relay message and accept and relay message option relay address is mandatory and relay address must be correct for e.g.: tenant@cisco.com In the same way all other actions can be edited like: Voicemail Action, Email Action, Fax Action and Delivery Receipt Action


Explanation of Data Fields

Parameter Operations Data Type Comments
VoicemailAction Integer Read/Write The action to take for voicemail messages.

Values can be:

  • 0: Reject the Message
  • 1: Accept the Message
  • 2: Relay the Message
  • 3: Accept and Relay the Message

For 2 and 3, values have to provide RelayAddress.

EmailAction Integer Read/Write The action to take for email messages.

Values can be:

  • 0: Reject the Message
  • 1: Accept the Message
  • 2: Relay the Message
  • 3: Accept and Relay the Message

For 2 and 3, values have to provide RelayAddress.

FaxAction Integer Read/Write The action to take for fax messages.

Values can be:

  • 0: Reject the Message
  • 1: Accept the Message
  • 2: Relay the Message
  • 3: Accept and Relay the Message

For 2 and 3, values have to provide RelayAddress.

DeliveryReceiptAction Integer Read/Write The action to take for delivery receipt messages.

Values can be:

  • 0: Reject the Message
  • 1: Accept the Message
  • 2: Relay the Message
  • 3: Accept and Relay the Message

For 2 and 3, values have to provide RelayAddress.

RelayAddress String(320) Read/Write Select the address to which system relays voicemail, email, fax, or delivery receipts when Connection is configured to relay that message type. This field is not editable unless you have selected Relay the Message or Accept and Relay the Message as the message action for one or more message types.

Note: In order to configure Connection to relay messages, you must first configure an SMTP Smart Host on the System Settings > SMTP Configuration > Smart Host page. Enter a combination of text and tokens that Connection replaces with a value from the user profile. (For example, Connection replaces %Alias% with the alias from each user profile when editing the corresponding user.)

Rating: 0.0/5 (0 votes cast)

Personal tools