user

The user resource allows a user to access and manage their personal information. Common settings can be applied across all of a user's devices and extensions. Look for the appliesToAll attribute within the <device> and <extension> tags.

GET user

Returns detailed information about the specified user.

Note: UDS does not support user IDs containing a '/' character.

Request format

<!--display user information request-->
GET https://{host}:8443/cucm-uds/user/{userid}  
Content-Type: application/xml

Path parameters

Parameter	Description
userid	The ID of the user for which you want to retrieve information.

User authentication required.

Response format

<!--display user information response-->
<user uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt" version="12.5.1">
    <id>bd176b00-808e-8940-8d29-316e3f9443ba</id>
    <userName>dstaudt</userName>
    <firstName>David</firstName>
    <lastName>Staudt</lastName>
    <middleName></middleName>
    <nickName></nickName>
    <displayName>David Staudt</displayName>
    <emMaxLoginTime></emMaxLoginTime>
    <allowProvisionEMMaxLoginTime>false</allowProvisionEMMaxLoginTime>
    <phoneNumber>+19728135091</phoneNumber>
    <homeNumber></homeNumber>
    <mobileNumber></mobileNumber>
    <mobileConnect>true</mobileConnect>
    <remoteDestinationLimit>4</remoteDestinationLimit>
    <userLocale uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/options/installedLocales" value="" appliesToAllDevices="true">English, United States</userLocale>
    <email>dstaudt@cisco.com</email>
    <directoryUri></directoryUri>
    <msUri></msUri>
    <department></department>
    <manager></manager>
    <title></title>
    <pager></pager>
    <selfServiceId></selfServiceId>
    <accountType useLdapAuth="false">ldap</accountType>
    <homeCluster enableImAndPresence="true" enableCalendarPresence="false">true</homeCluster>
    <imAndPresence>
        <server>10.194.104.88</server>
    </imAndPresence>
    <callForwardAllDestination appliesToAllExtensions="true">
        <sendToVoiceMailPilotNumber>false</sendToVoiceMailPilotNumber>
        <destination></destination>
    </callForwardAllDestination>
    <enableDoNotDisturb appliesToAllDevices="true">false</enableDoNotDisturb>
    <serviceProfile>
        <uri>http://10.194.104.89:6970/SPDefault.cnf.xml</uri>
    </serviceProfile>
    <jabberProfile/>
    <devices uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt/devices"/>
    <credentials uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt/credentials"/>
    <extensions uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt/extensions"/>
    <subscribedServices uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt/subscribedServices"/>
    <speedDials uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt/speedDials"/>
</user>

<jabberProfile> is present in CUCM v12.5(1)+

PUT user

Allows the user to modify their personal information.

UDS allows PUT requests only when <homeCluster> is true for the user.

Request format

<!--update user information request-->
PUT https://{host}:8443/cucm-uds/user/{userid}  
Accept: application/xml  
Content-Type: application/xml

Path parameters

Parameter	Description
userid	The ID of the user whose information is to be modified.

User authentication required.

Request body

<!--update user information request body-->
<user>
   <primaryExtension>
      <callForwardAllDestination>
         <sendToVoiceMailPilotNumber>true|false</sendToVoiceMailPilotNumber>
         <destination>673285</destination>
      </callForwardAllDestination>
      <messageWaitingVisualAlertPreference>0</messageWaitingVisualAlertPreference>
      <messageWaitingAudibleAlertPreference>0</messageWaitingAudibleAlertPreference>
      <onACallRingPreference>0</onACallRingPreference>
      <notOnACallRingPreference>0</notOnACallRingPreference>
   </primaryExtension>
   <userLocale appliesToAllDevices="true|false">0</userLocale>
   <enableCalendarPresence>true|false</enableCalendarPresence>
   <enableDoNotDisturb>true|false</enableDoNotDisturb>
   <callForwardAllDestination>
      <sendToVoiceMailPilotNumber>true|false</sendToVoiceMailPilotNumber>
      <destination>43521</destination>
   </callForwardAllDestination>
   <logMissedCalls>true|false</logMissedCalls>
</user>

