API Reference for device/cuc/SmsDevice

The full URL would include the host-proxy name: https://[host-proxy].

Variables are enclosed in square brackets.

[hierarchy] is the hierarchy.
1. as UUID. For example: 6t0ggef2c0deab00hb595101
2. in dot notation. E.g. ProviderName.CustomerName.LocationName

For a list of available UUIDs and their dot notations:
GET /api/v0/data/HierarchyNode/?format=json

[pkid] is the ID of the resource instance. Refer to the List reference below.
[filename] refers to a file

Operations on certain device models affect dependent device models. These are indicated at the operation as a list of descendants.

GET http://[host-proxy]/api/device/cuc/SmsDevice/schema/?hierarchy=[hierarchy]&format=json&schema=1

        {
     "$schema": "http://json-schema.org/draft-03/schema", 
     "type": "object", 
     "properties": {
          "DisplayName": {
               "description": " The preferred text name of the notification device to be used when displaying entries in the administrative console, e.g. Cisco Unity Connection Administration. For example, \"Home Phone,\" Pager 2,\" \"Work Phone, \" etc. ", 
               "title": "Display Name", 
               "minItems": 0, 
               "required": true, 
               "type": "string", 
               "name": "DisplayName"
          }, 
          "SmppProviderObjectId": {
               "description": " The unique identifier of the SMPPProvider object that is used by this notification device.", 
               "format": "uri", 
               "minItems": 0, 
               "title": "Smpp Provider Object Id", 
               "required": true, 
               "choices": [], 
               "target_attr": "ObjectId", 
               "target": "/api/device/cuc/SmppProvider/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
               "target_model_type": "device/cuc/SmppProvider", 
               "type": [
                    "string"
               ], 
               "name": "SmppProviderObjectId"
          }, 
          "UserURI": {
               "name": "UserURI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "User URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "RecipientAddress": {
               "minItems": 0, 
               "type": "string", 
               "description": " The phone number of the SMS-compatible device to receive the message. In CUSA, this is referred to as the \"To:\" field.", 
               "name": "RecipientAddress", 
               "title": "Recipient Address"
          }, 
          "SendCount": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " A flag indicating whether Cisco Unity Connection will include a count of each voice mail, fax, and e-mail message with the notification message. When the subscriber receives the notification, the message count appears as a line for each type of message. ", 
               "name": "SendCount", 
               "title": "Send Count"
          }, 
          "MaxSubject": {
               "minItems": 0, 
               "type": "integer", 
               "description": " The maximum number of characters allowed in the 'subject' of a notification message.", 
               "name": "MaxSubject", 
               "title": "Max Subject"
          }, 
          "MaxBody": {
               "minItems": 0, 
               "type": "integer", 
               "description": " The maximum number of characters allowed in the 'body' of a notification message.", 
               "name": "MaxBody", 
               "title": "Max Body"
          }, 
          "SubscriberObjectId": {
               "description": " The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]", 
               "format": "uri", 
               "minItems": 0, 
               "title": "Subscriber Object Id", 
               "required": true, 
               "choices": [], 
               "target_attr": "ObjectId", 
               "target": "/api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=[authtoken], 
               "target_model_type": "device/cuc/User", 
               "type": [
                    "string"
               ], 
               "name": "SubscriberObjectId"
          }, 
          "ScheduleSetObjectId": {
               "type": "string", 
               "description": "ObjectId of the ScheduleSet for when the notification rule is active.", 
               "name": "ScheduleSetObjectId", 
               "title": "Schedule Set Object Id"
          }, 
          "SenderAddress": {
               "minItems": 0, 
               "type": "string", 
               "description": " The return phone number for the message notification. Typically, this column contains the number that the subscriber calls to check messages (i.e., pilot number for Cisco Unity Connection voice mail). If the SMPP Provider requires a source address for the server sending the message, the SMSC will overwrite this data with an IP address. In CUSA, this is referred to as the \"From:\" field.", 
               "name": "SenderAddress", 
               "title": "Sender Address"
          }, 
          "Active": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " A flag indicating whether the device is active or inactive (enabled/disabled).", 
               "name": "Active", 
               "title": "Active"
          }, 
          "RepeatInterval": {
               "type": "integer", 
               "description": "The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.", 
               "name": "RepeatInterval", 
               "title": "Repeat Interval"
          }, 
          "ObjectId": {
               "description": " The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMS object. - template parameter [2]", 
               "title": "Object Id", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "ObjectId"
          }, 
          "DeviceName": {
               "description": " The \"DeviceName\" of the notification device.", 
               "title": "Device Name", 
               "minItems": 0, 
               "readonly": true, 
               "type": "string", 
               "name": "DeviceName"
          }, 
          "EventList": {
               "type": "string", 
               "description": "Comma separated list of events that trigger notification rules to be evaluated.", 
               "name": "EventList", 
               "title": "Event List"
          }, 
          "SendCallerId": {
               "minItems": 0, 
               "type": "boolean", 
               "description": " A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message. ", 
               "name": "SendCallerId", 
               "title": "Send Caller Id"
          }, 
          "URI": {
               "name": "URI", 
               "format": "uri", 
               "minItems": 0, 
               "title": "URI", 
               "choices": [], 
               "type": "string", 
               "target": "/api/choices/?format=json&hierarchy=[hierarchy]&auth_token=[authtoken]
          }, 
          "StaticText": {
               "minItems": 0, 
               "type": "string", 
               "description": " The text message that the subscriber wants to receive in a Text Pager notification. For Text Pager notifications only. The SA refers to this as the \"Send:\" field.\nTypically holds email address. Also holds text for text pagers. SA text pager calls this 'send text'. It is empty for numeric pagers.", 
               "name": "StaticText", 
               "title": "Static Text"
          }, 
          "Undeletable": {
               "minItems": 0, 
               "type": "boolean", 
               "description": "Device cannot be deleted.", 
               "name": "Undeletable", 
               "title": "Undeletable"
          }, 
          "FailDeviceObjectId": {
               "type": "string", 
               "description": "ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.", 
               "name": "FailDeviceObjectId", 
               "title": "Fail Device Object Id"
          }, 
          "InitialDelay": {
               "type": "integer", 
               "description": "The amount of time (in minutes) from the time when a message is received until message notification triggers.", 
               "name": "InitialDelay", 
               "title": "Initial Delay"
          }, 
          "RepeatNotify": {
               "type": "boolean", 
               "description": "A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.", 
               "name": "RepeatNotify", 
               "title": "Repeat Notify"
          }
     }, 
     "schema_version": "14.0"
}

