msdyn_livechatengagementctx 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 context values for a live chat widget

Added by: Omnichannel – Chat Solution

Messages

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

Entity Properties

Property	Value
CollectionSchemaName	msdyn_livechatengagementctxes
DisplayCollectionName	Live Chat Contexts
DisplayName	Live Chat Context
EntitySetName	msdyn_livechatengagementctxes
IsBPFEntity	False
LogicalCollectionName	msdyn_livechatengagementctxes
LogicalName	msdyn_livechatengagementctx
OwnershipType	UserOwned
PrimaryIdAttribute	msdyn_livechatengagementctxid
PrimaryNameAttribute	msdyn_name
SchemaName	msdyn_livechatengagementctx

Writable attributes

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

• ImportSequenceNumber
• msdyn_browser
• msdyn_City
• msdyn_country
• msdyn_device
• msdyn_isauthenticated
• msdyn_isproactivechat
• msdyn_latitude
• msdyn_livechatengagementctxId
• msdyn_livechatengagementid
• msdyn_liveworkitemid
• msdyn_locale
• msdyn_longitude
• msdyn_name
• msdyn_originurl
• msdyn_os
• msdyn_portalcontactid
• msdyn_PostalCode
• msdyn_State
• msdyn_Street1
• msdyn_Street2
• msdyn_Street3
• msdyn_widgetappid
• 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_browser

Property	Value
Description	Browser where customer initiated chat
DisplayName	Browser
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_browser
MaxLength	100
RequiredLevel	None
Type	String

msdyn_City

Property	Value
Description	City where customer initiated chat
DisplayName	City
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_city
MaxLength	300
RequiredLevel	None
Type	String

msdyn_country

Property	Value
Description	Country where customer initiated chat
DisplayName	Country/Region
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_country
MaxLength	200
RequiredLevel	None
Type	String

msdyn_device

Property	Value
Description	Device where customer initiated chat
DisplayName	Device
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_device
MaxLength	100
RequiredLevel	None
Type	String

msdyn_isauthenticated

Property	Value
Description	Indicates if chat is authenticated
DisplayName	Is Authenticated Engagement
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_isauthenticated
RequiredLevel	None
Type	Boolean

msdyn_isauthenticated Options

Value	Label
1	Yes
0	No

DefaultValue: False

msdyn_isproactivechat

Added by: Omnichannel - Chat Patch Solution

Property	Value
Description	Indicates if chat was initiated from proactive chat
DisplayName	Is Proactivechat
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_isproactivechat
RequiredLevel	None
Type	Boolean

msdyn_isproactivechat Options

Value	Label
1	Yes
0	No

DefaultValue: False

msdyn_latitude

Property	Value
Description	Latitude where customer initiated chat
DisplayName	Latitude
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_latitude
MaxLength	100
RequiredLevel	None
Type	String

msdyn_livechatengagementctxId

Property	Value
Description	Unique identifier for entity instances
DisplayName	Live Chat Context
IsValidForForm	False
IsValidForRead	True
IsValidForUpdate	False
LogicalName	msdyn_livechatengagementctxid
RequiredLevel	SystemRequired
Type	Uniqueidentifier

msdyn_livechatengagementid

Property	Value
Description	Unique identifier for engagement context
DisplayName	Live Chat Engagement Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_livechatengagementid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_liveworkitemid

Property	Value
Description	Corresponding conversation identifier for the chat
DisplayName	Conversation
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_liveworkitemid
RequiredLevel	None
Targets	msdyn_ocliveworkitem
Type	Lookup

msdyn_locale

Property	Value
Description	Locale for this chat
DisplayName	Locale
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_locale
MaxLength	100
RequiredLevel	None
Type	String

msdyn_longitude

Property	Value
Description	Longitude where customer initiated chat
DisplayName	Longitude
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_longitude
MaxLength	100
RequiredLevel	None
Type	String

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

msdyn_originurl

Property	Value
Description	Browser URL where customer initiated chat
DisplayName	Origin Url
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_originurl
MaxLength	2048
RequiredLevel	None
Type	String

msdyn_os

Property	Value
Description	Operating system where customer initiated chat
DisplayName	Operating System
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_os
MaxLength	100
RequiredLevel	None
Type	String

msdyn_portalcontactid

Property	Value
Description	Customer portal identifier if exists
DisplayName	Portal Contact Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_portalcontactid
MaxLength	100
RequiredLevel	None
Type	String

msdyn_PostalCode

Property	Value
Description	Postal code where customer initiated chat
DisplayName	Zip/Postal Code
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_postalcode
MaxLength	100
RequiredLevel	None
Type	String

msdyn_State

Property	Value
Description	State where customer initiated chat
DisplayName	State/Province
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_state
MaxLength	300
RequiredLevel	None
Type	String

msdyn_Street1

Property	Value
Description	Street 1 where customer initiated chat
DisplayName	Street 1
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_street1
MaxLength	200
RequiredLevel	None
Type	String

msdyn_Street2

Property	Value
Description	Street 2 where customer initiated chat
DisplayName	Street 2
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_street2
MaxLength	200
RequiredLevel	None
Type	String

msdyn_Street3

Property	Value
Description	Street 3 where customer initiated chat
DisplayName	Street 3
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_street3
MaxLength	200
RequiredLevel	None
Type	String

msdyn_widgetappid

Property	Value
Description	Corresponding widget application identifier for the chat
DisplayName	Chat Widget App Id
FormatName	Text
IsLocalizable	False
IsValidForForm	True
IsValidForRead	True
LogicalName	msdyn_widgetappid
MaxLength	100
RequiredLevel	None
Type	String

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 Live chat context
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 Live chat context
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
• CreatedByName
• CreatedByYomiName
• CreatedOn
• CreatedOnBehalfBy
• CreatedOnBehalfByName
• CreatedOnBehalfByYomiName
• ModifiedBy
• ModifiedByName
• ModifiedByYomiName
• ModifiedOn
• ModifiedOnBehalfBy
• ModifiedOnBehalfByName
• ModifiedOnBehalfByYomiName
• msdyn_liveworkitemidName
• OwnerIdName
• OwnerIdYomiName
• OwningBusinessUnit
• 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_liveworkitemidName

Property	Value
Description
DisplayName
FormatName	Text
IsLocalizable	False
IsValidForForm	False
IsValidForRead	True
LogicalName	msdyn_liveworkitemidname
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	False
IsValidForRead	True
LogicalName	owningbusinessunit
RequiredLevel	None
Targets	businessunit
Type	Lookup

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

See also

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