All fields are optional.
If <sendToVoiceMailPilotNumber> is false, then the call will be forwarded to the <destination> number, if present.

Note: The <displayName> element can be updated in versions 11.5(1)+ only

Response format

The response is identical to the corresponding GET method.

conferencing

The conferencing resource allows users to access and update their Conference Now access codes.

GET conferencing

Request format

<!--conferencing GET request-->
GET https://{host}:8443/cucm-uds/user/{userId}/conferencing
Accept: application/xml  
Content-Type: application/xml

Parth parameters

Parameter	Description
userId	The ID of the user whose credentials are to be updated.

User authentication required.

Example response

<!--conferencing GET example response-->
<?xml version="1.0" encoding="UTF-8"?>
<conferencing uri="https://{hostname}/cucm-uds/user/{userid}/conferencing" version="11.0.0">
   <conferenceNow>
      <enabled>true</enabled>
      <accessCode>1234</accessCode>
   </conferenceNow>
</conferencing>

PUT conferencing

Request format

<!--conferencing PUT request-->
PUT https://{host}:8443/cucm-uds/user/{userId}/conferencing
Accept: application/xml  
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user whose credentials are to be updated.

User authentication required.

Request body

<!--conferencing PUT request body-->
<?xml version="1.0" encoding="UTF-8"?>
<conferencing>
   <conferenceNow>
      <enabled>true</enabled>
      <accessCode>9876</accessCode>
   </conferenceNow>
</conferencing>

Example response

<!--conferencing PUT example response-->
<?xml version="1.0" encoding="UTF-8"?>
<conferencing uri="https://{hostname}/cucm-uds/user/{userid}/conferencing" version="11.0.0">
   <conferenceNow>
      <enabled>true</enabled>
      <accessCode>9876</accessCode>
   </conferenceNow>
</conferencing>

credentials

The credentials resource provides the ability to update the user’s credential information via the PUT method, which consists of either a password or PIN number.

The GET method allows users to retrieve the last successful login-time/IP-address, and the number of unsuccessful login attempts

Get credentials

Request format

<!--credentials GET request-->
GET https://{host}:8443/cucm-uds/user/{userId}/credentials  
Accept: application/xml  
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user whose credentials are to be updated.

User authentication required.

Example response

<!--credentials GET response-->
<credentials uri="https://{hostname}/cucm-uds/user/{userid}/conferencing" version="11.0.0">
    <credential>
        <loginDetails>
            <lastSuccessfulLogin>2015-04-17T19:36:42.000Z</lastSuccessfulLogin>
            <lastSuccessfulLoginIp>172.30.223.139</lastSuccessfulLoginIp>
       </loginDetails>
       <loginFailures>0</loginFailures>
    </credential>
</credentials>

PUT credentials

Request format

<!--PUT credentials request-->
PUT https://{host}:8443/cucm-uds/user/{userId}/credentials  
Accept: application/xml  
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user whose credentials are to be updated.

User authentication required.

Request body

<!--credentials PUT request body-->
<credentials>
   <credential type="password">1234</credential>
   <credential type="pin">4321</credential>
</credentials>

At least one credentials element is required.

Note that the password type credential for users authenticated via LDAP cannot be updated. See the GET /user/ response and the <accountType useLdapAuth=true|false> attribute.

No response content is provided (HTTP 204).

devices

The devices resource returns an unordered list of devices associated to the user.

If the user has entered information into the description field for a device, it is returned with this call. Otherwise, it returns the default description as set by the administrator.

GET devices

Request format

<!--devices request-->
GET https://{host}:8443/cucm-uds/user/{userId}/devices
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The user whose device information you want to retrieve.

Query string parameters

Parameter	Description
model	Filter list results by phone model. `https://{host}:8443/cucm-uds/user/{userid}/devices?model="Cisco 7965"`

User authentication required.

Response format