Task	Call	URL	Parameters	Response
Get the GUI Add form.	GET	/api/device/cuc/SmsDevice/add/	hierarchy=[hierarchy] format=json	The GUI Add form of device/cuc/SmsDevice as JSON

The API call to the /add/ URL can only be made from a hierarchy that allows the model type to be added. The actions in the response shows the url for the POST API call to create an instance.

Task	Call	URL	Parameters	Payload
Create	POST	/api/device/cuc/SmsDevice	hierarchy=[hierarchy]	(For payload specification)

Response is a transaction pkid for the create action.

Use the GET call to

tool/Transaction/[trans pkid]

to inspect the created resource and its instance pkid.

Task	Call	URL	Parameters	Payload
Bulk delete [pkid1],[pkid2]...	DELETE	/api/device/cuc/SmsDevice/	hierarchy=[hierarchy]	{"hrefs":["/api/device/cuc/SmsDevice/[pkid1]", "/api/device/cuc/SmsDevice/[pkid2]", ...]}

For the instance pkids [pkid1],[pkid2], ... that can be added to the DELETE call (the instance pkids to delete), refer to the List GET call for: device/cuc/SmsDevice
```
GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json
```

Task	Call	URL	Parameters	Response
Bulk Modify	GET	/api/device/cuc/SmsDevice/bulk_update/?schema=&schema_rules=true	hierarchy=[hierarchy] format=json pkids=pkid1,pkid2,...	In JSON format: POST call to update the instances of device/cuc/SmsDevice device/cuc/SmsDevice schema to create POST payload.

