[Index]

Model: device/cuc/SmsDevice

Model Details: device/cuc/SmsDevice

Title Description Details
Display Name * 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.
  • Field Name: DisplayName
  • Type: String
Smpp Provider Object Id * The unique identifier of the SMPPProvider object that is used by this notification device.
  • Field Name: SmppProviderObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/SmppProvider/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24ryCMMNyyeCApU3Zd%24X6jGTgw/2WRwlhydCVQgNg3PsNWbTS06p9geJzt1IBreNghS0ZPHOLL1im24iplDhc%2B8ymqKgllK29qbeHadGnDZSVtmxSP0crlynNDVOzDbDoUYClIPvE6cUQwt8Ya7IT0Jz7sBr%2BTuriNG8oIsmFETA5%2B1qND8NsPIMyriTLvd1gn8QREehlLS3Qn4paRI1oTLd/hKmrSEnk2UBavfy9M7e70NR0cIgtFYL/eoJ4TEhKbhauZOhL09dO0ZJspYQDl%2BFf3LYo8d8O28L15%2BZ5eZeOHPZigilmglAYwzufjNnUA5cRF4/ZIgUe2Zo8IqXBw86lWNJ4QY8KXKdsqUv0ILCAiOG3JTeRQuqtvBh3KSvSvkklL85yGc987Co24CS0kK9ISObhGmAUAHVwXUlJB2WP3fdQxKdxv29ehFfjKHzbd4SWbbiHs4ZHJMxbrs%2BdNRyy2XF37tOLyYD1sxNiiEZXZ7v74YdOfqAMVmhOobRn1g1RqmiWKsRNMS5ifVGJqE%2BQ%3D%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/SmppProvider
  • Format: uri
  • Choices: []
User URI
  • Field Name: UserURI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24yBk7KkC4vSALjtSf%243sT5dERO82mgCwSMkrD%2BWFpRPVc4fdzlzx16VBfnsGFjB/Tv1vupPLQ1WnAb07QV6fD3yw9iHIQq56o8nITL5wpP96Sbh7zLHyjUBmDK5BDsyQwicniCRmlDyZv6gDp3k%2BbUT0TaPtyAWXEsvmHOcUWF%2BHK8BrEH0fVpgun58VspOQRllre4L1LaqbgrqsXIwZUaaPhLzEcL6F0V1W5EiQovQRADOolmpHR/oNrAbPpNLMLFOMM6IeOOH2RIstaZAOyODVeQy09EkPFUNBGsRjxQHJhxIzeyq7Izyva1FSdzWJ6u%2BqJ08/ziwLlJ8a9VAib5rDphEReq80vXJVJMsv31CozJrWTQz8ITWFEvqJfFTvbI6lkgWHBrax6lnlB8FVm20jaCzkZ9/9ydqbqRint4HQ7XFhmLqLlAwbWOP658uTT5uL7DzDcKkqMmBQ7QKNC7h0/A4EzPkTNs1Q%3D%3D%24%3D%3D
  • Format: uri
  • Choices: []
Recipient Address The phone number of the SMS-compatible device to receive the message. In CUSA, this is referred to as the "To:" field.
  • Field Name: RecipientAddress
  • Type: String
Send Count 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.
  • Field Name: SendCount
  • Type: Boolean
Max Subject The maximum number of characters allowed in the 'subject' of a notification message.
  • Field Name: MaxSubject
  • Type: Integer
Max Body The maximum number of characters allowed in the 'body' of a notification message.
  • Field Name: MaxBody
  • Type: Integer
