User Data Services API

device

The /device resource manages a user's device information. Device supports GET and PUT methods.

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

GET device

The device GET method returns detailed information about a user's device.

Request format

xml
Copy<!--get device information request-->
GET https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}
Content-Type: application/xml

Path parameters

Parameter Description
userId The user whose device information you want to retrieve.
devicePkid The ID of the device.
  • User authentication required.

Response format

xml
Copy<!--get device information response-->
<device uri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}" version="10.0.0" hasPrimaryNumber="true">
  <id>{devicePkid}</id>
  <name>SEP000001000003</name>
  <type>Phone</type>
  <description editable="true">Auto 100002</description>
  <model>Cisco 7970</model>
  <protocol>SCCP</protocol>
  <requireCerLocation>false</requireCerLocation>
  <doNotDisturbSettings>
    <enable>false</enable>
    <option value="0">
      <supportedDndOptions>
        <option value="0">Ringer Off</option>
        <option value="1">Call Reject</option>
        <option value="2">Use Common Phone Profile Setting</option>
      </supportedDndOptions>
    </option>
    <incomingCallAlertSetting value="">
      <supportedRingSettings>
        <option value="1">Disable</option>
        <option value="2">Flash Only</option>
        <option value="5">Beep Only</option>
      </supportedRingSettings>
    </incomingCallAlertSetting>
  </doNotDisturbSettings>
  <userGuide uri="https://{host}/PhoneGuides/locales/en_us/PhoneOnlineGuide/7970/7970user.pdf"/>
  <phoneLocale uri="https://{host}/cucm-uds/options/installedLocales" value="1">English, United States</phoneLocale>
  <extensions uri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/extensions"/>
  <subscribedServices uri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/subscribedServices"/>
  <speedDials uri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/speedDials"/>
</device>

PUT device

The device PUT method allows the user to modify the information of several options in the device. When the method completes, it returns a response with results identical those obtained with a GET device request, reflecting the new changes.

Request format

xml
Copy<!--update device information request-->
PUT https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userId The ID of the user modifying the information.
devicePkid The ID of the device.
  • User authentication required.

Request body

xml
Copy<!--update device information example request body-->
<device>
   <description>description</description>
    <doNotDisturbSettings>
        <enable>true</enable>
    </doNotDisturbSettings>
</device>

devicetoken

The devicetoken resource allows management of tokens used in Push Notification-enabled CUCM deployments to enhance Jabber mobile client call/message responsiveness. Customers may need to share this token with a trusted server.

devicetokens are supported for Android and iOS mobile devices, currently the following models:

  • Cisco Dual Mode for Android
  • Cisco Dual Mode for iPhone
  • Cisco Jabber for Tablet

devicetoken supports PUT/DELETE.

As mobile device types are created in the system, a devicetoken - not assigned to any user - is created for it automatically. A device can be associated with only one user through its devicetoken. DELETE for a devicetoken causes the system to regenerate a new (non-user associated) token for the device. As a result, POST for this resource is not supported.

PUT devicetoken for a device

Request format

xml
Copy<!--PUT devicetoken request-->
PUT https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/devicetoken
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userId The ID of the user modifying the information.
devicePkid The ID of the target device.
  • User authentication required.

Request body*

xml
Copy<token>
        <pushNotifyToken>ABCD12345</pushNotifyToken>
        <pushChannelType>APNS/FCM</pushChannelType>
        <key>key1</key>
        <algorithm>algorithm</algorithm>
        <application>application3</application>
        <payloadVersion>v2</payloadVersion>
        <deviceToken>EFGH12345</deviceToken>
        <isCallKitDisabled>true</isCallKitDisabled>
</token>

DELETE devicetoken for a device

The devicetoken DELETE method disassociated the user from the device's devicetoken.

Request format

xml
Copy<!--DELETE devicetoken request-->
DELETE https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/devicetoken/{tokenId}
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userId The ID of the user modifying the information.
devicePkid The ID of the target device.
tokenId The <pushNotifyToken> specified in a previous PUT request.

extensions

The /extensions resource returns a listing of all of the extension information about a device associated to the user. Note the following:

  • <label> 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 displayed first.
  • For client devices, having <sendToVoiceMailPilotNumber> set to true takes precedence over the setting in <callForwardAllDestination>.

GET extensions for a device

Request format