Task	Call	URL	Parameters	Payload
Bulk Modify	POST	/api/device/cuc/SmsDevice/bulk_update/	hierarchy=[hierarchy] format=json	For example: {"data":{"name":"value"}, "meta":{}, "request_meta":{ "hrefs":["/api/v0/device/cuc/SmsDevice/[pkid1]", "/api/v0/device/cuc/SmsDevice/[pkid2]",...]}}

To get a list of model instance pkids that are available to Bulk Modify, use the GET call:
```
GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json
```
The POST payload is in JSON format (refer to the Payload example) and contains:
- data in name-value update pairs according to the returned schema
- meta (empty - for a valid payload)
- request_meta with the hrefs list of instances to update

Task	Call	URL	Parameters	Payload
Move the instance with [pkid] to [target_hierarchy]	POST	/api/tool/DataMove/?model_type=device/cuc/SmsDevice	hierarchy=[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/SmsDevice/[pkid]"]}
Bulk Move	POST	/api/tool/DataMove/?model_type=device/cuc/SmsDevice	hierarchy==[hierarchy] context_hierarchy=[target_hierarchy] format=json (nowait=true)	{"hrefs": ["/api/device/cuc/SmsDevice/[pkid1]", "/api/device/cuc/SmsDevice/[pkid2]",...]}

Move one or more model instances ([pkid1],[pkid2],...) from source hierarchy (pkid or dot notation) to target_hierarchy (pkid or dot notation). A move can only take place from a source hierarchy equal to or lower than target_hierarchy.
For a list of hierarchy pkids and their dot notation available from [hierarchy], use the GET call:
GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json&schema_rules=true

Task	Call	URL	Parameters	Payload
Get a selected [export_format] of the schema and instances [pkid1], [pkid2],... of device/cuc/SmsDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate].	POST	/api/device/cuc/SmsDevice/export/	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	{ "hrefs":["/api/device/cuc/SmsDevice/[pkid1]", "/api/device/cuc/SmsDevice/[pkid2]",...]}}

For export_format=json, the response is a time stamped zip file of data in JSON as in the system database. Item properties such as strings that are empty or Boolean values that are not set, are not included. The filename in the response is of the format as the example:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

For export_format=raw_xlsx, the response is a MS Excel spreadsheet with columns corresponding to the JSON format export and a response filename format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, arranged by any Field Display Policies that apply. The columns correspond with those of a Bulk Load Template export sheet. The response filename format is:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

The XLSX format can be used to bulk load instances of device/cuc/SmsDevice and the JSON format can be used to import instances of device/cuc/SmsDevice.

To get the list of all instance pkids [pkid1],[pkid2], ..., use the List GET call for device/cuc/SmsDevice:

 GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Get a compressed format of the Bulk Load spreadsheet template for device/cuc/SmsDevice	POST	/api/device/cuc/SmsDevice/export_bulkload_template/	hierarchy=[hierarchy] modeltype=device/cuc/SmsDevice	The response is an attachment of the format: filetype_bulkloadsheet.xlsx.gz

Task	Call	URL	Parameters	Response
Configuration Template	GET	/api/device/cuc/SmsDevice/configuration_template/	hierarchy=[hierarchy]	POST call to create the Configuration Template Configuration Template schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/ConfigurationTemplate/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Field Display Policy	GET	/api/device/cuc/SmsDevice/field_display_policy/	hierarchy=[hierarchy]	POST call to create the Field Display Policy Field Display Policy schema

Use the returned properties to create the POST payload data for the .
For a description of the schema that shows properties to add to the POST payload:

The POST call is of the format:

POST http://[host-proxy]/api/data/FieldDisplayPolicy/?hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
List	GET	/api/device/cuc/SmsDevice/	hierarchy=[hierarchy] format=json schema=true	The device/cuc/SmsDevice schema and all instances as JSON.

(The list will return 0 to 3 device/cuc/SmsDevice instances)

GET http://[host]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

