msdyn_occhannelconfiguration 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 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_occhannelconfigurations |
| DisplayCollectionName | Channel Configurations |
| DisplayName | Channel Configuration |
| EntitySetName | msdyn_occhannelconfigurations |
| IsBPFEntity | False |
| LogicalCollectionName | msdyn_occhannelconfigurations |
| LogicalName | msdyn_occhannelconfiguration |
| OwnershipType | OrganizationOwned |
| PrimaryIdAttribute | msdyn_occhannelconfigurationid |
| PrimaryNameAttribute | msdyn_name |
| SchemaName | msdyn_occhannelconfiguration |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_closeconversationifoooh
- msdyn_enabletransfertoooohqueue
- msdyn_engagementcontext
- msdyn_name
- msdyn_occhannelconfigurationId
- msdyn_privacytermsaccepted
- msdyn_privacytermsversion
- msdyn_streamsource
- OverriddenCreatedOn
- 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_closeconversationifoooh
Added by: Omnichannel - Base Patch Solution
| Property | Value |
|---|---|
| Description | Specifies whether the conversation should be closed when it is created out of operating hours |
| DisplayName | Close Conversation If Outside Of OperatingHours |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_closeconversationifoooh |
| RequiredLevel | ApplicationRequired |
| Type | Boolean |
msdyn_closeconversationifoooh Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
msdyn_enabletransfertoooohqueue
Added by: Omnichannel - Base Patch Solution
| Property | Value |
|---|---|
| Description | Specifies whether the conversation can be transferred to an out of operating hour queue |
| DisplayName | Enable Transfer to Outside Of OperatingHours Queue |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_enabletransfertoooohqueue |
| RequiredLevel | ApplicationRequired |
| Type | Boolean |
msdyn_enabletransfertoooohqueue Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
msdyn_engagementcontext
Added by: Omnichannel - Base Patch Solution
| Property | Value |
|---|---|
| Description | Entity carrying the engagement context details of the channel. |
| DisplayName | Engagement Context |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_engagementcontext |
| MaxLength | 128 |
| 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_occhannelconfigurationId
| Property | Value |
|---|---|
| Description | Unique identifier for entity instances |
| DisplayName | Channel Configuration |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | msdyn_occhannelconfigurationid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
msdyn_privacytermsaccepted
Added by: Omnichannel - Base Patch Solution
| Property | Value |
|---|---|
| Description | Indicates whether the Privacy Terms has been accepted by the user or not. |
| DisplayName | Privacy terms accepted |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_privacytermsaccepted |
| RequiredLevel | None |
| Type | Boolean |
msdyn_privacytermsaccepted Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
msdyn_privacytermsversion
Added by: Omnichannel - Base Patch Solution
| Property | Value |
|---|---|
| Description | The version of the privacy terms. |
| DisplayName | Privacy terms version |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_privacytermsversion |
| MaxLength | 20 |
| RequiredLevel | None |
| Type | String |
msdyn_streamsource
| Property | Value |
|---|---|
| Description | Stream source of the channel e.g. LiveChat, SMS, Facebook etc |
| DisplayName | Stream Source |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_streamsource |
| RequiredLevel | ApplicationRequired |
| Type | Picklist |
msdyn_streamsource Options
| Value | Label |
|---|---|
| 19241000 | Microsoft Teams |
| 192300000 | |
| 192310000 | LINE |
| 192320000 | |
| 192330000 | |
| 192340000 | SMS |
| 192350000 | Entity Records |
| 192350001 | |
| 192350002 | Custom |
| 192360000 | Live chat |
| 192370000 | Voice |
| 192380000 | Video |
| 192390000 | Co-browse |
| 192400000 | Screen sharing |
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 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 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
- CreatedByName
- CreatedByYomiName
- CreatedOn
- CreatedOnBehalfBy
- CreatedOnBehalfByName
- CreatedOnBehalfByYomiName
- ModifiedBy
- ModifiedByName
- ModifiedByYomiName
- ModifiedOn
- ModifiedOnBehalfBy
- ModifiedOnBehalfByName
- ModifiedOnBehalfByYomiName
- OrganizationId
- OrganizationIdName
- 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 |
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_msdyn_occhannelconfiguration_msdyn_occhannelstateconfiguration_occhannelconfigurationid
Same as msdyn_occhannelstateconfiguration entity msdyn_msdyn_occhannelconfiguration_msdyn_occhannelstateconfiguration_occhannelconfigurationid Many-To-One relationship.
| Property | Value |
|---|---|
| ReferencingEntity | msdyn_occhannelstateconfiguration |
| ReferencingAttribute | msdyn_occhannelconfigurationid |
| IsHierarchical | False |
| IsCustomizable | True |
| ReferencedEntityNavigationPropertyName | msdyn_msdyn_occhannelconfiguration_msdyn_occhannelstateconfiguration_occhannelconfigurationid |
| AssociatedMenuConfiguration | Behavior: UseCollectionName Group: Details Label: Order: 10000 |
| CascadeConfiguration | Assign: NoCascade Delete: RemoveLink Merge: NoCascade Reparent: NoCascade Share: NoCascade Unshare: NoCascade |
Related information
Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service