Code Snippet
Copy<!--extensions request-->
GET https:­//{host}:8443/cucm-uds/user/{userid}/device/{devicePkid}/extensions
Content-Type: application/xml

Path parameters

Parameter Description
userId The ID of the user whose extension information is to be retrieved.
devicePkid The ID of the device for which extension information is to be retrieved.
  • User authentication required.

Response format

xml
Copy<!--extensions response-->
<extensions version="10.0.0" uri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/extensions">
  <extension uri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/extension/{extensionPkid}" isPrimary="true">
      <id>{extensionPkid}</id>
      <directoryNumber>100002</directoryNumber>
      <voiceMailPilotNumber>
      </voiceMailPilotNumber>
      <callForwardAllDestination>
      <sendToVoiceMailPilotNumber>true</sendToVoiceMailPilotNumber>
      <sendToCustomDestination>
      </sendToCustomDestination>
      </callForwardAllDestination>
      <messageWaitingVisualAlert>false</messageWaitingVisualAlert>
      <messageWaitingVisualAlertPreference value="">Use System Policy</messageWaitingVisualAlertPreference>
      <messageWaitingAudibleAlertPreference value="">Default</messageWaitingAudibleAlertPreference>
      <onACallRingPreference value="">Use System Default</onACallRingPreference>
      <notOnACallRingPreference value="4">Ring</notOnACallRingPreference>
      <logMissedCalls>true</logMissedCalls>
      <label>
      </label>
  </extension>
  ...
</extensions>

extension

The /extension resource allows you to display and manage a specific device's dialing and forwarding characteristics. GET/PUT methods are supported.

GET extension for a device

The extension resource GET method returns information about the device's dialing and forwarding information. It does not provide description field information--this is only accessible by the administrator.

Request format

xml
Copy<!--get a device's extension request-->
GET https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/extension/{extensionPkid}
Content-Type: application/xml

Path parameters

Parameter Description
userId The user whose device information you want to retrieve.
devicePkid The ID of the specific device to query for information. Use the /devices resource to obtain this information.
extensionPkid The ID of the specific extension to query for information.
  • User authentication required.

Reseponse format

xml
Copy<!--get a device's extension response-->
<extension version="10.0.0" uri="https://{host}/cucm-uds/user/{userId}/device/{devicePkid}/extension/{extensionPkid}" isPrimary="true">
  <id>{extensionPkid}</id>
  <directoryNumber>100002</directoryNumber>
  <voiceMailPilotNumber>
  </voiceMailPilotNumber>
  <callForwardAllDestination>
    <sendToVoiceMailPilotNumber>true</sendToVoiceMailPilotNumber>
    <sendToCustomDestination>
    </sendToCustomDestination>
  </callForwardAllDestination>
  <forwardBusyExternalCallDestination>
    <sendToVoiceMailPilotNumber>false</sendToVoiceMailPilotNumber>
    <sendToCustomDestination>
    </sendToCustomDestination>
  </forwardBusyExternalCallDestination>
  <forwardNoAnswerExternalCallDestination>
    <sendToVoiceMailPilotNumber>false</sendToVoiceMailPilotNumber>
    <sendToCustomDestination>
    </sendToCustomDestination>
  </forwardNoAnswerExternalCallDestination>
  <forwardBusyInternalCallDestination>
    <sendToVoiceMailPilotNumber>false</sendToVoiceMailPilotNumber>
    <sendToCustomDestination>
    </sendToCustomDestination>
  </forwardBusyInternalCallDestination>
  <forwardNoAnswerInternalCallDestination>
    <sendToVoiceMailPilotNumber>false</sendToVoiceMailPilotNumber>
    <sendToCustomDestination>
    </sendToCustomDestination>
  </forwardNoAnswerInternalCallDestination>
  <messageWaitingVisualAlert>false</messageWaitingVisualAlert>
  <messageWaitingVisualAlertPreference value="">
    <option value="1">Light and Prompt</option>
    <option value="2">Prompt Only</option>
    <option value="3">Light Only</option>
    <option value="4">None</option>
  </messageWaitingVisualAlertPreference>
  <messageWaitingAudibleAlertPreference value="">
    <option value="0">Off</option>
    <option value="1">On</option>
  </messageWaitingAudibleAlertPreference>
  <onACallRingPreference value="">
    <option value="1">Disable</option>
    <option value="2">Flash Only</option>
    <option value="3">Ring Once</option>
    <option value="4">Ring</option>
    <option value="5">Beep Only</option>
  </onACallRingPreference>
  <notOnACallRingPreference value="4">
    <option value="1">Disable</option>
    <option value="2">Flash Only</option>
    <option value="3">Ring Once</option>
    <option value="4">Ring</option>
    <option value="5">Beep Only</option>
  </notOnACallRingPreference>
  <logMissedCalls>true</logMissedCalls>
  <label>
  </label>
