Newer Version Available

This content describes an older version of this product. View Latest

MessagingChannelUsage

Represents the connection of an application, such as Service or Marketing, to a Unified Messaging channel. This object is available in API version 60.0 and later.

For example, for a WhatsApp Unified Messaging channel, two MessagingChannelUsage records can exist. One record represents a connection to a Service Cloud Digital Engagement WhatsApp implementation, and the other represents a connection to a Marketing Cloud Engagement WhatsApp implementation. A MessagingChannelUsage record is created when a user selects the Marketing or Service application during Unified Messaging setup.

Supported Calls

create(), describeSObjects(), query(), retrieve(), update(), upsert()

Special Access Rules

MessagingChannelUsage records apply only to Unified Messaging channels.

Fields

Field Details
DeploymentStatus
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort, Update
Description
The status of the application connection. For example, if the DeploymentStatus is Active, messages can be sent or received (if permitted) for that application in the channel. 
Possible values are:
  • New—Admin selected the Marketing or Service application in Unified Messaging Setup.
  • Provisioning—Admin clicked Connect on an application in Unified Messaging Setup.
  • Active—Provisioning was successful and the channel can be used to message with customers via the connected application (Marketing or Service).
  • Error—Provisioning or deprovisioning wasn’t successful. The admin can try connecting or disconnecting again.
  • Deprovisioning—Admin clicked Disconnect on an application in Unified Messaging Setup.
  • Disabled—Deprovisioning was successful and the channel can no longer be used to message with customers via the connect application (Marketing or Service).
DeploymentType
Type
picklist
Properties
Create, Filter, Group, Restricted picklist, Sort
Description
Indicates whether the record is related to Service Cloud or Marketing Cloud.
Possible values are:
  • Conversation—Relating to Service Cloud.
  • MJ—Relating to Marketing Cloud. J stands for Journey Builder.
DisabledTime
Type
dateTime
Properties
Filter, Nillable, Sort
Description
The time the MessagingChannelUsage record entered the Disabled state after an admin clicked Disconnect on an application in Unified Messaging Setup.
When the record is disabled, all inbound and outbound messages aren’t sent via the connected application. Any sessions with a status other than Ended or Error are automatically ended within 48 hours unless the MessagingChannelUsage record is reenabled. 
ErrorReason
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
If an error occurs during connection or disconnection of a MessagingChannelUsage record in Unified Messaging Setup, the ErrorReason provides more information about what went wrong. For example, if an associated Service Cloud application for a Unified Messaging channel is missing a fallback queue or consent keywords, the connection attempt will fail with an ErrorReason of ProvisioningError.
Possible values are:
  • DeprovisioningError
  • InternalError
  • InvalidSelection
  • ProvisioningError
MessagingChannelId
Type
reference
Properties
Create, Filter, Group, Sort
Description
The Unified Messaging channel that the MessagingChannelUsage record is associated with.
This field is a relationship field.
Relationship Name
MessagingChannel
Relationship Type
Lookup
Refers To
MessagingChannel
RoutingOverride
Type
picklist
Properties
Create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
Applicable only to MessagingChannelUsage records with a deployment type of MJ (Marketing Cloud). RoutingOverride indicates how messages are delivered in a unified channel where both the Service and Marketing applications are connected.   
Possible values are:
  • MJKeywordsOnly—If a messaging user sends a marketing keyword that is defined in Journey Builder, Journey Builder handles the message delivery and response. If a messaging user sends a non-keyword message, Omni-Channel handles the message delivery and response.
  • NonSessionMessages—If a messaging user is engaged in an active Service Cloud messaging session, Service Cloud handles message delivery and response. If the user isn’t engaged in an active session, Journey Builder handles message delivery and response.
Regardless of the RoutingOverride value, outbound messages are always handled by Service Cloud if the messaging user is engaged in an active Service Cloud messaging session. A session is considered active if its status is not Ended or Error.