msdyn_ocsystemmessage Entity Reference

Omnichannel for Customer Service offers a suite of capabilities that extend the power of Dynamics 365 Customer Service Enterprise to enable organizations to instantly connect and engage with their customers across digital messaging channels. An additional license is required to access Omnichannel for Customer Service. For more information, see the Dynamics 365 Customer Service pricing overview and Dynamics 365 Customer Service pricing plan pages.

Stores the system messages sent to the message receiver for various events.

Added by: Omnichannel – Base Solution

Messages

Message Web API Operation SDK Assembly
Create POST [org URI]/api/data/v9.1/msdyn_ocsystemmessages
See Create
CreateRequest or
Create
Delete DELETE [org URI]/api/data/v9.1/msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
See Delete
DeleteRequest or
Delete
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
Retrieve GET [org URI]/api/data/v9.1/msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.1/msdyn_ocsystemmessages
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
SetState PATCH [org URI]/api/data/v9.1/msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.1/msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
See Update
UpdateRequest or
Update

Entity Properties

Property Value
CollectionSchemaName msdyn_ocsystemmessages
DisplayCollectionName System Messages
DisplayName System Message
EntitySetName msdyn_ocsystemmessages
IsBPFEntity False
LogicalCollectionName msdyn_ocsystemmessages
LogicalName msdyn_ocsystemmessage
OwnershipType OrganizationOwned
PrimaryIdAttribute msdyn_ocsystemmessageid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_ocsystemmessage

Writable attributes

These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.

ImportSequenceNumber

Property Value
Description Sequence number of the import that created this record.
DisplayName Import Sequence Number
Format None
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName importsequencenumber
MaxValue 2147483647
MinValue -2147483648
RequiredLevel None
Type Integer

msdyn_messagedescription

Property Value
Description Description of the message.
DisplayName Message Description
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_messagedescription
MaxLength 2000
RequiredLevel ApplicationRequired
Type Memo

msdyn_messagereceiver

Property Value
Description Stores the list of message receivers.
DisplayName Message Receiver
IsValidForForm True
IsValidForRead True
LogicalName msdyn_messagereceiver
RequiredLevel ApplicationRequired
Type Picklist

msdyn_messagereceiver Options

Value Label
192350000 Agent
192350001 Customer

msdyn_messagetext

Property Value
Description Text sent to the message receiver.
DisplayName Message Text
Format Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_messagetext
MaxLength 2000
RequiredLevel ApplicationRequired
Type Memo

msdyn_name

Property Value
Description The name of the custom entity.
DisplayName Name
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_name
MaxLength 100
RequiredLevel None
Type String

msdyn_ocsystemmessageId

Property Value
Description Unique identifier for entity instances
DisplayName System Message
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_ocsystemmessageid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_streamsource

Property Value
Description List of all available channels.
DisplayName Channel
IsValidForForm True
IsValidForRead True
LogicalName msdyn_streamsource
RequiredLevel ApplicationRequired
Type Picklist

msdyn_streamsource Options

Value Label
19241000 Microsoft Teams
192300000 WhatsApp
192310000 LINE
192320000 WeChat
192330000 Facebook
192340000 SMS
192350000 Entity Records
192350001 Twitter
192350002 Custom
192360000 Live chat
192370000 Voice
192380000 Video
192390000 Co-browse
192400000 Screen sharing

msdyn_systemmessageeventtype

Property Value
Description Stores the list of event types for system messages.
DisplayName System Message Event Type
IsValidForForm True
IsValidForRead True
LogicalName msdyn_systemmessageeventtype
RequiredLevel ApplicationRequired
Type Picklist

msdyn_systemmessageeventtype Options

Value Label
192350000 AgentAccepted
192350001 ConsultAccepted
192350002 TransferAccepted
192350003 ConsultInitiated
192350004 ConsultFailed
192350005 TransferInitiated
192350006 TransferFailed
192350007 ConsultRejected
192350008 TransferRejected
192350009 ConsultTimedOut
192350010 TransferTimedOut
192350011 TransferToQueueInitiated
192350012 TransferToQueueFailed
192350013 AgentDisconnected
192350014 AgentEnded
192350015 SessionClosed
192350016 ConsultSessionClosed
192350017 AgentAssignmentReady
192350018 AgentAssignmentFailure
192350019 CustomerEnded
192350020 CustomerDisconnected
192350021 CustomerQueuePosition_LiveChat
192350022 MessageFailedToSendToCustomer
192350023 OutsideOperationHours
192350024 CustomerQueuePosition_Next
192350025 UnsupportedMessageType
192350026 SecondaryChannelRequested
192350027 SecondaryChannelAccepted
192350028 SecondaryChannelDeclined
192350029 MessageSentOutsideConversationWindow
192350030 CustomerAverageWaitTime_Minutes
192350031 CustomerAverageWaitTime_Hours
192350032 CustomerAverageWaitTime_HoursAndMinutes
192350033 SecondaryChannelEnded