<!--devices response-->
<devices uri="https://{host}/cucm-uds/user/{userId}/devices" version="10.0.0">
  <device uri="https://{host}/cucm-uds/user/{userId}/device/2a610c78-6754-2c56-bd4d-5a8d972c7a43">
    <id>2a610c78-6754-2c56-bd4d-5a8d972c7a43</id>
    <name>SEP00DEADBEEF01</name>
    <type>Phone</type>
    <model>Cisco 7965</model>
    <description editable="true">SEP00DEADBEEF01</description>
    <protocol>SCCP</protocol>
  </device>
  <device uri="https://{host}/cucm-uds/user/{userId}/device/5ebe75fb-43ac-b458-5539-bc57806a4d19">
    <id>5ebe75fb-43ac-b458-5539-bc57806a4d19</id>
    <name>SEP00DEADBEEF05</name>
    <type>Phone</type>
    <model>Cisco 7965</model>
    <description editable="true">SEP00DEADBEEF05</description>
    <protocol>SCCP</protocol>
  </device>
  <device uri="https://{host}/cucm-uds/user/{userId}/device/61d8d4f9-aa7e-698f-7f46-263be7e44d69">
    <id>61d8d4f9-aa7e-698f-7f46-263be7e44d69</id>
    <name>SEP00DEADBEEF03</name>
    <type>Phone</type>
    <model>Cisco 7965</model>
    <description editable="true">SEP00DEADBEEF03</description>
    <protocol>SCCP</protocol>
  </device>
</devices>

A description set by the user takes precedence over the description set by the administrator.

extensions

The extensions resource returns a listing of all of the extension information from the associated user. Note the following:

