Newer Version Available

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

ConversationChannelDefinition

Represents the conversation channel definition that’s implemented for interaction service. Examples of conversation channels include Messaging and Voice. This object is available in API version 60.0 and later.

Where possible, we changed noninclusive terms to align with our company value of Equality. We maintained certain terms to avoid any effect on customer implementations.

Important

Parent Type

This type extends the Metadata metadata type and inherits its fullName field.

File Suffix and Directory Location

ConversationChannelDefinition components have the suffix .ConversationChannelDefinition and are stored in the conversationChannelDefinitions folder.

Version

ConversationChannelDefinition components are available in API version 60.0 and later.

Special Access Rules

Interaction service must be configured. Access to tooling objects requires Salesforce administrator privileges or the Customize Application permission.

Fields

Field Name Description
connectedAppOauthLink
Field Type
string
Description

Required. DO NOT SET OR CHANGE THIS VALUE. This value is automatically generated. This field represents the OAuth link for the connected app. This is a string identifier to the connected app containing the partner Org ID and the consumer ID minus the key prefixes. Used to identify the connected app to use for the channel definition and channel at runtime.

consentOwner
Field Type
ConsentOwner (enumeration of type string)
Description
The system the customer uses to manage consent levels.
Possible values are:
  • Partner
  • Salesforce
The default value is Salesforce.
For example, if set to Salesforce, consent levels are managed by the Salesforce system. If set to Partner, consent levels are managed by the partner’s telephony system.
For Partner Messaging, this value must be set to Salesforce.
conversationVendorInfo
Field Type
string
Description
The ConversationVendorInfo.developerName used to link this record to the ConversationVendorInfo record. For example, PartnerName.
customEventChnlAddrIdField
Field Type
string
Description
The mapping field that points to the custom field used to point to the ChannelAddressIdentifier field.
This field is deprecated in API version 60.0 and will be removed in API version 61.0. Use a combination of customEventTypeField and customEventPayloadField instead.
customEventPayloadField
Field Type
string
Description
Required. The mapping field that points to the custom field used to point to the Payload field in the format <orgNamespace>__<CustomFieldName>__c. This is the API name of the custom Payload field in the custom platform event. For example, devorg__Payload__c.
customEventRecipientField
Field Type
string
Description
The mapping field that points to the custom field used to point to the Recipient field.
This field is deprecated in API version 60.0 and will be removed in API version 61.0. Use a combination of customEventTypeField and customEventPayloadField instead.
customEventTypeField
Field Type
string
Description
The mapping field that points to the custom field used to point to the Platform event type (EventType) field, in the format <orgNamespace>__<CustomFieldName>__c. This is the API name of the custom EventType field in the custom platform event. For example, devorg__EventType__c.
customPlatformEvent
Field Type
string
Description
Required. The API name of the custom platform event created for the Interaction Service API in the format <orgNamespace>__<CustomPlatformEventName>__e. For example, devorg__TestEvent__e.
developerName
Field Type
string
Description
The unique name of the custom metadata type object in the API in the format <Prefix>_<ConversationChannelDefinition>, where Prefix matches the prefix you gave to the name of the interaction service connected app. For example, Partner1_ChannelDefinition1, where Partner1 is the prefix and ChannelDefinition1 is the given name.
masterLabel
Field Type
string
Description
The namespace prefix that is associated with this object. Each Developer Edition org that creates a managed package has a unique namespace prefix. Limit: 15 characters. You can refer to a component in a managed package by using the namespacePrefix__componentName notation. The namespace prefix can have one of the following values.
  • In Developer Edition orgs, NamespacePrefix is set to the namespace prefix of the org for all objects that support it, unless an object is in an installed managed package. In that case, the object has the namespace prefix of the installed managed package. This field’s value is the namespace prefix of the Developer Edition org of the package developer.
  • In orgs that are not Developer Edition orgs, NamespacePrefix is set only for objects that are part of an installed managed package. All other objects have no namespace prefix.
NamespacePrefix is null if the publisher is Salesforce.
routingOwner
Field Type
RoutingOwner (enumeration of type string)
Description
The system the customer uses to manage routing for Partner Messaging.
Possible values are:
  • Partner
  • Salesforce
The default value is Salesforce.
For example, if set to Salesforce, consent levels are managed by the Salesforce system. If set to Partner, consent levels are managed by the partner’s telephony system.
For Partner Messaging, this value must be set to Salesforce.
supportsDoubleOptInConsent
Field Type
boolean
Description
Indicates whether the channel supports (true) the Double Opt-In consent level. The default value is false. If set to true, then capabilitiesSupportsExplicitConsent must also be set to true. This field is optional and isn’t supported for Partner Messaging.
supportsExplicitConsent
Field Type
boolean
Description
Indicates whether the channel supports (true) the Explicit Opt-In consent level. This field is optional.
supportsImplicitConsent
Field Type
boolean
Description
Indicates whether the channel supports (true) the Implicit Opt-In consent level. This value is required and must always be set to true. The default value is false.
supportsIsoCountryCode
Field Type
boolean
Description
Indicates whether the channel supports (true) ISO country codes. The default value is false.
supportsKeywords
Field Type
boolean
Description
Indicates whether the channel supports (true) keywords. The default value is false.

Declarative Metadata Sample Definition

The following is an example of a ConversationChannelDefinition component.

No content provided

The following is an example package.xml that references the previous definition.

No content provided