Message (msdyn_ocsystemmessage) table/entity reference (Microsoft Dynamics 365)

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

Messages

The following table lists the messages for the Message (msdyn_ocsystemmessage) table. Messages represent operations that can be performed on the table. They may also be events.

Name
Is Event?
Web API Operation SDK for .NET
Associate
Event: True
Associate records Associate records
BulkRetain
Event: True
BulkRetain Learn to use messages with the SDK for .NET
Create
Event: True
POST /msdyn_ocsystemmessages
See Create
Create records
CreateMultiple
Event: True
CreateMultiple CreateMultipleRequest
Delete
Event: True
DELETE /msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
See Delete
Delete records
Disassociate
Event: True
Disassociate records Disassociate records
IsValidStateTransition
Event: False
IsValidStateTransition IsValidStateTransitionRequest
PurgeRetainedContent
Event: True
PurgeRetainedContent Learn to use messages with the SDK for .NET
Restore
Event: True
Restore Learn to use messages with the SDK for .NET
Retain
Event: True
Retain Learn to use messages with the SDK for .NET
Retrieve
Event: True
GET /msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
See Retrieve
Retrieve records
RetrieveMultiple
Event: True
GET /msdyn_ocsystemmessages
See Query data
Query data
RollbackRetain
Event: True
RollbackRetain Learn to use messages with the SDK for .NET
SetState
Event: True
PATCH /msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
Update the statecode and statuscode properties.
SetStateRequest
Update
Event: True
PATCH /msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
See Update
Update records
UpdateMultiple
Event: True
UpdateMultiple UpdateMultipleRequest
Upsert
Event: False
PATCH /msdyn_ocsystemmessages(msdyn_ocsystemmessageid)
See Upsert a table row
UpsertRequest
UpsertMultiple
Event: False
UpsertMultiple UpsertMultipleRequest
ValidateRetentionConfig
Event: True
ValidateRetentionConfig Learn to use messages with the SDK for .NET

Properties

The following table lists selected properties for the Message (msdyn_ocsystemmessage) table.

Property Value
DisplayName Message
DisplayCollectionName Messages
SchemaName msdyn_ocsystemmessage
CollectionSchemaName msdyn_ocsystemmessages
EntitySetName msdyn_ocsystemmessages
LogicalName msdyn_ocsystemmessage
LogicalCollectionName msdyn_ocsystemmessages
PrimaryIdAttribute msdyn_ocsystemmessageid
PrimaryNameAttribute msdyn_name
TableType Standard
OwnershipType OrganizationOwned

Writable columns/attributes

These columns/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
IsValidForForm False
IsValidForRead True
LogicalName importsequencenumber
RequiredLevel None
Type Integer
MaxValue 2147483647
MinValue -2147483648

msdyn_defaultlanguage

Property Value
Description Default language of the message template.
DisplayName Default language
IsValidForForm True
IsValidForRead True
LogicalName msdyn_defaultlanguage
RequiredLevel ApplicationRequired
Type Lookup
Targets msdyn_oclanguage

msdyn_instanceid

Property Value
Description ID of the instance this system message is related to, represented in text form.
DisplayName Instance ID
IsValidForForm True
IsValidForRead True
LogicalName msdyn_instanceid
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

msdyn_messagedescription

Property Value
Description Description of the message.
DisplayName Message description
IsValidForForm True
IsValidForRead True
LogicalName msdyn_messagedescription
RequiredLevel None
Type Memo
Format Text
FormatName Text
ImeMode Auto
IsLocalizable False
MaxLength 2000

msdyn_messagereceiver

Property Value
Description Stores the list of message receivers.
DisplayName Message recipient
IsValidForForm True
IsValidForRead True
LogicalName msdyn_messagereceiver
RequiredLevel ApplicationRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName msdyn_ocmessagereceiver

msdyn_messagereceiver Choices/Options

Value Label
192350000 Agent
192350001 Customer

msdyn_messagetemplatetrigger

Property Value
Description Stores the list of event types for message template
DisplayName Message template trigger
IsValidForForm True
IsValidForRead True
LogicalName msdyn_messagetemplatetrigger
RequiredLevel ApplicationRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName msdyn_ocmessagetemplatetrigger

msdyn_messagetemplatetrigger Choices/Options

Value Label
1 Outside 24-hour conversation window

msdyn_messagetext

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

msdyn_messagetype

Property Value
Description Stores the list of event types for system messages.
DisplayName Message type
IsValidForForm True
IsValidForRead True
LogicalName msdyn_messagetype
RequiredLevel None
Type Picklist
DefaultFormValue -1
GlobalChoiceName msdyn_ocsystemmessagetype

msdyn_messagetype Choices/Options

Value Label
2 Automated Message
3 Message Template

msdyn_name

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

msdyn_ocsystemmessageId

Property Value
Description Unique identifier for entity instances
DisplayName Message
IsValidForForm False
IsValidForRead True
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
DefaultFormValue -1
GlobalChoiceName msdyn_streamsource

