ExtConvParticipantIntegDef

Represents the integration configuration for external conversation participants, used for communication between Salesforce and external messaging platforms.

Version 

Introduced in API version 63.0.

Supported SOAP API Calls 

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

Supported REST API Methods 

DELETE, GET, HEAD, PATCH, POST, Query

Fields 

AccountKey 

• Type: textarea

• Required: No

• Properties: Create, Nillable, Update

• Description: The encrypted JSON format key for secure storage of authentication credentials for external bot API calls.

BotProvider 

• Type: picklist

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

• Description: The provider of bot integration that handles authentication and request and response logic.

Possible value:

• Possible values:

  • Custom — Custom (default)

  • GoogleCCAI — GoogleCCAI

• Default value: Custom

ChannelMode 

• Type: picklist

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Restricted picklist, Sort, Update

• Description: Possible values for channel type are:

The default value is Messaging.

• Possible values:

  • Messaging — Messaging (default)

  • Voice — Voice

• Default value: Messaging

ClientIdentifier 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: The API client ID of the bot provider.

DeveloperName 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: The unique name of the object in the API.

Language 

• Type: picklist

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: The language of the MasterLabel.

• Possible values:

  • en_US — English

  • de — German

  • es — Spanish

  • fr — French

  • it — Italian

  • ja — Japanese

  • sv — Swedish

  • ko — Korean

  • zh_TW — Chinese (Traditional)

  • zh_CN — Chinese (Simplified)

  • pt_BR — Portuguese (Brazil)

  • nl_NL — Dutch

  • da — Danish

  • th — Thai

  • fi — Finnish

  • ru — Russian

  • es_MX — Spanish (Mexico)

  • no — Norwegian

ManageableState 

• Type: picklist

• Required: No

• Properties: Filter, Group, Nillable, Restricted picklist, Sort

• Description: The manageable state of the specified component that’s contained in a package.

• Possible values:

  • beta — beta

  • deleted — deleted

  • deprecated — deprecated

  • deprecatedEditable — deprecatedEditable

  • installed — installed

  • installedEditable — installedEditable

  • released — released

  • unmanaged — unmanaged

MasterLabel 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Sort, Update

• Description: The label for this object.

NamespacePrefix 

• Type: string

• Required: No

• Properties: Filter, Group, Nillable, Sort

• Description: If it’s part of a managed package, the namespace of the package that contains integration definition for the external conversation participant.

ProjectIdentifier 

• Type: string

• Required: No

• Properties: Create, Filter, Group, Nillable, Sort, Update

• Description: The ID of the project in the provider framework to scope API calls and resource access.

Status 

• Type: picklist

• Required: No

• Properties: Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update

• Description: The status of the integration.

The default value is Active.

• Possible values:

  • Active — Active (default)

  • Inactive — Inactive

  • Deleted — Deleted

• Default value: Active