msdyn_sessionparticipant 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.

Users in a session interacting with the customer

Added by: Omnichannel – Base Solution

Messages

Message	Web API Operation	SDK Assembly
Assign	PATCH [org URI]/api/data/v9.0/msdyn_sessionparticipants(msdyn_sessionparticipantid) Update ownerid property.	AssignRequest
BulkRetain	BulkRetain Action	Microsoft.Crm.Sdk.Messages.BulkRetainRequest
Create	POST [org URI]/api/data/v9.0/msdyn_sessionparticipants See Create	CreateRequest or Create
CreateMultiple	CreateMultiple Action	CreateMultipleRequest
Delete	DELETE [org URI]/api/data/v9.0/msdyn_sessionparticipants(msdyn_sessionparticipantid) See Delete	DeleteRequest or Delete
GrantAccess	GrantAccess Action	GrantAccessRequest
IsValidStateTransition	IsValidStateTransition Function	IsValidStateTransitionRequest
ModifyAccess	ModifyAccess Action	ModifyAccessRequest
PurgeRetainedContent	PurgeRetainedContent Action	Microsoft.Crm.Sdk.Messages.PurgeRetainedContentRequest
Restore	Restore Action	Microsoft.Crm.Sdk.Messages.RestoreRequest
Retain	Retain Action	Microsoft.Crm.Sdk.Messages.RetainRequest
Retrieve	GET [org URI]/api/data/v9.0/msdyn_sessionparticipants(msdyn_sessionparticipantid) See Retrieve	RetrieveRequest or Retrieve
RetrieveMultiple	GET [org URI]/api/data/v9.0/msdyn_sessionparticipants See Query Data	RetrieveMultipleRequest or RetrieveMultiple
RetrievePrincipalAccess	RetrievePrincipalAccess Function	RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess	RetrieveSharedPrincipalsAndAccess Function	RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess	RevokeAccess Action	RevokeAccessRequest
RollbackRetain	RollbackRetain Action	Microsoft.Crm.Sdk.Messages.RollbackRetainRequest
SetState	PATCH [org URI]/api/data/v9.0/msdyn_sessionparticipants(msdyn_sessionparticipantid) Update statecode and statuscode properties.	SetStateRequest
Update	PATCH [org URI]/api/data/v9.0/msdyn_sessionparticipants(msdyn_sessionparticipantid) See Update	UpdateRequest or Update
UpdateMultiple	UpdateMultiple Action	UpdateMultipleRequest
ValidateRetentionConfig	ValidateRetentionConfig Action	Microsoft.Crm.Sdk.Messages.ValidateRetentionConfigRequest

Properties

Property	Value
CollectionSchemaName	msdyn_sessionparticipants
DisplayCollectionName	Session participants
DisplayName	Session participant
EntitySetName	msdyn_sessionparticipants
IsBPFEntity	False
LogicalCollectionName	msdyn_sessionparticipants
LogicalName	msdyn_sessionparticipant
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_sessionparticipantid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_sessionparticipant

Writable columns/attributes

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

• ImportSequenceNumber
• msdyn_activedirectoryuserid
• msdyn_activetime
• msdyn_addedon
• msdyn_agentid
• msdyn_assignreason
• msdyn_externalparticipantchannel
• msdyn_externalparticipantchanneltype
• msdyn_idletime
• msdyn_inactivetime
• msdyn_joinedon
• msdyn_lastupdatedon
• msdyn_lefton
• msdyn_leftonreason
• msdyn_mode
• msdyn_modifiedon
• msdyn_name
• msdyn_omnichannelsession
• msdyn_sessionparticipantId
• msdyn_startactivetime
• msdyn_startidletime
• msdyn_startinactivetime
• OverriddenCreatedOn
• OwnerId
• OwnerIdType
• statecode
• statuscode
• TimeZoneRuleVersionNumber
• UTCConversionTimeZoneCode

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_activedirectoryuserid

Property	Value
Description	Unique identifier of Active Directory User participating in session.
DisplayName	Active Directory User Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_activedirectoryuserid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_activetime

Property	Value
Description	Active time for agent on the session
DisplayName	Active time
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_activetime
MaxValue	2147483647
MinValue	0
RequiredLevel	None
Type	Integer

msdyn_addedon

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when agent assigned to the session.
DisplayName	Added On
Format	DateOnly
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_addedon
RequiredLevel	None
Type	DateTime

msdyn_agentid

Property	Value
Description	Unique identifier of System User participating in session.
DisplayName	Agent
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_agentid
RequiredLevel	None
Targets	systemuser
Type	Lookup

msdyn_assignreason

Added by: Omnichannel Conversation Extension Solution

Property	Value
Description	The agent assignment reason (This is for internal use only. Customers are advised to not use this property). Possible values include: AgentConsult AgentConversationRejoin AgentConversationRejoin AgentTransfer ExternalWarmTransfer ExternalBlindTransfer ExternalColdTransfer CustomerReconnect AgentConversationJoin AgentMonitor AgentPick SupervisorAssign SupervisorTransferToAgent
DisplayName	Assign Reason
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_assignreason
MaxLength	100
RequiredLevel	ApplicationRequired
Type	String

msdyn_externalparticipantchannel