` is a field whose value is set by the user. It is not an administrator field.
If the user has a primary extension, it is listed first.
For client devices, having <sendToVoiceMailPilotNumber> set to true takes precedence over the setting in <callForwardAllDestination>.

GET extensions

Request format

<!--extensions request-->
GET https://{host}:8443/cucm-uds/user/{userid}/extensions
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user whose extension information is to be retrieved.

User authentication required.

Response format

<!--extensions response-->
<extensions version="10.0.0" uri="https://{host}:8443/cucm-uds/user/{userId}/extensions">
   <extension isPrimary="false" uri="https://{host}:8443/cucm-uds/user/{userId}/extension/0d896090-483e-f472-065b-aa2163fc6efa">
      <id>0d896090-483e-f472-065b-aa2163fc6efa</id>
      <directoryNumber>1111</directoryNumber>
      <voiceMailPilotNumber />
      <callForwardAllDestination>
         <sendToVoiceMailPilotNumber>false</sendToVoiceMailPilotNumber>
         <sendToCustomDestination>5555</sendToCustomDestination>
      </callForwardAllDestination>
      <messageWaitingVisualAlert>false</messageWaitingVisualAlert>
      <messageWaitingVisualAlertPreference appliesToAllLineAppearances="true" value="">Use System Policy</messageWaitingVisualAlertPreference>
      <messageWaitingAudibleAlertPreference appliesToAllLineAppearances="true" value="">Default</messageWaitingAudibleAlertPreference>
      <onACallRingPreference appliesToAllLineAppearances="true" value="">Use System Default</onACallRingPreference>
      <notOnACallRingPreference appliesToAllLineAppearances="true" value="">Use System Default</notOnACallRingPreference>
      <label appliesToAllLineAppearances="true" />
      <logMissedCalls appliesToAllLineAppearances="true">true</logMissedCalls>
   </extension>
   ...
</extensions>

remoteDestinations

The remoteDestinations resource lists the configuration of how calls are transferred to another destination device, which could be a mobile device that has Cisco Mobility Client installed. The remoteDestinations resource obtains information about all of the user;s remote destination device configurations.

There are four scenarios:

Dual mode
Remote Destination Profile (RDP) only
CTI Remote Device only
RDP and CTI Remote Device share the same destination

Each scenario has a slightly different response. See the example response section for more information.

Note: This resource does not provide results if the user does not any remote destinations configured.

Get remoteDestinations

Request format

<!--remoteDestinations request-->
GET https://{host}:8443/cucm-uds/user/{userId}/remoteDestinations
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The user whose remote destination configuration information you want to retrieve.

User authentication required.

Response format

<!--GET remoteDestinations response-->
<remoteDestinations version="12.5.1" uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt/remoteDestinations">
    <remoteDestination uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt/remoteDestination/b8946bc5-2e67-9f03-2c9e-c07d25b80c63">
        <id>b8946bc5-2e67-9f03-2c9e-c07d25b80c63</id>
        <name>testRemoteDestination</name>
        <destination>4055551212</destination>
        <ringWhenExtensionDialed>true</ringWhenExtensionDialed>
        <allowTransferToMobile>true</allowTransferToMobile>
        <allowControlFromApplication>false</allowControlFromApplication>
        <associatedDevices>
            <associatedDevice>
                <usage uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/options/remoteDestinationUsage" value="0">Single Number Reach</usage>
                <name>testRemoteDestinationProfile</name>
                <description></description>
                <model>Remote Destination Profile</model>
            </associatedDevice>
        </associatedDevices>
    </remoteDestination>
</remoteDestinations>

<model> is present in CUCM v12.0(1)+

remoteDestination

The remoteDestination resource manages the configuration of how calls are transferred to another destination device, which could be a mobile device. This resources allows users to read/add/modify individual remoteDestinations.

Note: The user must already have a remote destination profile or a CTI remote device configured in UCM to use this resource.

GET remoteDestination

Returns detailed configuration information about the remote destination device, including a weekly schedule of calls that are to be transferred to the remote destination. For the weekly schedule, if:

A day is not present, then the remote device is not enabled for that day.
For a <timeOfDayStart> value of 00:00 and a <timeOfDayEnd> value of 24:00, this equates to "all day". No special tag is used to specify this interval.

Request format

<!--get remoteDestination for a device request-->
GET https://{host}:8443/cucm-uds/user/{userId}/remoteDestination/{remoteDestinationPkid}
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The user whose remote destination device information you want to retrieve.
remoteDestinationPkid	The ID of the remote destination device.

User authentication required.

Response format

<!--GET remoteDestination response-->
    <remoteDestination uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/user/dstaudt/remoteDestination/b8946bc5-2e67-9f03-2c9e-c07d25b80c63">
        <id>b8946bc5-2e67-9f03-2c9e-c07d25b80c63</id>
        <name>testRemoteDestination</name>
        <destination>4055551212</destination>
        <ringWhenExtensionDialed>true</ringWhenExtensionDialed>
        <allowTransferToMobile>true</allowTransferToMobile>
        <allowControlFromApplication>false</allowControlFromApplication>
        <associatedDevices>
            <associatedDevice>
                <usage uri="https://ds-ucm1251.cisco.com:8443/cucm-uds/options/remoteDestinationUsage" value="0">Single Number Reach</usage>
                <name>testRemoteDestinationProfile</name>
                <description></description>
                <model>Remote Destination Profile</model>
            </associatedDevice>
        </associatedDevices>
    </remoteDestination>

<model> is present in CUCM v12.0(1)+

POST remoteDestination

Adds the specified device as a remote destination target.

Requirements for a successful request:

The remote destination profile or a CTI remote device itself must already be assigned to the user.
If the remoteDestination is already associated with the user (e.g. on another profile/device), use the PUT method instead of the POST method. That is, instead of adding a destination, perform an update on an existing destination.

Request format

<!--add a device as a remoteDestination request-->
POST https://{host}:8443/cucm-uds/user/{userId}/remoteDestination/{remoteDestinationPkid}
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user for whom you want to add a remote destination device.
remoteDestinationPkid	The ID of the remote destination.

User authentication required.

Request body

<!--add a device as a remoteDestination example request body-->
    <remoteDestination>
        <name>Home</name>
        <destination>+12345678901</destination>
        <ringWhenExtensionDialed>true|false</ringWhenExtensionDialed>
        <allowTransferToMobile>true</allowTransferToMobile>
        <allowControlFromApplication>true|false</allowControlFromApplication>
        <associatedDevices>
            <associatedDevice>
                <name>RD02</name>
                <usage>2</usage>
            </associatedDevice>
        </associatedDevices>
    </remoteDestination>

PUT remoteDestination for a device

Updates existing call destination information for the specified remote device.

Requirements for a successful request:

The remote destination already exists.

Note: The <description> field cannot be updated.

Request format

<!--update remoteDestination information request format-->
PUT https://{host}:8443/cucm-uds/user/{userId}/remoteDestination/{remoteDestinationPkid}
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user whose remote destination information you want to update.
remoteDestinationPkid	The ID of the device.

User authentication required.

Request body

<!--update remoteDestination information example request body-->
<remoteDestination>
    <name>Adrienne's Cell</name>
    <destinationNumber>+12121212121</destinationNumber>
    <ringWhenExtensionDialed>true|false</ringWhenExtensionDialed>
    <allowTransferToMobile>true</allowTransferToMobile>
    <allowControlFromApplication>true|false</allowControlFromApplication>
    <associatedDevices>
        <associatedDevice>
            <name>RD01</name>
            <usage>0</usage>
        </associatedDevice>
    </associatedDevices>
</remoteDestination>

speedDials

The speedDials resource manages speed dial information for a user. It supports GET/POST/PUT/DELETE.

GET speedDials

Returns a summary of all of the user's speed dial information.

If all of the speed dial information on every device that is owned or associated to the user is identical, the list is considered to be "unified", with the following behaviour:

<speedDials appliesToAllDevices="true">
Unified: returns a list of speedDials as well as a device listing that displays links to detailed speedDial information for each device.
Not unified: returns only a device listing containing drill down links to the speed dial information for each device (no speedDial data itself is returned)

Request foramt

<!--get the user's speedDials request-->
GET https://{host}:8443/cucm-uds/user/{userId}/speedDials
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The user whose speed dial information you want to retrieve.

User authentication required.

Response format

If speed dials are unified:

<!--get user's speedDials response: "appliesToAllDevices=true"-->
<userSpeedDials uri="https://{host}:8443/cucm-uds/user/{userId}/speedDials" version="{version}">
    <speedDials appliesToAllDevices="true" totalCount="3">
        <speedDial>
            <index>1</index>
            <number>1234567890</number>
            <label>Manager</label>
        </speedDial>
        <speedDial>
            <index>2</index>
            <number>1234567899</number>
            <label>Assistant</label>
        </speedDial>
        <speedDial>
            <index>3</index>
            <number>1234567</number>
            <label>VP</label>
        </speedDial>
    </speedDials>
    <devices>
        <device name="SEP000001000003" description="Auto 100002" speedDialsUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/speedDials"/>
        <device name="SEP000001000004" description="Auto 100003" speedDialsUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/speedDials"/>
        <device name="SEP000001000005" description="Auto 100004" speedDialsUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/speedDials"/>
    </devices>
</userSpeedDials>

If speed dials are not unified:

<!--get user's speedDials response: "appliesToAllDevices=false"-->
<userSpeedDials uri="https://{host}:8443/cucm-uds/user/{userId}/speedDials" version="{version}">
    <speedDials appliesToAllDevices="false" totalCount="0"/>
    <devices>
        <device name="SEP000001000003" description="Auto 100002" speedDialsUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/speedDials"/>
        <device name="SEP000001000004" description="Auto 100003" speedDialsUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/speedDials"/>
        <device name="SEP000001000005" description="Auto 100004" speedDialsUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/speedDials"/>
    </devices>
</userSpeedDials>

POST speedDials

The speedDials POST method adds new speed dials.

The number of displayable speed dials supported may vary by device model and configuration. Speed dials added to a device may be converted into abbreviated dials based on the device settings.

Request format

<!--add speedDials request-->
POST https://{host}:8443/cucm-uds/user/{userId}/speedDials
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The user whose speed dial information you want to add.

User authentication required.

Request body

<!--add speedDials example request body-->
<speedDials>
    <speedDial>
        <index>1</index>
        <number>1234567890</number>
        <label>Manager</label>
    </speedDial>
    <speedDial>
        <index>2</index>
        <number>1234567899</number>
        <label>Assistant</label>
    </speedDial>
</speedDials>

<index> indicates the order in which speed dials appear on the device. This tag is required.

PUT speedDials

The speedDials PUT method updates the speed dial list with the specified speed dials.

If a device in the group of devices owned or associated with the user does not support enough displayable speed dials, the speed dial entries are created anyway. Speed dials that cannot be displayed are treated as "abbreviated dials".

Request format

<!--update speedDials request-->
PUT https://{host}:8443/cucm-uds/user/{userId}/speedDials
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The user whose speed dial information you want to update.

User authentication required.

Request body

<!--update speedDials example request body-->
<speedDials>
    <speedDial>
        <index>1</index>
        <number>1234567890</number>
        <label>Manager</label>
    </speedDial>
    <speedDial>
        <index>2</index>
        <number>1234567899</number>
        <label>Assistant</label>
    </speedDial>
    <speedDial>
        <index>3</index>
        <number>0001</number>
        <label>CEO</label>
    </speedDial>
</speedDials>

<index> is required.

DELETE speedDials

Clears the speed dial information using the specified index query parameter. It performs this operation across all of the devices owned by the user.

Request format

<!--remove a speedDial request-->
DELETE https://{host}:8443/cucm-uds/user/{userId}/speedDials?index={index}
Accept: application/xml
Content-Type: application/xml

User authentication required.

Path parameters

Parameter	Description
userId	The user whose speed dial information you want to delete.

Query string parameters

Parameter	Description
index	The index for the speed dial information to be deleted on all devices owned by the user. `https://{host}:8443/cucm-uds/user/{userId}/speedDials?index=3`

