msdyn_ocbotchannelregistration table/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.

Bot channel registration used for channel integration

Added by: Omnichannel Shared Base Solution

Messages

Message Web API Operation SDK Assembly
Assign PATCH [org URI]/api/data/v9.0/msdyn_ocbotchannelregistrations(msdyn_ocbotchannelregistrationid)
Update ownerid property.
AssignRequest
Create POST [org URI]/api/data/v9.0/msdyn_ocbotchannelregistrations
See Create
CreateRequest or
Create
CreateMultiple CreateMultipleRequest
Delete DELETE [org URI]/api/data/v9.0/msdyn_ocbotchannelregistrations(msdyn_ocbotchannelregistrationid)
See Delete
DeleteRequest or
Delete
GrantAccess GrantAccess Action GrantAccessRequest
IsValidStateTransition IsValidStateTransition Function IsValidStateTransitionRequest
ModifyAccess ModifyAccess Action ModifyAccessRequest
msdyn_RetrieveCustomMessagingApplicationSecret Microsoft.Dynamics.CRM.msdyn_RetrieveCustomMessagingApplicationSecret Type generated by CrmSvcUtil.exe or use OrganizationRequest setting the required parameters for the message.
Retrieve GET [org URI]/api/data/v9.0/msdyn_ocbotchannelregistrations(msdyn_ocbotchannelregistrationid)
See Retrieve
RetrieveRequest or
Retrieve
RetrieveMultiple GET [org URI]/api/data/v9.0/msdyn_ocbotchannelregistrations
See Query Data
RetrieveMultipleRequest or
RetrieveMultiple
RetrievePrincipalAccess RetrievePrincipalAccess Function RetrievePrincipalAccessRequest
RetrieveSharedPrincipalsAndAccess RetrieveSharedPrincipalsAndAccess Function RetrieveSharedPrincipalsAndAccessRequest
RevokeAccess RevokeAccess Action RevokeAccessRequest
SetState PATCH [org URI]/api/data/v9.0/msdyn_ocbotchannelregistrations(msdyn_ocbotchannelregistrationid)
Update statecode and statuscode properties.
SetStateRequest
Update PATCH [org URI]/api/data/v9.0/msdyn_ocbotchannelregistrations(msdyn_ocbotchannelregistrationid)
See Update
UpdateRequest or
Update
UpdateMultiple UpdateMultipleRequest

Properties

Property Value
CollectionSchemaName msdyn_ocbotchannelregistrations
DisplayCollectionName Custom messaging accounts
DisplayName Custom messaging account
EntitySetName msdyn_ocbotchannelregistrations
IsBPFEntity False
LogicalCollectionName msdyn_ocbotchannelregistrations
LogicalName msdyn_ocbotchannelregistration
OwnershipType UserOwned
PrimaryIdAttribute msdyn_ocbotchannelregistrationid
PrimaryNameAttribute msdyn_name
SchemaName msdyn_ocbotchannelregistration

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

msdyn_communicationprovidersettingid

Added by: Omnichannel Shared CommunicationBase Solution

Property Value
Description Unique identifier for Communication Provider Setting associated with Bot Channel Registration.
DisplayName Communication provider setting id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_communicationprovidersettingid
RequiredLevel None
Targets msdyn_occommunicationprovidersetting
Type Lookup

msdyn_iscustommessagingbcr

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Flag to indicate if BCR entity is related to Custom Messaging
DisplayName Is Custom Messaging BCR
IsValidForForm True
IsValidForRead True
LogicalName msdyn_iscustommessagingbcr
RequiredLevel ApplicationRequired
Type Boolean

msdyn_iscustommessagingbcr Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_iscustommessagingcreated

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Flag to indicate if the record is newly created
DisplayName Is Custom Messaging Created
IsValidForForm True
IsValidForRead True
LogicalName msdyn_iscustommessagingcreated
RequiredLevel None
Type Boolean

msdyn_iscustommessagingcreated Choices/Options

Value Label
1 Yes
0 No

DefaultValue: False

msdyn_lastvalidateddate

Added by: Omnichannel – SocialChannels Solution

Property Value
DateTimeBehavior UserLocal
Description Microsoft app Id and secret last validated date.
DisplayName Last validated
Format DateAndTime
IsValidForForm True
IsValidForRead True
LogicalName msdyn_lastvalidateddate
RequiredLevel ApplicationRequired
Type DateTime

msdyn_messagingendpoint

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Messaging Endpoint (URL)
DisplayName Messaging Endpoint (URL)
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_messagingendpoint
MaxLength 500
RequiredLevel None
Type String

