Model: device/cuc/Message

• An asterisk * in the title indicates the field is mandatory.
• If a field has a default value, it is shown in the Description column.
• If the field type is an array, the Field Name has a .[n] suffix, where n is the array index placeholder.
• Object and array field names are listed to provide context. If a field belongs to an object or an array, the full field name is shown in dot separated notation.

Title

Description

Details

From Sub

Field Name: FromSub Type: Boolean

From

Field Name: From Type: Object

Smtp Address

Field Name: From.SmtpAddress Type: String

Display Name

Field Name: From.DisplayName Type: String

Object Id

Field Name: From.ObjectId Type: String

Dtmf Access Id

Field Name: From.DtmfAccessId Type: String

User Guid

Field Name: From.UserGuid Type: String

Type

Field Name: From.Type Type: String Choices: ["SUBSCRIBER", "DISTRIBUTIONLIST", "PRIVATELIST", "CONTACT", "VPIMCONTACT"]

Priority

Field Name: Priority Type: String Choices: ["Normal", "Urgent"]

Session Id

Field Name: SessionId Type: String

Messageid

Query parameter

Field Name: messageid Type: ["String"] Target: device/cuc/Message Target attr: MsgId Format: uri

Caller Id

Field Name: CallerId Type: Object

Caller Name

Field Name: CallerId.CallerName Type: String

Caller Number

Field Name: CallerId.CallerNumber Type: String

Caller Image

Field Name: CallerId.CallerImage Type: String Format: uri

Read

Field Name: Read Type: Boolean

Folder URI

Field Name: FolderURI Type: String Format: uri

Is Sent

Field Name: IsSent Type: Integer

IMAP Uid

Field Name: IMAPUid Type: String

Future Delivery

Field Name: FutureDelivery Type: String

Is Deleted

Field Name: IsDeleted Type: Integer

Read Receipt Requested

Field Name: ReadReceiptRequested Type: Boolean

Media Hint

Field Name: MediaHint Type: String

URI

Field Name: URI Type: String Format: uri

Is Draft

Field Name: IsDraft Type: Boolean

Recipients

Field Name: Recipients Type: Object

Recipient

Field Name: Recipient.[n] Type: Array

Type

Field Name: Recipients.Recipient.[n].Type Type: String Choices: ["TO", "CC", "BCC"]

Address

Field Name: Address Type: Object

Smtp Address

Field Name: Recipients.Recipient.[n].Address.SmtpAddress Type: String

Display Name

Field Name: Recipients.Recipient.[n].Address.DisplayName Type: String

Object Id

Field Name: Recipients.Recipient.[n].Address.ObjectId Type: String

Dtmf Access Id

Field Name: Recipients.Recipient.[n].Address.DtmfAccessId Type: String

User Guid

Field Name: Recipients.Recipient.[n].Address.UserGuid Type: String

Type

Field Name: Recipients.Recipient.[n].Address.Type Type: String Choices: ["SUBSCRIBER", "DISTRIBUTIONLIST", "PRIVATELIST", "CONTACT", "VPIMCONTACT"]

Msg Type

Field Name: MsgType Type: String Choices: ["Email", "DR", "Voice", "RR", "Fax", "NDR", "Receipt", "Video", "Text", "Msg"]

Flagged

Field Name: Flagged Type: Boolean

Attachments

Field Name: Attachments Type: Object

Attachment

Field Name: Attachment.[n] Type: Array

Content Type

Field Name: Attachments.Attachment.[n].contentType Type: String

Content ID

Field Name: Attachments.Attachment.[n].contentID Type: String

URI

Field Name: Attachments.Attachment.[n].URI Type: String Format: uri

Embedded Message

Field Name: EmbeddedMessage Type: Object

From

Field Name: From Type: Object

Smtp Address

Field Name: Attachments.Attachment.[n].EmbeddedMessage.From.SmtpAddress Type: String

Display Name

Field Name: Attachments.Attachment.[n].EmbeddedMessage.From.DisplayName Type: String

Object Id

Field Name: Attachments.Attachment.[n].EmbeddedMessage.From.ObjectId Type: String