</extension>

PUT extension for a device

The extension resource PUT method allows the user to modify the call forwarding characteristics of the user's device. When the method completes, it returns a response with results identical to those obtained with a GET extension request.

All fields are optional. Sending a blank element clears the current setting for the element and restores it to a default value. Elements not specified in the request are left unchanged.

When the request specifies both <sendToVoiceMailPilotNumber> and <destination>, it updates both. However, note that <sendToVoiceMailPilotNumber> has higher precedence over <destination> in the client behavior.

Request format

xml
Copy<!--update a device's extension request-->
PUT https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/extension/{extensionPkid}
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userId The ID of the user who's extension is to be modified.
devicePkid The ID of the device whose information is to be modified. Use the GET /device resource to obtain this information.
extensionPkid The ID of the extension whose information is to be modified.
  • User authentication required.

Request body

xml
Copy<!--update a device's extension example request body-->
<extension>
    <callForwardAllDestination>
        <sendToVoiceMailPilotNumber>false</sendToVoiceMailPilotNumber>
        <sendToCustomDestination>43521</sendToCustomDestination>
    </callForwardAllDestination>
    <logMissedCalls>false</logMissedCalls>
    <label>label</label>
    <messageWaitingVisualAlertPreference>1</messageWaitingVisualAlertPreference>
    <messageWaitingAudibleAlertPreference>1</messageWaitingAudibleAlertPreference>
    <onACallRingPreference>1</onACallRingPreference>
    <notOnACallRingPreference>1</notOnACallRingPreference>
</extension>

speedDials

The device-specific speedDials resource manages speed dial information for a single device. It supports GET/POST/PUT

GET speedDials for a device

Returns a list of all of the speed dial information for a device.

Request format

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

Path parameters

Parameter Description
userId The user whose device information you want to retrieve.
devicePkid The ID of the specific device to query for information.

Query string parameters

Parameter Description
index Filter results by speed dial index.
https:­//{host}:8443/cucm-uds/{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDials?index=7
number Filter results by the speed dial destination number.
https:­//{host}:8443/cucm-uds/{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDials?number=6035551234
  • User authentication required.

Response format

xml
Copy<!--get a device's speedDials example response-->
<speedDials totalCount="1" uri="https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDials" version="{version}">
    <speedDial uri="https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDial/{speedDialPkid}">
        <id>{speedDialPkid}</id>
        <index>1</index>
        <number>+1234567890</number>
        <label>Manager</label>
    </speedDial>
    ...
</speedDials>

POST speedDials for a device

Adds speedDials for the specified device.

  • <index> and <number> parameters are required.
  • <label> is optional.

Request format

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

Path parameters

Parameter Description
userId The user whose speed dial information you want to update.
devicePkid The ID of the specific device to update.
  • User authentication required.

Request body

xml
Copy<!--add speedDials to a device example request body-->
<speedDials>
    <speedDial>
        <index>1</index>
        <number>1234</number>
        <label>My Label</label>
    </speedDial>
    <speedDial>
        <index>5</index>
        <number>5555</number>
        <label>My Label2</label>
    </speedDial>
    ...
</speedDials>

PUT speedDials for a device

Replaces the current speed dial list for a particular device.

Request format

xml
Copy<!--Update speedDials request-->
PUT https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDials
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userId The user whose speed dial information you want to replace.
devicePkid The ID of the specific device to update.
  • User authentication required.

Request body

xml
Copy<!--Update speedDials expected request body-->
<speedDials>
    <speedDial>
        <index>1</index>
        <number>1234</number>
        <label>My Label</label>
    </speedDial>
    <speedDial>
        <index>5</index>
        <number>5555</number>
        <label>My Label2</label>
    </speedDial>
    ...
</speedDials>

speedDial

The speedDial resource manages a single speed dial for a device. It supports GET/POST/PUT

GET speedDial for a device