msdyn_msappid

Property Value
Description MS Application ID for the BCR
DisplayName MS Application Id
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_msappid
MaxLength 100
RequiredLevel ApplicationRequired
Type String

msdyn_msappsecret

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Bot channel registration client secret
DisplayName Client secret
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_msappsecret
MaxLength 100
RequiredLevel ApplicationRequired
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_ocbotchannelregistrationId

Property Value
Description Unique identifier for entity instances
DisplayName Bot Channel Registration
IsValidForForm False
IsValidForRead True
IsValidForUpdate False
LogicalName msdyn_ocbotchannelregistrationid
RequiredLevel SystemRequired
Type Uniqueidentifier

msdyn_ocfbapplicationid

Added by: Omnichannel – Facebook Solution

Property Value
Description Related Facebook application
DisplayName Facebook application
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocfbapplicationid
RequiredLevel None
Targets msdyn_ocfbapplication
Type Lookup

msdyn_ocgbmagentaccount

Added by: Omnichannel - SocialChannels Patch Solution

Property Value
Description Google's Business Messages agent account id for the BCR
DisplayName Google's Business Messages agent account id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocgbmagentaccount
RequiredLevel None
Targets msdyn_ocgooglebusinessmessagesagentaccount
Type Lookup

msdyn_ocgbmpartneraccount

Added by: Omnichannel - SocialChannels Patch Solution

Property Value
Description Google's Business Messages partner account id of the BCR
DisplayName Google's Business Messages partner account id
IsValidForForm True
IsValidForRead True
LogicalName msdyn_ocgbmpartneraccount
RequiredLevel None
Targets msdyn_ocgooglebusinessmessagespartneraccount
Type Lookup

msdyn_oclinechannelconfigid

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Related Line Channel
DisplayName Line Channel
IsValidForForm True
IsValidForRead True
LogicalName msdyn_oclinechannelconfigid
RequiredLevel None
Targets msdyn_oclinechannelconfig
Type Lookup

msdyn_octeamschannelconfigid

Added by: Omnichannel - Teams Solution

Property Value
Description Related Teams Channel
DisplayName Teams Channel
IsValidForForm True
IsValidForRead True
LogicalName msdyn_octeamschannelconfigid
RequiredLevel None
Targets msdyn_octeamschannelconfig
Type Lookup

msdyn_securemsappsecret

Added by: Omnichannel - SocialChannels Patch Solution

Property Value
Description Bot channel registration secure client secret
DisplayName Secure Client secret
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_securemsappsecret
MaxLength 100
RequiredLevel ApplicationRequired
Type String

msdyn_validationstatus

Added by: Omnichannel – SocialChannels Solution

Property Value
Description Microsoft app ID and secert Validation status
DisplayName Validation status
FormatName Text
IsLocalizable False
IsValidForForm True
IsValidForRead True
LogicalName msdyn_validationstatus
MaxLength 100
RequiredLevel ApplicationRequired
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 Bot Channel Registration
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 Bot Channel Registration
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

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_communicationprovidersettingidName

Added by: Omnichannel Shared CommunicationBase Solution

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

msdyn_ocfbapplicationidName

Added by: Omnichannel – Facebook Solution

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

msdyn_ocgbmagentaccountName

Added by: Omnichannel - SocialChannels Patch Solution

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

msdyn_ocgbmpartneraccountName

Added by: Omnichannel - SocialChannels Patch Solution

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

msdyn_oclinechannelconfigidName

Added by: Omnichannel – SocialChannels Solution

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

msdyn_octeamschannelconfigidName

Added by: Omnichannel - Teams Solution

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

Many-To-One Relationships

Each Many-To-One relationship is defined by a corresponding One-To-Many relationship with the related table. Listed by SchemaName.

msdyn_msdyn_occommunicationprovidersetting_msdyn_ocbotchannelregistration_communicationprovider

Added by: Omnichannel Shared CommunicationBase Solution

See msdyn_occommunicationprovidersetting Table msdyn_msdyn_occommunicationprovidersetting_msdyn_ocbotchannelregistration_communicationprovider One-To-Many relationship.

msdyn_msdyn_ocgbmpartneraccount_msdyn_ocbotchannelregistration_ocgbmpartneraccount

Added by: Omnichannel - SocialChannels Patch Solution

See msdyn_ocgooglebusinessmessagespartneraccount Table msdyn_msdyn_ocgbmpartneraccount_msdyn_ocbotchannelregistration_ocgbmpartneraccount One-To-Many relationship.

See also

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