Dtmf Access Id

Field Name: Attachments.Attachment.[n].EmbeddedMessage.From.DtmfAccessId Type: String

User Guid

Field Name: Attachments.Attachment.[n].EmbeddedMessage.From.UserGuid Type: String

Type

Field Name: Attachments.Attachment.[n].EmbeddedMessage.From.Type Type: String Choices: ["SUBSCRIBER", "DISTRIBUTIONLIST", "PRIVATELIST", "CONTACT", "VPIMCONTACT"]

Recipients

Field Name: Recipients Type: Object

Recipient

Field Name: Recipient.[n] Type: Array

Type

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Recipients.Recipient.[n].Type Type: String Choices: ["TO", "CC", "BCC"]

Address

Field Name: Address Type: Object

Smtp Address

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Recipients.Recipient.[n].Address.SmtpAddress Type: String

Display Name

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Recipients.Recipient.[n].Address.DisplayName Type: String

Object Id

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Recipients.Recipient.[n].Address.ObjectId Type: String

Dtmf Access Id

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Recipients.Recipient.[n].Address.DtmfAccessId Type: String

User Guid

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Recipients.Recipient.[n].Address.UserGuid Type: String

Type

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Recipients.Recipient.[n].Address.Type Type: String Choices: ["SUBSCRIBER", "DISTRIBUTIONLIST", "PRIVATELIST", "CONTACT", "VPIMCONTACT"]

Caller Id

Field Name: CallerId Type: Object

Caller Name

Field Name: Attachments.Attachment.[n].EmbeddedMessage.CallerId.CallerName Type: String

Caller Number

Field Name: Attachments.Attachment.[n].EmbeddedMessage.CallerId.CallerNumber Type: String

Caller Image

Field Name: Attachments.Attachment.[n].EmbeddedMessage.CallerId.CallerImage Type: String Format: uri

Msg Id

Field Name: Attachments.Attachment.[n].EmbeddedMessage.MsgId Type: String

Sensitivity

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Sensitivity Type: String Choices: ["Normal", "Personal", "Private", "Confidential"]

Creation Time

Field Name: Attachments.Attachment.[n].EmbeddedMessage.CreationTime Type: Integer

URI

Field Name: Attachments.Attachment.[n].EmbeddedMessage.URI Type: String Format: uri

Priority

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Priority Type: String Choices: ["Normal", "Urgent"]

Msg Type

Field Name: Attachments.Attachment.[n].EmbeddedMessage.MsgType Type: String Choices: ["Email", "DR", "Voice", "RR", "Fax", "NDR", "Receipt", "Video", "Text", "Msg"]

Secure

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Secure Type: Boolean

Subject

Field Name: Attachments.Attachment.[n].EmbeddedMessage.Subject Type: String

Duration

Field Name: Attachments.Attachment.[n].Duration Type: Integer

Position

Field Name: Attachments.Attachment.[n].position Type: String

Content Transfer Encoding

Field Name: Attachments.Attachment.[n].contentTransferEncoding Type: String

Content Disposition

Field Name: Attachments.Attachment.[n].contentDisposition Type: String

Investigative Hold

Field Name: InvestigativeHold Type: Boolean

Secure

Field Name: Secure Type: Boolean

Subject

Field Name: Subject Type: String

Msg Id

template parameter [1]

Field Name: MsgId Type: String

Sensitivity

Field Name: Sensitivity Type: String Choices: ["Normal", "Personal", "Private", "Confidential"]

Delivery Receipt Requested

Field Name: DeliveryReceiptRequested Type: Boolean

Dispatch

Field Name: Dispatch Type: Boolean

Modification Time

Field Name: ModificationTime Type: Integer

Is Future

Field Name: IsFuture Type: Integer

Arrival Time

Field Name: ArrivalTime Type: Integer

Duration

Field Name: Duration Type: Integer

Userobjectid

Query parameter

Field Name: userobjectid Type: ["String"] Target: device/cuc/User Target attr: ObjectId Format: uri

Size

Field Name: Size Type: Integer