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

Channel State Configuration

Added by: Omnichannel – Base Solution

Messages

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

Entity Properties

Property Value
CollectionSchemaName msdyn_occhannelstateconfigurations
DisplayCollectionName Channel State Configurations
DisplayName Channel State Configuration
EntitySetName msdyn_occhannelstateconfigurations
IsBPFEntity False
LogicalCollectionName msdyn_occhannelstateconfigurations
LogicalName msdyn_occhannelstateconfiguration
OwnershipType OrganizationOwned
PrimaryIdAttribute msdyn_occhannelstateconfigurationid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_occhannelstateconfiguration

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_autocloseliveworkitemafter

Property Value
Description Time duration in minutes after which the work item becomes target for auto closure
DisplayName Auto close conversation after
Format Duration
IsValidForForm True
IsValidForRead True
LogicalName msdyn_autocloseliveworkitemafter
MaxValue 2147483647
MinValue 0
RequiredLevel None
Type Integer

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_occhannelconfigurationid

Property Value
Description Unique Identifier of the associated channel configuration
DisplayName Channel Configuration
IsValidForForm True
IsValidForRead True
LogicalName msdyn_occhannelconfigurationid
RequiredLevel ApplicationRequired
Targets msdyn_occhannelconfiguration
Type Lookup

msdyn_occhannelstateconfigurationId

Property Value
Description Unique identifier for entity instances
DisplayName Channel State Configuration
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_occhannelstateconfigurationid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_ocliveworkitemstate

Property Value
Description State of the conversation where the config is applicable
DisplayName Conversation State
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocliveworkitemstate
RequiredLevel ApplicationRequired
Type Picklist

msdyn_ocliveworkitemstate Options

Value Label
0 Open
1 Active
2 Waiting
3 Closed
4 Wrap-up

msdyn_showconfirmationonsessionclose

Property Value
Description (Currently unused)
DisplayName Show confirmation on session close
IsValidForForm True
IsValidForRead True
LogicalName msdyn_showconfirmationonsessionclose
RequiredLevel ApplicationRequired
Type Boolean

msdyn_showconfirmationonsessionclose Options

Value Label
1 Yes
0 No

DefaultValue: False

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 Channel State Configuration
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 Channel State Configuration
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_occhannelconfigurationidName

Property Value
Description
DisplayName
FormatName Text
IsLocalizable False
IsValidForForm False
IsValidForRead True
LogicalName msdyn_occhannelconfigurationidname
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

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_msdyn_occhannelconfiguration_msdyn_occhannelstateconfiguration_occhannelconfigurationid

See msdyn_occhannelconfiguration Entity msdyn_msdyn_occhannelconfiguration_msdyn_occhannelstateconfiguration_occhannelconfigurationid One-To-Many relationship.

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