No respose body is returned (HTTP 204)

subscribedServices

The subscribedServices resource accesses the consolidated subscribed IP phone services for a user. If the user has different subscribed IP phone services on different devices, the response includes the drill-down link for accessing the subscribed services for those devices. subscribedServices supports GET/POST/PUT/DELETE.

GET subscribedServices information

Returns a list of subscribedServices for the specified user.

Request format

<!--get a user's subscribedServices request-->
GET https://{host}:8443/cucm-uds/user/{userId}/subscribedServices  
Content-Type: application/xml

Path parameter

Parameter	Description
userId	The ID of the user whose services you want to see.

User authentication required.

Response format

<!--get a user's subscribedServices response-->
<userSubscribedServices uri="https://{host}/cucm-uds/user/{userId}/subscribedServices" version="10.0.0">
    <subscribedServices appliesToAllDevices="true" totalCount="1">
        <subscribedService>
            <name>udsTestService1</name>
            <url>http://udsTestService1</url>
            <secureUrl>
            </secureUrl>
            <phoneServiceName phoneServiceId="292ab26b-5052-dd46-325f-45b12d4822a7">udsTestService1</phoneServiceName>
        </subscribedService>
    </subscribedServices>
    <devices>
        <device name="SEP000001000003" description="Auto 100002" subscribedServicesUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/subscribedServices"/>
        <device name="SEP000001000004" description="Auto 100003" subscribedServicesUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/subscribedServices"/>
        <device name="SEP000001000005" description="Auto 100004" subscribedServicesUri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/subscribedServices"/>
    </devices>
