Cisco Unity Connection Provisioning Interface (CUPI) API -- SmtpProxyAddress API

From DocWiki

Jump to: navigation, search

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All End Users CUPI Documentation

Contents


SMTP Proxy Address API

Listing the SMTP proxy Address

This request can be used to get list of SMTP proxy addresses for an end user.

GET http://<connection-server>/vmrest/user/smtpproxyaddresses 

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

<SmtpProxyAddresses>
  <SmtpProxyAddress>
  <URI>/vmrest/user/smtpproxyaddresses/9fd21b87-1509-42f1-88ce-3f36122c68ee</URI>
  <ObjectId>9fd21b87-1509-42f1-88ce-3f36122c68ee</ObjectId>
  <SmtpAddress>somedude@somewhere.com</SmtpAddress>
  </SmtpProxyAddress>
  <SmtpProxyAddress>
  <URI>/vmrest/user/smtpproxyaddresses/fc107ad8-b9e5-409e-b0bc-62e295c7532e</URI>
  <ObjectId>fc107ad8-b9e5-409e-b0bc-62e295c7532e</ObjectId>
  <SmtpAddress>someotherdude@somewhereelse.com</SmtpAddress>
  </SmtpProxyAddress>
</SmtpProxyAddresses> 
Response Code: 200


Listing Details of Specific SMTP Proxy Address of an End User

GET http://<connection-server>/vmrest/user/smtpproxyaddresses/<smtpproxyaddress-objectid> 

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

<SmtpProxyAddress>
  <URI>/vmrest/user/smtpproxyaddresses/9fd21b87-1509-42f1-88ce-3f36122c68ee</URI>
  <ObjectId>9fd21b87-1509-42f1-88ce-3f36122c68ee</ObjectId>
  <SmtpAddress>john@texoma.com</SmtpAddress>
</SmtpProxyAddress>
Response Code: 200

JSON Example

GET http://<connection-server>/vmrest/user/smtpproxyaddresses/<smtpproxyaddress-objectid> 
Accept: application/json 
Content-type: 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:

{
  "URI": "/vmrest/user/smtpproxyaddresses/9fd21b87-1509-42f1-88ce-3f36122c68ee",
  "ObjectId": "9fd21b87-1509-42f1-88ce-3f36122c68ee",
  "SmtpAddress": john@texoma.com
}
Response Code: 200


Explanation of Data Fields

Parameter Operations Data Type Comments
URI Read Only String URI of the SMTP Proxy Address for the end user
ObjectId Read Only String(36) Unique identifier of the SMTP Proxy Address for the end user.
SmtpAddress Read Only String SMTP Proxy Address belonging to the end user

Rating: 0.0/5 (0 votes cast)

Personal tools