Property	Value
Description
DisplayName	External channel of participant
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_externalparticipantchannel
MaxLength	100
RequiredLevel	None
Type	String

msdyn_externalparticipantchanneltype

Property	Value
Description	Channel type of external participant
DisplayName	Channel type of external participant
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_externalparticipantchanneltype
RequiredLevel	None
Type	Picklist

msdyn_externalparticipantchanneltype Choices/Options

Value	Label
426120000	Phone Number

msdyn_idletime

Property	Value
Description	Idle time for agent on the session
DisplayName	Idle time
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_idletime
MaxValue	2147483647
MinValue	0
RequiredLevel	None
Type	Integer

msdyn_inactivetime

Property	Value
Description	Inactive time for agent on the session
DisplayName	Inactive time
Format	None
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_inactivetime
MaxValue	2147483647
MinValue	0
RequiredLevel	None
Type	Integer

msdyn_joinedon

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when agent accepted the session.
DisplayName	Joined On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_joinedon
RequiredLevel	None
Type	DateTime

msdyn_lastupdatedon

Added by: Omnichannel Conversation Extension Solution

Property	Value
DateTimeBehavior	UserLocal
Description	Last Updated On timestamp for the record
DisplayName	Last Updated On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_lastupdatedon
RequiredLevel	None
Type	DateTime

msdyn_lefton

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when agent left the session.
DisplayName	Left On
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_lefton
RequiredLevel	None
Type	DateTime

msdyn_leftonreason

Added by: Omnichannel Conversation Extension Solution

Property	Value
Description	The agent left on reason (This is for internal use only. Customers are advised to not use this property). Possible value is AgentReject or AgentTimeout
DisplayName	LeftOn Reason
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_leftonreason
MaxLength	100
RequiredLevel	None
Type	String

msdyn_mode

Property	Value
Description	Mode of Agent participation i.e. primary, consult, monitor, preview etc.
DisplayName	Mode
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_mode
RequiredLevel	None
Type	Picklist

msdyn_mode Choices/Options

Value	Label
192350002	Primary
192350003	Consult
192350004	Monitor
192350005	Preview

msdyn_modifiedon

Property	Value
DateTimeBehavior	UserLocal
Description	Date and time when session participant information was last modified.
DisplayName	Session Participant Modified On
Format	DateOnly
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_modifiedon
RequiredLevel	None
Type	DateTime

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	200
RequiredLevel	ApplicationRequired
Type	String

msdyn_omnichannelsession

Property	Value
Description	Unique identifier of the session associated to the participant.
DisplayName	Omni Channel Session
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_omnichannelsession
RequiredLevel	None
Targets	msdyn_ocsession
Type	Lookup

msdyn_sessionparticipantId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Session participant
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_sessionparticipantid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_startactivetime

Property	Value
DateTimeBehavior	UserLocal
Description	Start active time for agent on the session
DisplayName	Start active time
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_startactivetime
RequiredLevel	None
Type	DateTime

msdyn_startidletime

Property	Value
DateTimeBehavior	UserLocal
Description	Start idle time for agent on the session
DisplayName	Start idle time
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_startidletime
RequiredLevel	None
Type	DateTime

msdyn_startinactivetime

Property	Value
DateTimeBehavior	UserLocal
Description	Start inactive time for agent on the session
DisplayName	Start inactive time
Format	DateAndTime
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_startinactivetime
RequiredLevel	None
Type	DateTime

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

OwnerId

Added by: Active Solution Solution

Property	Value
Description	Owner Id
DisplayName	Owner
IsValidForForm	True
IsValidForRead	True
LogicalName	ownerid
RequiredLevel	SystemRequired
Targets	systemuser,team
Type	Owner

OwnerIdType

Added by: Active Solution Solution

Property	Value
Description	Owner Id Type
DisplayName
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridtype
RequiredLevel	SystemRequired
Type	EntityName

statecode

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

statecode Choices/Options

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

statuscode

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

statuscode Choices/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 columns/attributes

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

• CreatedBy
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• msdyn_agentidName
• msdyn_agentidYomiName
• msdyn_omnichannelsessionName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• OwningBusinessUnitName
• OwningTeam
• OwningUser
• VersionNumber

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_agentidName

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

msdyn_agentidYomiName

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

msdyn_omnichannelsessionName

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

OwnerIdName

Added by: Active Solution Solution

Property	Value
Description	Name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridname
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwnerIdYomiName

Added by: Active Solution Solution

Property	Value
Description	Yomi name of the owner
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	owneridyominame
MaxLength	100
RequiredLevel	SystemRequired
Type	String

OwningBusinessUnit

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the business unit that owns the record
DisplayName	Owning Business Unit
IsValidForForm	True
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Targets	businessunit
Type	Lookup

OwningBusinessUnitName

Added by: Active Solution Solution

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

OwningTeam

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the team that owns the record.
DisplayName	Owning Team
IsValidForForm	False
IsValidForRead	True
LogicalName	owningteam
RequiredLevel	None
Targets	team
Type	Lookup

OwningUser

Added by: Active Solution Solution

Property	Value
Description	Unique identifier for the user that owns the record.
DisplayName	Owning User
IsValidForForm	False
IsValidForRead	True
LogicalName	owninguser
RequiredLevel	None
Targets	systemuser
Type	Lookup

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

Related information

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