Subscriber Object Id * The unique identifier of the Subscriber object to which this notification device belongs. - template parameter [1]
  • Field Name: SubscriberObjectId
  • Type: ["String"]
  • Target: /api/device/cuc/User/choices/?field=ObjectId&format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24vJvuxO2nV97evfK0%24BDLEngvOBMCXOplrBD8g/DaRI5IFA0pXUWfE%2B/gI25W97N2oGEvW018gjlHzTHu08jhLNKZN%2BYkGve7meXPm93ANAlqEA0D3ak4vABxXnQr1cJdhBCkb5iOEw05YZYjHO2%2BEorD0BidQqJoSdBDhkVboEGWHX2AzXyLlSS0M99Fjt7O32w38vYLPHXoqOcyjx2LSHjFHZQbwKKDRomnOW6lUeEoXJGZUtGF7RfqjC39Mzzltwz64UXBetXz9ZiPqX2EB5tWO4xIzZHLKR4R8e5i1EK7iygKvEcEwRrQq6jbo5pvtjuKhyR8RVpAdLOMoYaAnVa1i6slaTckyYrl5dgES96CUpJvMvuX7vH%2BQCKZxX11BqFrJbUlagjV%2BXgKicpPGWfcftYCEyr469FglCzZousre85zcB7S%2BO9HePMe2SasIhw2c%2BIicKejfifEDPGChW06BoELAhncOZLIy6J8BgA1TDaZaGhJgv6Pr3s5pitIM8fIaxRvlFMI%3D%24%3D%3D
  • Target attr: ObjectId
  • Target Model Type: device/cuc/User
  • Format: uri
  • Choices: []
Schedule Set Object Id ObjectId of the ScheduleSet for when the notification rule is active.
  • Field Name: ScheduleSetObjectId
  • Type: String
Sender Address 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.
  • Field Name: SenderAddress
  • Type: String
Active A flag indicating whether the device is active or inactive (enabled/disabled).
  • Field Name: Active
  • Type: Boolean
Repeat Interval The amount of time (in minutes) Cisco Unity Connection will wait before re-notifying a subscriber of new messages.
  • Field Name: RepeatInterval
  • Type: Integer
Object Id The primary key for this table. A globally unique, system-generated identifier for a NotificationDeviceSMS object. - template parameter [2]
  • Field Name: ObjectId
  • Type: String
Device Name The "DeviceName" of the notification device.
  • Field Name: DeviceName
  • Type: String
Event List Comma separated list of events that trigger notification rules to be evaluated.
  • Field Name: EventList
  • Type: String
Send Caller Id A flag indicating whether Cisco Unity Connection will include the caller id (if available) with the notification message.
  • Field Name: SendCallerId
  • Type: Boolean
URI
  • Field Name: URI
  • Type: String
  • Target: /api/choices/?format=json&hierarchy=[hierarchy]&auth_token=%3D%3D%24yBk7KkC4vSALjtSf%243sT5dERO82mgCwSMkrD%2BWFpRPVc4fdzlzx16VBfnsGFjB/Tv1vupPLQ1WnAb07QV6fD3yw9iHIQq56o8nITL5wpP96Sbh7zLHyjUBmDK5BDsyQwicniCRmlDyZv6gDp3k%2BbUT0TaPtyAWXEsvmHOcUWF%2BHK8BrEH0fVpgun58VspOQRllre4L1LaqbgrqsXIwZUaaPhLzEcL6F0V1W5EiQovQRADOolmpHR/oNrAbPpNLMLFOMM6IeOOH2RIstaZAOyODVeQy09EkPFUNBGsRjxQHJhxIzeyq7Izyva1FSdzWJ6u%2BqJ08/ziwLlJ8a9VAib5rDphEReq80vXJVJMsv31CozJrWTQz8ITWFEvqJfFTvbI6lkgWHBrax6lnlB8FVm20jaCzkZ9/9ydqbqRint4HQ7XFhmLqLlAwbWOP658uTT5uL7DzDcKkqMmBQ7QKNC7h0/A4EzPkTNs1Q%3D%3D%24%3D%3D
  • Format: uri
  • Choices: []
Static Text 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. Typically holds email address. Also holds text for text pagers. SA text pager calls this 'send text'. It is empty for numeric pagers.
  • Field Name: StaticText
  • Type: String
Undeletable Device cannot be deleted.
  • Field Name: Undeletable
  • Type: Boolean
Fail Device Object Id ObjectId of the NotificationDevice that Cisco Unity Connection will use if attempted notification to this device fails.
  • Field Name: FailDeviceObjectId
  • Type: String
Initial Delay The amount of time (in minutes) from the time when a message is received until message notification triggers.
  • Field Name: InitialDelay
  • Type: Integer
Repeat Notify A flag indicating whether Cisco Unity Connection begins a notification process immediately upon the arrival of each message that matches the specified critera.
  • Field Name: RepeatNotify
  • Type: Boolean