Returns detailed information about a device's speedDial characteristics.

Request format

xml
Copy<!--get a device's speedDial request-->
GET https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDial/{speedDialPkid}
Content-Type: application/xml

Path parameters

Parameter Description
userId The user whose device information you want to retrieve.
devicePkid The ID of the specific device to query for information.
speedDialPkid The ID of the specific speed dial storage to query for information.
  • User authentication required.

Response format

xml
Copy<!--get a device's speedDial response-->
<speedDial uri="https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDial/{speedDialPkid}" version="{version}">
    <id>{devicePkid}</id>
    <index>1</index>
    <number>1234567890</number>
    <label>Manager</label>
</speedDial>

POST speedDial for a device

Adds one new speedDial entry to the specified device.

Request format

xml
Copy<!--add a new speedDial request-->
POST https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDial
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userId The user whose device information you want to update.
devicePkid The ID of the specific device requiring the update.
  • User authentication required.

Request body

xml
Copy<!--add a new speedDial example request body-->
<speedDial>
    <index>2</index>
    <number>01010101</number>
    <label>Home</label>
</speedDial>
  • <index> and <number> are required.
  • <label> is optional.

PUT speedDial for a device

Updates the speedDial entry for the specified device.

Request format

xml
Copy<!--update an existing speedDial request-->
PUT https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/speedDial
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userId The user whose device information you want to update.
devicePkid The ID of the specific device requiring the update.
  • User authentication required.

Request body

xml
Copy<!--update an existing speedDial example request body
-->
<speedDial>
    <index>1</index>
    <number>+1234567890</number>
    <label>Manager</label>
</speedDial>

  • <index> and <number> are required.

  • <label> is optional. If present but empty, the value is cleared.

  • No response body is returned (HTTP 204)

  • HTTP status Code 409 (Conflict) indicates an attempt to update the speed dial's index to an existing index.

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 drill-down links for accessing the subscribed services for those devices. Supports GET/PUT/POST/DELETE

GET subscribedServices for a device

Returns a list of subscribed services for the specified device.

Request format

xml
Copy<!--obtain subscribedServices info for a user's device request-->
GET https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/subscribedServices
Content-Type: application/xml

Path parameters

Parameter Description
userid The ID of the user whose services you want to see.
devicePkid The ID of the device whose services you want to see.
  • User authentication required.

Response format

xml
Copy<!--obtain subscribedService info for a user's device response-->
<subscribedServices uri="https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/subscribedServices" version="{version}">
    <subscribedService uri="https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/subscribedService/{subscribedServicePkid}">
        <id>{subscribedServicePkid}</id>
        <name>InternalTechSupport</name>
        <url>http:­//{host}/GTRC/ipgtrc/servlet/GTRCService?menuname=US</url>
        <secureUrl/>
        <phoneServiceName phoneServiceId="{phoneServicePkid}">InternalTechSupport</phoneServiceName>
    </subscribedService>
    ...
</subscribedServices>

POST subscribedServices for a Device

For the specified device, the subscribedServices POST method adds a new subscribedService 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 existing phoneService defined paramters.

  • <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

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

Path parameter

Parameter Description
userId The ID of the user whose subscribed services you want to modify.
devicePkid The ID of the device whose subscribed services you want to modify.
  • User authentication required.

Request body

  • <phoneServiceId> is required and must exist.

"Embedded URL parameters" format:

xml
Copy<!--add subscribedServices to a device example request body: URL format-->
<subscribedServices>
    <subscribedService>
        <name>InternalTechSupport</name>
        <phoneServiceId>{phoneServiceId}</phoneServiceId>
        <url>http:­//{host}/GTRC/ipgtrc/servlet/GTRCService?menuname=US</url>
        <secureUrl>https:­//{host}/GTRC/ipgtrc/servlet/GTRCService?menuname=US</secureServiceUrl>
    </subscribedService>
    <subscribedService>
        <name>Service2</name>
        <phoneServiceId>{phoneServiceId}</phoneServiceId>
        <url>http:­//{host}/GTRC/ipgtrc/servlet/GTRCService?menuname=US</url>
        <secureUrl>https:­//{host}/GTRC/ipgtrc/servlet/GTRCService?menuname=US</secureServiceUrl>
    </subscribedService>
    ...
</subscribedServices>

"<parameters> list" format:

xml
Copy<!--add subscribedServices to a device 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 for a device

For the specified device, the subscribedServices PUT method replaces the subscribedServices list with the provided specified services list.

This method is identical to POST /subscribedServices, with the exception of using POST.

DELETE subscribedServices for a device

The subscribedServices DELETE method deletes all of the subscribed services for the specified device.

Request format

xml
Copy<!--remove subscribedServices from a device request-->
DELETE https:­//{host}:8443/cucm-uds/ser/{userId}/device/{devicePkid}/subscribedServices
Accept: application/xml
Content-Type: application/xml

Path parameters

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

  • User authentication required.

  • No response body is returned (HTTP 204)

subscribedService

The subscribedService resource manages the detailed information of a subscribed IP Phone Service. Supports GET/POST/PUT.

The URI for accessing the subscribedService resource should be retrieved from the GET /subscribedServices response.

GET subscribedService for a device

Obtain detailed information about a subscribedService.

Request format

xml
Copy<!--obtain subscribedService information request-->
GET https:­//{host}:8443/cucm-uds/user/{userId}/device/{devicePkid}/subscribedService/{subscribedServicePkid}
Content-Type: application/xml

Path parameters

Parameter Description
userId The user ID of the user whose services you want to see.
devicePkid The ID of the device with the services.
subscribedServicePkid The ID of the subscribed service.
  • User authentication required.

Response format

xml
Copy<!--obtain subscribedService information response-->
<subscribedService uri="https:­//{host}:8443/cucm-uds/user/{userId}/device/{deviceId}/subscribedService/{subscribedServiceId}" version="{version}">
    <id>{subscribedServicePkid}</id>
    <name>InternalTechSupport</name>
    <url>http:­//{host}/GTRC/ipgtrc/servlet/GTRCService?menuname=US</url>
    <phoneServiceName phoneServiceId="{phoneServiceId}">InternalTechSupport</phoneServiceName>
    <parameters>
        <parameter>
            <paramId>{parameterId}</paramId>
            <value>myval</value>
            <displayName>TestParam</displayName>
            <description>test</description>
            <isRequired>true|false</isRequired>
            <isCredential>true|false</isCredential>
        </parameter>
        ...
    </parameters>
</subscribedService>

POSTsubscribedService for a device

The subscribedService resource POST method creates a new subscribed service on a device.

Request format

xml
Copy<!--add a subscribedService to a device request-->
POST https:­//{host}:8443/cucm-uds/user/{userid}/device/{deviceid}/subscribedService
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userid The user ID of the user whose services you want to see.
devicePkid The ID of the device with the services.
  • User authentication required.

Request body

xml
Copy<!--add a subscribedService to a device request body-->
<subscribedService>
    <name>My Subscribed Service</name>
    <phoneServiceId>{pkid}</phoneServiceId>
    <parameters>
        <parameter>
            <paramId>{pkid}</paramId>
            <value>5</value>
        </parameter>
        ...
    </parameters>
</subscribedService>
  • <name> and <phoneServiceId> are required

PUT subscribedService for a device

The subscribedService resource PUT method updates an existing subscribed service on a device.

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 existing phoneService defined paramters.

  • <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

xml
Copy<!--update a device's subscribedService request-->
PUT https:­//{host}:8443/cucm-uds/ser/{userId}/device/{devicePkid}/subscribedService/{subscribedServicePkid}
Accept: application/xml
Content-Type: application/xml

Path parameters

Parameter Description
userid The user ID of the user whose services you want to see.
devicePkid The ID of the device with the services.
subscribedServicePkid The ID of the service to update.
  • User authentication required.

Request body

"Embedded URL parameters" format:

xml
Copy<!--update a device's subscribedService example request: URL format-->
   <subscribedservice>
   <name>My Subscribed Service</name>
   <url>http:­//{host}/GTRC/ipgtrc/servlet/GTRCService?menuname=US</url>
   <secureurl>https:­//{host}/GTRC/ipgtrc/servlet/GTRCService?menuname=US</secureurl>
   </subscribedservice>

"<parameters> list" format:

xml
Copy<!--update a device's subscribedService example request: parameter list-->
<subscribedService>
    <name>My Subscribed Service</name>
    <parameters>
        <parameter>
            <paramId>{parameterPkid}<paramId>
            <value>5</value>
        </parameter>
        ...
    </parameters>
</subscribedService>