msdyn_ocwhatsappchannelnumber 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.
WhatsApp numbers for Omnichannel integration
Added by: Omnichannel – SocialChannels Solution
Messages
| Message | Web API Operation | SDK Assembly |
|---|---|---|
| Assign | PATCH [org URI]/api/data/v9.1/msdyn_ocwhatsappchannelnumbers(msdyn_ocwhatsappchannelnumberid) Update ownerid property. |
AssignRequest |
| Create | POST [org URI]/api/data/v9.1/msdyn_ocwhatsappchannelnumbers See Create |
CreateRequest or Create |
| Delete | DELETE [org URI]/api/data/v9.1/msdyn_ocwhatsappchannelnumbers(msdyn_ocwhatsappchannelnumberid) See Delete |
DeleteRequest or Delete |
| GrantAccess | GrantAccess Action | GrantAccessRequest |
| IsValidStateTransition | IsValidStateTransition Function | IsValidStateTransitionRequest |
| ModifyAccess | ModifyAccess Action | ModifyAccessRequest |
| Retrieve | GET [org URI]/api/data/v9.1/msdyn_ocwhatsappchannelnumbers(msdyn_ocwhatsappchannelnumberid) See Retrieve |
RetrieveRequest or Retrieve |
| RetrieveMultiple | GET [org URI]/api/data/v9.1/msdyn_ocwhatsappchannelnumbers 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.1/msdyn_ocwhatsappchannelnumbers(msdyn_ocwhatsappchannelnumberid) Update statecode and statuscode properties. |
SetStateRequest |
| Update | PATCH [org URI]/api/data/v9.1/msdyn_ocwhatsappchannelnumbers(msdyn_ocwhatsappchannelnumberid) See Update |
UpdateRequest or Update |
Entity Properties
| Property | Value |
|---|---|
| CollectionSchemaName | msdyn_ocwhatsappchannelnumbers |
| DisplayCollectionName | WhatsApp numbers |
| DisplayName | WhatsApp number |
| EntitySetName | msdyn_ocwhatsappchannelnumbers |
| IsBPFEntity | False |
| LogicalCollectionName | msdyn_ocwhatsappchannelnumbers |
| LogicalName | msdyn_ocwhatsappchannelnumber |
| OwnershipType | UserOwned |
| PrimaryIdAttribute | msdyn_ocwhatsappchannelnumberid |
| PrimaryNameAttribute | msdyn_name |
| SchemaName | msdyn_ocwhatsappchannelnumber |
Writable attributes
These attributes return true for either IsValidForCreate or IsValidForUpdate (usually both). Listed by SchemaName.
- ImportSequenceNumber
- msdyn_enablefileattachmentsforagents
- msdyn_enablefileattachmentsforcustomers
- msdyn_liveworkstreamid
- msdyn_name
- msdyn_ocwhatsappaccountid
- msdyn_ocwhatsappchannelnumberId
- msdyn_ocwidgetlanguage
- msdyn_organizationphonenumber
- msdyn_PostConversationSurvey
- msdyn_PostConversationSurveyEnable
- msdyn_PostConversationSurveyMessageText
- msdyn_PostConversationSurveyMode
- 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_enablefileattachmentsforagents
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | Enable file attachments for agents |
| DisplayName | Enable file attachments for agents |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_enablefileattachmentsforagents |
| RequiredLevel | None |
| Type | Boolean |
msdyn_enablefileattachmentsforagents Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
msdyn_enablefileattachmentsforcustomers
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | Enable file attachments for customers |
| DisplayName | Enable file attachments for customers |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_enablefileattachmentsforcustomers |
| RequiredLevel | None |
| Type | Boolean |
msdyn_enablefileattachmentsforcustomers Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
msdyn_liveworkstreamid
| Property | Value |
|---|---|
| Description | Work stream of WhatsApp number |
| DisplayName | Work stream |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_liveworkstreamid |
| RequiredLevel | ApplicationRequired |
| Targets | msdyn_liveworkstream |
| Type | Lookup |
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_ocwhatsappaccountid
| Property | Value |
|---|---|
| Description | Identity of associated WhatsApp account |
| DisplayName | WhatsApp account |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_ocwhatsappaccountid |
| RequiredLevel | ApplicationRequired |
| Targets | msdyn_ocwhatsappchannelaccount |
| Type | Lookup |
msdyn_ocwhatsappchannelnumberId
| Property | Value |
|---|---|
| Description | Unique identifier for WhatsApp entity instances |
| DisplayName | WhatsApp number |
| IsValidForForm | False |
| IsValidForRead | True |
| IsValidForUpdate | False |
| LogicalName | msdyn_ocwhatsappchannelnumberid |
| RequiredLevel | SystemRequired |
| Type | Uniqueidentifier |
msdyn_ocwidgetlanguage
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | The language setting for the WhatsApp number |
| DisplayName | WhatsApp number language |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_ocwidgetlanguage |
| RequiredLevel | ApplicationRequired |
| Targets | msdyn_oclanguage |
| Type | Lookup |
msdyn_organizationphonenumber
| Property | Value |
|---|---|
| Description | Phone number for a WhatsApp account |
| DisplayName | Phone number |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_organizationphonenumber |
| MaxLength | 100 |
| RequiredLevel | SystemRequired |
| Type | String |
msdyn_PostConversationSurvey
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | Lookup to Forms Pro survey field |
| DisplayName | Survey |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_postconversationsurvey |
| RequiredLevel | None |
| Targets | msfp_survey |
| Type | Lookup |
msdyn_PostConversationSurveyEnable
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | To enable or disable post conversation survey |
| DisplayName | Enable |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_postconversationsurveyenable |
| RequiredLevel | None |
| Type | Boolean |
msdyn_PostConversationSurveyEnable Options
| Value | Label |
|---|---|
| 1 | Yes |
| 0 | No |
DefaultValue: False
msdyn_PostConversationSurveyMessageText
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | Prefix text for survey link message that will be sent to the user. |
| DisplayName | Message |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_postconversationsurveymessagetext |
| MaxLength | 200 |
| RequiredLevel | None |
| Type | String |
msdyn_PostConversationSurveyMode
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | Mode of the survey to be sent |
| DisplayName | Survey Mode |
| IsValidForForm | True |
| IsValidForRead | True |
| LogicalName | msdyn_postconversationsurveymode |
| RequiredLevel | None |
| Type | Picklist |
msdyn_PostConversationSurveyMode Options
| Value | Label |
|---|---|
| 192350000 | Insert survey in conversation |
| 192350001 | Send survey link to conversation |
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 WhatsApp number |
| 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 WhatsApp number |
| 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_liveworkstreamidName
- msdyn_ocwhatsappaccountidName
- msdyn_ocwidgetlanguageName
- msdyn_PostConversationSurveyName
- 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_liveworkstreamidName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_liveworkstreamidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_ocwhatsappaccountidName
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_ocwhatsappaccountidname |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_ocwidgetlanguageName
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_ocwidgetlanguagename |
| MaxLength | 100 |
| RequiredLevel | None |
| Type | String |
msdyn_PostConversationSurveyName
Added by: Omnichannel - SocialChannels Patch Solution
| Property | Value |
|---|---|
| Description | |
| DisplayName | |
| FormatName | Text |
| IsLocalizable | False |
| IsValidForForm | False |
| IsValidForRead | True |
| LogicalName | msdyn_postconversationsurveyname |
| MaxLength | 450 |
| 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 |
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_ocwhatsappchannelaccount_msdyn_ocwhatsappchannelnumber_ocwhatsappaccountid
- msdyn_msdyn_oclanguage_msdyn_ocwhatsappchannelnumber_whatsappnumberlanguage
msdyn_ocwhatsappchannelaccount_msdyn_ocwhatsappchannelnumber_ocwhatsappaccountid
See msdyn_ocwhatsappchannelaccount Entity msdyn_ocwhatsappchannelaccount_msdyn_ocwhatsappchannelnumber_ocwhatsappaccountid One-To-Many relationship.
msdyn_msdyn_oclanguage_msdyn_ocwhatsappchannelnumber_whatsappnumberlanguage
Added by: Omnichannel - Base Patch Solution
See msdyn_oclanguage Entity msdyn_msdyn_oclanguage_msdyn_ocwhatsappchannelnumber_whatsappnumberlanguage One-To-Many relationship.
Related information
Introduction to Omnichannel for Customer Service
Developer guide for Omnichannel for Customer Service