msdyn_streamsource Choices/Options

Value Label
192350000 Entity Records

msdyn_systemmessageeventtype

Property Value
Description Stores the list of event types for system messages.
DisplayName Message trigger
IsValidForForm True
IsValidForRead True
LogicalName msdyn_systemmessageeventtype
RequiredLevel ApplicationRequired
Type Picklist
DefaultFormValue -1
GlobalChoiceName msdyn_ocsystemmessageeventtype

msdyn_systemmessageeventtype Choices/Options

Value Label
192350000 Agent joined conversation
192350001 Consult accepted
192350002 Transfer to agent accepted
192350003 Consult started
192350004 Consult request failed
192350005 Transfer to agent requested
192350006 Transfer to agent failed
192350007 Consult rejected
192350008 Transfer to agent rejected
192350009 Consult request timed out
192350010 Transfer to agent timed out
192350011 Transfer to queue started
192350012 Transfer to queue failed
192350013 Agent disconnected from conversation
192350014 Agent ended conversation
192350015 Session ended
192350016 Consult session ended
192350017 Agent assigned to conversation
192350018 Agent couldn't be assigned to conversation
192350019 Customer ended conversation
192350020 Customer disconnected
192350021 Customer's position in queue
192350022 Agent's message couldn't be sent
192350023 Customer's message couldn't be sent: Outside of operation hours
192350024 Customer is next in line
192350025 Message couldn't be delivered: Unsupported message type
192350026 Voice call requested
192350027 Voice call accepted
192350028 Voice call declined
192350029 Message couldn't be sent: Outside allowed timeframe
192350030 Average wait time for customers: Minutes
192350031 Average wait time for customers: Hours
192350032 Average wait time for customers: Hours and minutes
192350033 Voice call ended
192350034 Message couldn’t be sent: A channel account can’t message another account within Omnichannel
192350035 Holiday message to customer
192350036 Out of operating hour message to customer
192350037 Couldn’t find the channel account in Omnichannel
192350038 Customer's file couldn't be attached because it's too big
192350039 Transfer to out of operating hour queue
192350040 Message couldn’t be sent: File couldn’t be attached
192350041 Leave as many messages as you’d like and we’ll get back to you as soon as possible. We’ll save your chat history, so you can leave and come back anytime.
192350042 Customer put on hold.
192350043 Customer no longer on hold.
192350044 Message or attachment failed to send. Providing error details including error code, reason for failure, message id, timestamp, and transaction id
192350045 Transcription started.
192350046 Transcription paused.
192350047 Transcription resumed.
192350048 Transcription stopped.
192350049 Recording and transcription started.
192350050 Recording and transcription paused.
192350051 Recording and transcription resumed.
192350052 Recording and transcription stopped.
192350053 Trial usage limit exceeded
192350054 Trial conversation time limit exceeded
192350055 End conversation due to overflow
192350056 Greeting Message for Async Channels and Voice
192350057 Customer has opted out from Async Conversation
192350058 Agent left consult conversation
192350059 Agent left customer conversation
192350060 Agent accepted consult conversation
192350061 Agent joined customer conversation
192350062 Agent ended consult conversation
192350063 Agent removed from consult conversation
192350064 Not enough data for average wait time
192350070 Waiting time for agent when customer is disconnected
192350071 Invalid Apple OAuth response
192350072 Supervisor force closed the conversation
192350073 Offer customer callback
192350074 Customer callback response
192370001 Customer's message couldn't be sent: Service is down.

OverriddenCreatedOn

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

statecode

Property Value
Description Status of the System Message
DisplayName Status
IsValidForForm True
IsValidForRead True
LogicalName statecode
RequiredLevel SystemRequired
Type State
DefaultFormValue
GlobalChoiceName msdyn_ocsystemmessage_statecode

statecode Choices/Options

Value Details
0 Label: Active
DefaultStatus: 1
InvariantName: Active
1 Label: Inactive
DefaultStatus: 2
InvariantName: 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
DefaultFormValue
GlobalChoiceName msdyn_ocsystemmessage_statuscode

statuscode Choices/Options

Value Details
1 Label: Active
State:0
TransitionData: None
2 Label: Inactive
State:1
TransitionData: None

TimeZoneRuleVersionNumber

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

UTCConversionTimeZoneCode

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

Read-only columns/attributes

These columns/attributes return false for both IsValidForCreate and IsValidForUpdate. Listed by SchemaName.

CreatedBy

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

CreatedOn

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

CreatedOnBehalfBy

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
Type Lookup
Targets systemuser

ModifiedBy

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

ModifiedOn

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

ModifiedOnBehalfBy

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
Type Lookup
Targets systemuser

OrganizationId

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

VersionNumber

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

Many-to-One relationships

These relationships are many-to-one. Listed by SchemaName.

lk_msdyn_ocsystemmessage_createdby