{
     "operations": [
          "move"
     ], 
     "pagination": {
          "direction": "asc", 
          "order_by": "DisplayName", 
          "maximum_limit": 2000, 
          "skip": 0, 
          "current": "/api/device/cuc/SmsDevice/?skip=0&limit=3&order_by=DisplayName&direction=asc&traversal=default", 
          "limit": 3, 
          "total_limit": null, 
          "total": 0
     }, 
     "meta": {
          "tags": [], 
          "cached": true, 
          "title": "", 
          "business_key": {}, 
          "schema_version": "14.0", 
          "references": {
               "device": [
                    {
                         "pkid": "", 
                         "href": ""
                    }
               ], 
               "children": [], 
               "parent": [
                    {
                         "pkid": "6t0ggef2c0deab00hb595101", 
                         "href": "/api/data/HierarchyNode/6t0ggef2c0deab00hb595101"
                    }
               ], 
               "foreign_key": []
          }, 
          "actions": [
               {
                    "add": {
                         "support_async": false, 
                         "class": "add", 
                         "href": "/api/device/cuc/SmsDevice/add/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Add"
                    }
               }, 
               {
                    "remove": {
                         "support_async": true, 
                         "class": "delete", 
                         "href": "/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]", 
                         "method": "DELETE", 
                         "title": "Delete"
                    }
               }, 
               {
                    "bulk_update_form": {
                         "support_async": false, 
                         "class": "update", 
                         "href": "/api/device/cuc/SmsDevice/bulk_update/?hierarchy=[hierarchy]&schema=&schema_rules=true", 
                         "method": "GET", 
                         "title": "Bulk Modify"
                    }
               }, 
               {
                    "move": {
                         "title": "Move", 
                         "support_async": true, 
                         "class": "move", 
                         "href": "/api/tool/DataMove/?hierarchy=[hierarchy]&model_type=device/cuc/SmsDevice", 
                         "method": "POST", 
                         "view": "/api/tool/DataMove/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export": {
                         "title": "Export", 
                         "support_async": false, 
                         "submit": "payload", 
                         "class": "export", 
                         "href": "/api/device/cuc/SmsDevice/export/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "view": "/api/view/ExportData/add/?auth_token=[authtoken]
                    }
               }, 
               {
                    "export_bulkload_template": {
                         "support_async": false, 
                         "class": "bulkload_template", 
                         "href": "/api/device/cuc/SmsDevice/export_bulkload_template/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Export Bulk Load Template"
                    }
               }, 
               {
                    "configuration_template": {
                         "support_async": false, 
                         "class": "config", 
                         "href": "/api/device/cuc/SmsDevice/configuration_template/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Configuration Template"
                    }
               }, 
               {
                    "field_display_policy": {
                         "support_async": false, 
                         "class": "display_policy", 
                         "href": "/api/device/cuc/SmsDevice/field_display_policy/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Field Display Policy"
                    }
               }, 
               {
                    "list": {
                         "support_async": false, 
                         "class": "list", 
                         "href": "/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "List"
                    }
               }, 
               {
                    "help": {
                         "support_async": false, 
                         "class": "help", 
                         "href": "/api/device/cuc/SmsDevice/help?hierarchy=[hierarchy]", 
                         "method": "GET", 
                         "title": "Help"
                    }
               }, 
               {
                    "purge": {
                         "support_async": false, 
                         "class": "purge", 
                         "href": "/api/device/cuc/SmsDevice/purge/?hierarchy=[hierarchy]", 
                         "method": "POST", 
                         "title": "Purge"
                    }
               }
          ], 
          "model_type": "device/cuc/SmsDevice", 
          "model_specific_actions": [
               "add", 
               "list", 
               "update", 
               "get", 
               "remove", 
               "bulk_update_form", 
               "clone", 
               "configuration_template", 
               "export", 
               "export_bulkload_template", 
               "field_display_policy", 
               "help", 
               "move"
          ], 
          "summary_attrs": [
               {
                    "name": "DisplayName", 
                    "title": "Display Name"
               }, 
               {
                    "allow_filtering": true, 
                    "name": "hierarchy_friendly_name", 
                    "title": "Located At"
               }
          ], 
          "api_version": "21.2", 
          "tagged_versions": []
     }, 
     "resources": []
}

Task	Call	URL	Parameters	Response
Get the on-line Help for device/cuc/SmsDevice.	GET	/api/device/cuc/SmsDevice/help	hierarchy=[hierarchy]	On-line help of Model ref.: device/cuc/SmsDevice as HTML

Instance API Reference

[pkid] is the ID of the resource instance.
If a payload is required, inspect the schema for payload details.

Task	Call	URL	Parameters	Payload
Modify	PUT	/api/device/cuc/SmsDevice/[pkid]	hierarchy=[hierarchy]	(For payload specification)

For Bulk modification, refer to the Bulk Modify section.

Task	Call	URL	Parameters	Response
Delete	DELETE	/api/device/cuc/SmsDevice/[pkid]	hierarchy=[hierarchy]

Task	Call	URL	Parameters	Response
Clone instance with [pkid]. The schema rules are applied.	GET	/api/device/cuc/SmsDevice/[pkid]/clone/?schema=&schema_rules=true	hierarchy=[hierarchy]	A JSON payload with: A POST action URL. The unchanged model [pkid] payload to be modified to create a new instance.

For the instance pkids that can cloned, refer to the List GET call for device/cuc/SmsDevice

GET http://[host-proxy]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json

Use the POST action in the response with a modification of the response payload to create the clone.

Task	Call	URL	Parameters	Payload
Move	POST	/api/tool/DataMove/[pkid]/?model_type=device/cuc/SmsDevice	hierarchy=[hierarchy]	If payload required:

Task	Call	URL	Parameters	Response
Get a selected [export_format] of the schema and a single instance with [pkid] of device/cuc/SmsDevice; optionally with tag_version at [version] and Configuration Template as [configtemplate].	GET	/api/device/cuc/SmsDevice/[pkid]/export	hierarchy=[hierarchy] version=[version] schema= schema_rules= template_name=[configtemplate] export_format=[raw_xlsx\|xlsx\|json]	The response is an attachment. Refer to the list below.

For export_format=raw_xlsx, the response is a "raw" MS Excel spreadsheet with columns corresponding to the JSON format export and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=xlsx, the response is a MS Excel spreadsheet, formatted to show all columns and a response format:

        Content-Disposition: attachment; filename=<resource_type>_<resource_name>_exportedsheet_formatted_CCYY-MM-DD_HH-MM-SS.xlsx
        Content-Language:en
        Content-Type:application/vnd.openxmlformats-officedocument.spreadsheetml.sheet

For export_format=json, the response is a time stamped zip file of data in JSON and a response format:

        Content-Disposition: attachment; filename=export_2013-05-17_14:20:19.186444.json.zip
        Content-Language:en
        Content-Type:application/x-zip

The XLSX format can be used to bulk load instances of device/cuc/SmsDevice and the JSON format can be used to import instances of device/cuc/SmsDevice.

For Bulk Export, refer to the Bulk Export section.

Task	Call	URL	Parameters	Response
Get	GET	/api/device/cuc/SmsDevice/[pkid]	hierarchy=[hierarchy]	The device/cuc/SmsDevice instance with [pkid].

Task	Call	URL	Parameters	Response
Help	GET	/api/device/cuc/SmsDevice/[pkid]/help	hierarchy=[hierarchy]	The on-line Help for device/cuc/SmsDevice.

Task	Call	URL	Parameters	Payload
Purge	POST	/api/device/cuc/SmsDevice/[pkid]/purge	hierarchy=[hierarchy]	If payload required:

API Reference for device/cuc/SmsDevice

GET http://[host-proxy]/api/device/cuc/SmsDevice/schema/?hierarchy=[hierarchy]&format=json&schema=1

Get the Add form

Create

Bulk Delete

Bulk Modify

Move

Bulk Export

Export Bulk Load Template

Configuration Template

Field Display Policy

List

GET http://[host]/api/device/cuc/SmsDevice/?hierarchy=[hierarchy]&format=json&limit=3&skip=0

Help

Instance API Reference

Modify

Delete

Clone

Move

Export

Get

Help

Purge