</userSubscribedServices>

POST subscribedServices

The subscribedServices POST method adds a new subscribed service to a user's subscribedServices list.

Requests can be made in two formats:

Embedded URL parameters

Either a <url> or a <secureUrl> is provided. Query string parameters included as part of the URL are parsed and used to populate the subscribedService. The URL+params must match the phoneService template definition.
<parameters> list

A <parameters> element is supplied. Any <parameter> <pkid> values must be valid for the phoneService, i.e. retrieved via a previous GET /phoneService request.

Note: If both request format styles are present (URL w/params and a <parameters> list), they must be equivalent.

Request format

<!--add subscribedServices request-->
POST https://{host}:8443/cucm-uds/user/{userId}/subscribedServices
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user whose subscribed services you want to modify.

User authentication required.

Request body

<phoneServiceId> is required and must exist.

"Embedded URL parameters" format:

<!--add subscribedServices example request body: URL format-->
<subscribedServices>
    <subscribedService>
        <name>InternalTechSupport</name>
        <phoneServiceId>{phoneServiceId}</phoneServiceId>
        <url>http://{host}/servlet/GTRCService?menuname=US</url>
        <secureUrl>https://{host}/servlet/GTRCService?menuname=US</secureUrl>
    </subscribedService>
    <subscribedService>
        <name>Service2</name>
        <phoneServiceId>{phoneServiceId}</phoneServiceId>
        <url>http://{host}/servlet/GTRCService2?menuname=US</url>
        <secureUrl>https://{host}/servlet/GTRCService2?menuname=US</secureUrl>
    </subscribedService>
