Cisco Unity Connection Provisioning Interface (CUPI) API -- SMTP Proxy Addresses
From DocWiki
Links to Other API pages: Cisco_Unity_Connection_APIs
| CUPI Guide Contents |
| API Overview Index of All CUPI Documentation |
Contents |
About SMTP Proxy Addresses
This page contains information on how to use the API to list SMTP Proxy Addresses.
Listing and Viewing
The following is an example of a GET that lists all <element name>:
GET http://<connection-server>/vmrest/smtpproxyaddresses
The following is the response from the above GET request:
200
OK
<?xml version="1.0" encoding="UTF-8"?>
<SmtpProxyAddresses total="2">
<SmtpProxyAddress>
<URI>/vmrest/smtpproxyaddresses/9fd21b87-1509-42f1-88ce-3f36122c68ee</URI>
<ObjectId>9fd21b87-1509-42f1-88ce-3f36122c68ee</ObjectId>
<SmtpAddress>somedude@somewhere.com</SmtpAddress>
<ObjectGlobalUserObjectId>0804bda6-953c-4271-b44a-0830c1429af2</ObjectGlobalUserObjectId>
<ObjectGlobalUserURI>/vmrest/globalusers/0804bda6-953c-4271-b44a-0830c1429af2</ObjectGlobalUserURI>
</SmtpProxyAddress>
<SmtpProxyAddress>
<URI>/vmrest/smtpproxyaddresses/fc107ad8-b9e5-409e-b0bc-62e295c7532e</URI>
<ObjectId>fc107ad8-b9e5-409e-b0bc-62e295c7532e</ObjectId>
<SmtpAddress>someotherdude@somewhereelse.com</SmtpAddress>
<ObjectGlobalUserObjectId>0804bda6-953c-4271-b44a-0830c1429af2</ObjectGlobalUserObjectId>
<ObjectGlobalUserURI>/vmrest/globalusers/0804bda6-953c-4271-b44a-0830c1429af2</ObjectGlobalUserURI>
</SmtpProxyAddress>
</SmtpProxyAddresses>
To retrieve a sorted list of all SMTP Proxy Addresses, add the following query parameter: sort=(column [asc | desc])
For example, to retrieve a list of all SMTP Proxy Addresses sorted by SMTP Address in ascending order:
GET http://<connection-server>vmrest/smtpproxyaddresses?sort=(smtpaddress%20asc)
To retrieve a specific SMTP Proxy Address by its object ID:
GET http://<connection-server>/vmrest/smtpproxyaddresses/<objectid>
An SMTP Proxy Address can belong to one of four different objects: a global user, a contact, a distribution list, or a private list. In the above example, both SMTP Proxy Addresses belong to a user because ObjectGlobalUserObjectId property is set. The SMTP Proxy Address belongs to a contact if the ObjectContactObjectId property is set, a distribution list if the ObjectDistributionListObjectId property is set, or a private list if the ObjectPersonalGroupObjectId is set.
Searching
To retrieve a list of SMTP Proxy Addresses that meet a specified search criteria, add the following query parameter to a GET: query=(column [is | startswith] value)
For example, to find all SMTP Proxy Addresses with an SMTP Address that starts with "a":
GET http://<connection-server>/vmrest/smtpproxyaddresses?query=(smtpaddress%20startswith%20a)
The following properties can be used for searching and sorting SMTP Proxy Addresses:
- SmtpAddress
- ObjectId
- ObjectContactObjectId
- ObjectDistributionListObjectId
- ObjectGlobalUserObjectId
- ObjectPersonalGroupObjectId
