| CapabilitiesSupportsDoubleOptInConsent |
- Type
- boolean
- Properties
- Filter
- 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.
|
| CapabilitiesSupportsExplicitConsent |
- Type
- boolean
- Properties
- Filter
- Description
- Indicates whether the channel supports (true)
the Explicit Opt-In consent level. This field is optional.
|
| CapabilitiesSupportsImplicitConsent |
- Type
- boolean
- Properties
- Filter
- 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.
|
| CapabilitiesSupportsIsoCountryCode |
- Type
- boolean
- Properties
- Filter
- Description
- Indicates whether the channel supports (true)
ISO country codes. The default value is false.
|
| CapabilitiesSupportsKeywords |
- Type
- boolean
- Properties
- Filter
- Description
- Indicates whether the channel supports (true)
keywords. The default value is false.
|
| ConnectedAppOauthLink |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- 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.
|
| ConsentOwner |
- Type
- picklist
- Properties
- Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The system the customer uses to manage consent levels.
- Possible values are:
- 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 |
- Type
- string
- Properties
- Create, Filter, Group, Nillable, Sort, Update
- Description
- The ConversationVendorInfo.developerName used
to link this record to the ConversationVendorInfo record. For
example, PartnerName.
|
| customEventChnlAddrIdField |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- 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 |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- 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 |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- 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 |
- Type
- picklist
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- 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 |
- Type
- picklist
- Properties
- Filter, Group, Restricted picklist, Sort
- Description
- 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 |
- Type
- string
- Properties
- Filter, Group, Sort
- 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.
|
| FullName |
- Type
- string
- Properties
- Create, Group, Nillable
- Description
- The full name of the associated ConversationChannelDefinition
object in Metadata API. The full name is in the format ???_??? and
can include a namespace prefix.
- Query this field only if the query result contains no more than
one record. Otherwise, an error is returned. If more than one
record exists, use multiple queries to retrieve the records. This
limit protects performance.
|
| ManageableState |
- Type
- ManageableState enumerated list
- Properties
- Filter, Group, Nillable, Restricted picklist, Sort
- Description
- Indicates the manageable state of the specified component that is
contained in a package:
-
beta—Managed-Beta
-
deleted—Managed-Proposed-Deleted
-
deprecated—Managed-Proposed-Deprecated
-
deprecatedEditable—SecondGen-Installed-Deprecated
-
installed—Managed-Installed
-
installedEditable—SecondGen-Installed-Editable
-
released—Managed-Released
-
unmanaged—Unmanaged
|
| MasterLabel |
- Type
- string
- Properties
- Filter, Group, Sort
- Description
- The UI label name for the custom metadata type object in the API.
This name appears in several places in the UI, so include the
partner channel name for easy identification. For example, Channel
Definition 1.
|
| Metadata |
- Type
- complexvalue
- Properties
- Create, Nillable, Update
- Description
- Metadata about the standard or custom object. Details are
available in the CustomObject entry in the metadata namespace in
the Tooling API WSDL.
- Query this field only if the query result contains no more than
one record. Otherwise, an error is returned. If more than one
record exists, use multiple queries to retrieve the records. This
limit protects performance.
|
| NamespacePrefix |
- Type
- string
- Properties
- Filter, Group, Nillable, Sort
- 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 |
- Type
- picklist
- Properties
- Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort
- Description
- The system the customer uses to manage routing for Partner
Messaging.
- Possible values are:
- 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.
|
j