</subscribedServices>

"<parameters>" list" format:

<!--add subscribedServices example request body: parameter list-->

<subscribedServices>
    <subscribedService>
        <name>InternalTechSupport</name>
        <phoneServiceId>{phoneServicePkid}</phoneServiceId>
        <parameters>
            <parameter>
                <paramId>{pkid}</paramId>
                <value>5</value>
            </parameter>
        </parameters>
    </subscribedService>
    <subscribedService>
        <name>Service2</name>
        <phoneServiceId>{phoneServicePkid}</phoneServiceId>
        <parameters>
            <parameter>
                <paramId>{pkid}</paramId>
                <value>5</value>
            </parameter>
        </parameters>
    </subscribedService>
</subscribedServices>

PUT subscribedServices

The subscribedServices PUT method replaces the user's subscribedServices existing list (if any) with the specified services.

Requests can be made in two formats:

Embedded URL parameters

Either a <url> or a <secureUrl> is provided. Query string parameters included as part of the URL are parsed and used to populate the subscribedService. The URL+params must match the phoneService template definition.
<parameters> list

A <parameters> element is supplied. Any <parameter> <pkid> values must be valid for the phoneService, i.e. retrieved via a previous GET /phoneService request.

Note: If both request format styles are present (URL w/params and a <parameters> list), they must be equivalent.

Request format

<!--update subscribedServices request-->
PUT https://{host}:8443/cucm-uds/user/{userId}/subscribedServices
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user whose subscribed services you want to modify.

User authentication required.

Request body

<phoneServiceId> is required and must exist.

"Embedded URL parameters" format:

<!--update subscribedServices expected request body: URL format-->
<subscribedServices>
    <subscribedService>
        <name>InternalTechSupport</name>
        <phoneServiceId>{phoneServiceId}</phoneServiceId>
        <url>http://{host}/servlet/GTRCService?menuname=US</url>
        <secureUrl>https://{host}/servlet/GTRCService?menuname=US</secureUrl>
    </subscribedService>
    <subscribedService>
        <name>Service2</name>
        <phoneServiceId>{phoneServiceId}</phoneServiceId>
        <url>http://{host}/servlet/GTRCService2?menuname=US</url>
        <secureUrl>https://{host}/servlet/GTRCService2?menuname=US</secureUrl>
    </subscribedService>
</subscribedServices>

"<parameters> list" format:

<!--update subscribedServices expected request body: Paramater List-->

<subscribedServices>
    <subscribedService>
        <name>InternalTechSupport</name>
        <phoneServiceId>{phoneServicePkid}</phoneServiceId>
        <parameters>
            <parameter>
                <paramId>{pkid}</paramId>
                <value>5</value>
            </parameter>
        </parameters>
    </subscribedService>
    <subscribedService>
        <name>Service2</name>
        <phoneServiceId>{phoneServicePkid}</phoneServiceId>
        <parameters>
            <parameter>
                <paramId>{pkid}</paramId>
                <value>5</value>
            </parameter>
        </parameters>
    </subscribedService>
</subscribedServices>

DELETE subscribedServices

The subscribedServices DELETE method deletes all appearances of the indicated subscribed service from all of the user's devices.

Request format

<!--remove subscribedServices request-->
DELETE https://{host}:8443/cucm-uds/user/{userId}/subscribedServices/{subscribedServicePkid}
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter	Description
userId	The ID of the user whose subscribed services you want to delete.
subscribedServicePkid	The ID of the subscribed services you want to delete.

User authentication required.
No response body is provided