msdyn_widgetid

Added by: Omnichannel - Chat Patch Solution

Property Value
Description Unique identifier for Chat Widget associated with System Message.
DisplayName Widget
IsValidForForm True
IsValidForRead True
LogicalName msdyn_widgetid
RequiredLevel None
Targets msdyn_livechatconfig
Type Lookup

OverriddenCreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time that the record was migrated.
DisplayName Record Created On
Format DateOnly
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName overriddencreatedon
RequiredLevel None
Type DateTime

statecode

Property Value
Description Status of the System Message
DisplayName Status
IsValidForCreate False
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State

statecode Options

Value Label DefaultStatus InvariantName
0 Active 1 Active
1 Inactive 2 Inactive

statuscode

Property Value
Description Reason for the status of the System Message
DisplayName Status Reason
IsValidForForm True
IsValidForRead True
LogicalName statuscode
RequiredLevel None
Type Status

statuscode Options

Value Label State
1 Active 0
2 Inactive 1

TimeZoneRuleVersionNumber

Property Value
Description For internal use only.
DisplayName Time Zone Rule Version Number
Format None
IsValidForForm False
IsValidForRead True
LogicalName timezoneruleversionnumber
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

UTCConversionTimeZoneCode

Property Value
Description Time zone code that was in use when the record was created.
DisplayName UTC Conversion Time Zone Code
Format None
IsValidForForm False
IsValidForRead True
LogicalName utcconversiontimezonecode
MaxValue 2147483647
MinValue -1
RequiredLevel None
Type Integer

Read-only attributes

These attributes return false for both IsValidForCreate or IsValidForUpdate. Listed by SchemaName.

CreatedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who created the record.
DisplayName Created By
IsValidForForm True
IsValidForRead True
LogicalName createdby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyname
MaxLength 100
RequiredLevel None
Type String

CreatedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

CreatedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was created.
DisplayName Created On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName createdon
RequiredLevel None
Type DateTime

CreatedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who created the record.
DisplayName Created By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName createdonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

CreatedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

CreatedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName createdonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the user who modified the record.
DisplayName Modified By
IsValidForForm True
IsValidForRead True
LogicalName modifiedby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

ModifiedOn

Property Value
DateTimeBehavior UserLocal
Description Date and time when the record was modified.
DisplayName Modified On
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName modifiedon
RequiredLevel None
Type DateTime

ModifiedOnBehalfBy

Added by: Active Solution Solution

Property Value
Description Unique identifier of the delegate user who modified the record.
DisplayName Modified By (Delegate)
IsValidForForm True
IsValidForRead True
LogicalName modifiedonbehalfby
RequiredLevel None
Targets systemuser
Type Lookup

ModifiedOnBehalfByName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyname
MaxLength 100
RequiredLevel None
Type String

ModifiedOnBehalfByYomiName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName modifiedonbehalfbyyominame
MaxLength 100
RequiredLevel SystemRequired
Type String

msdyn_widgetidName

Added by: Omnichannel - Chat Patch Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_widgetidname
MaxLength 100
RequiredLevel None
Type String

OrganizationId

Added by: Active Solution Solution

Property Value
Description Unique identifier for the organization
DisplayName Organization Id
IsValidForForm False
IsValidForRead True
LogicalName organizationid
RequiredLevel None
Targets organization
Type Lookup

OrganizationIdName

Added by: Active Solution Solution

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName organizationidname
MaxLength 100
RequiredLevel SystemRequired
Type String

VersionNumber

Added by: Active Solution Solution

Property Value
Description Version Number
DisplayName Version Number
IsValidForForm False
IsValidForRead True
LogicalName versionnumber
MaxValue 9223372036854775807
MinValue -9223372036854775808
RequiredLevel None
Type BigInt

One-To-Many Relationships

Listed by SchemaName.

msdyn_ocsystemmessage_msdyn_oclocalizationdata

Added by: Omnichannel - Base Patch Solution

Same as msdyn_oclocalizationdata entity msdyn_ocsystemmessage_msdyn_oclocalizationdata Many-To-One relationship.

Property Value
ReferencingEntity msdyn_oclocalizationdata
ReferencingAttribute msdyn_systemmessageid
IsHierarchical False
IsCustomizable False
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_msdyn_oclocalizationdata
AssociatedMenuConfiguration Behavior: UseCollectionName
Group: Details
Label:
Order: 10000
CascadeConfiguration Assign: NoCascade
Delete: Cascade
Merge: NoCascade
Reparent: NoCascade
Share: NoCascade
Unshare: NoCascade

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related entity. Listed by SchemaName.

msdyn_livechatconfig_msdyn_ocsystemmessage

Added by: Omnichannel – Chat Solution

See msdyn_livechatconfig Entity msdyn_livechatconfig_msdyn_ocsystemmessage One-To-Many relationship.

Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service