One-To-Many Relationship: systemuser lk_msdyn_ocsystemmessage_createdby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdby
ReferencingEntityNavigationPropertyName createdby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_ocsystemmessage_createdonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_ocsystemmessage_createdonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute createdonbehalfby
ReferencingEntityNavigationPropertyName createdonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_ocsystemmessage_modifiedby

One-To-Many Relationship: systemuser lk_msdyn_ocsystemmessage_modifiedby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedby
ReferencingEntityNavigationPropertyName modifiedby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

lk_msdyn_ocsystemmessage_modifiedonbehalfby

One-To-Many Relationship: systemuser lk_msdyn_ocsystemmessage_modifiedonbehalfby

Property Value
ReferencedEntity systemuser
ReferencedAttribute systemuserid
ReferencingAttribute modifiedonbehalfby
ReferencingEntityNavigationPropertyName modifiedonbehalfby
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

msdyn_msdyn_oclanguage_msdyn_ocsystemmessage_defaultlanguage

One-To-Many Relationship: msdyn_oclanguage msdyn_msdyn_oclanguage_msdyn_ocsystemmessage_defaultlanguage

Property Value
ReferencedEntity msdyn_oclanguage
ReferencedAttribute msdyn_oclanguageid
ReferencingAttribute msdyn_defaultlanguage
ReferencingEntityNavigationPropertyName msdyn_defaultlanguage
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: RemoveLink
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

organization_msdyn_ocsystemmessage

One-To-Many Relationship: organization organization_msdyn_ocsystemmessage

Property Value
ReferencedEntity organization
ReferencedAttribute organizationid
ReferencingAttribute organizationid
ReferencingEntityNavigationPropertyName organizationid
IsHierarchical
CascadeConfiguration Archive: NoCascade
Assign: NoCascade
Delete: NoCascade
Merge: NoCascade
Reparent: NoCascade
RollupView: NoCascade
Share: NoCascade
Unshare: NoCascade

One-to-Many relationships

These relationships are one-to-many. Listed by SchemaName.

msdyn_ocsystemmessage_AsyncOperations

Many-To-One Relationship: asyncoperation msdyn_ocsystemmessage_AsyncOperations

Property Value
ReferencingEntity asyncoperation
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_AsyncOperations
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocsystemmessage_BulkDeleteFailures

Many-To-One Relationship: bulkdeletefailure msdyn_ocsystemmessage_BulkDeleteFailures

Property Value
ReferencingEntity bulkdeletefailure
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_BulkDeleteFailures
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocsystemmessage_DuplicateBaseRecord

Many-To-One Relationship: duplicaterecord msdyn_ocsystemmessage_DuplicateBaseRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute baserecordid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_DuplicateBaseRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocsystemmessage_DuplicateMatchingRecord

Many-To-One Relationship: duplicaterecord msdyn_ocsystemmessage_DuplicateMatchingRecord

Property Value
ReferencingEntity duplicaterecord
ReferencingAttribute duplicaterecordid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_DuplicateMatchingRecord
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocsystemmessage_MailboxTrackingFolders

Many-To-One Relationship: mailboxtrackingfolder msdyn_ocsystemmessage_MailboxTrackingFolders

Property Value
ReferencingEntity mailboxtrackingfolder
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_MailboxTrackingFolders
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocsystemmessage_msdyn_oclocalizationdata

Many-To-One Relationship: msdyn_oclocalizationdata msdyn_ocsystemmessage_msdyn_oclocalizationdata

Property Value
ReferencingEntity msdyn_oclocalizationdata
ReferencingAttribute msdyn_systemmessageid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_msdyn_oclocalizationdata
IsCustomizable False
AssociatedMenuConfiguration AvailableOffline: True
Behavior: UseCollectionName
Group: Details
Label:
MenuId: null
Order: 10000
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocsystemmessage_PrincipalObjectAttributeAccesses

Many-To-One Relationship: principalobjectattributeaccess msdyn_ocsystemmessage_PrincipalObjectAttributeAccesses

Property Value
ReferencingEntity principalobjectattributeaccess
ReferencingAttribute objectid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_PrincipalObjectAttributeAccesses
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocsystemmessage_ProcessSession

Many-To-One Relationship: processsession msdyn_ocsystemmessage_ProcessSession

Property Value
ReferencingEntity processsession
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_ProcessSession
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

msdyn_ocsystemmessage_SyncErrors

Many-To-One Relationship: syncerror msdyn_ocsystemmessage_SyncErrors

Property Value
ReferencingEntity syncerror
ReferencingAttribute regardingobjectid
ReferencedEntityNavigationPropertyName msdyn_ocsystemmessage_SyncErrors
IsCustomizable True
AssociatedMenuConfiguration AvailableOffline: True
Behavior: DoNotDisplay
Group: Details
Label:
MenuId: null
Order:
QueryApi: null
ViewId: 00000000-0000-0000-0000-000000000000

See also

Dataverse table/entity reference
Dataverse Web API Reference