Sign in

v2

latestOpenAPI 3.0.1raw.githubusercontent.com2026-05-072126235.6 KB
ConversationsV2Configuration

Fetch Configuration

Retrieve a Configuration.

get/v2/ControlPlane/Configurations/{Sid}

Response

OK

idstring required

Configuration ID.

displayNamestring required

A human-readable name for the configuration. Limited to 32 characters.

descriptionstring required

Human-readable description for the Configuration. Allows spaces and special characters, typically limited to a paragraph of text. This serves as a descriptive field rather than just a name.

conversationGroupingType'GROUP_BY_PROFILE' | 'GROUP_BY_PARTICIPANT_ADDRESSES' | 'GROUP_BY_PARTICIPANT_ADDRESSES_AND_CHANNEL_TYPE' required

Type of Conversation grouping strategy:

  • GROUP_BY_PROFILE: Groups Communications by resolved Profile from the Memory Store. A Profile is looked up or created for CUSTOMER Participant types. All Communications from the same Profile are in the same Conversation, regardless of address or channel.
  • GROUP_BY_PARTICIPANT_ADDRESSES: Groups Communications by Participant addresses across all channels. A customer using +18005550100 will be in the same Conversation whether they contact by SMS, WhatsApp, or RCS.
  • GROUP_BY_PARTICIPANT_ADDRESSES_AND_CHANNEL_TYPE: Groups Communications by both Participant addresses AND channel. A customer using +18005550100 by SMS will be in a different Conversation than the same customer by Voice.
memoryStoreIdstring required

Memory Store ID for Profile resolution.

channelSettingsConversationsV2ConfigurationChannelSettings

Channel-specific configuration settings by channel type. Keys should be valid channel types (VOICE, SMS, RCS, WHATSAPP, CHAT).

intelligenceConfigurationIdsstring[]

A list of Conversational Intelligence configuration IDs.

memoryExtractionEnabledboolean

Whether memory extraction is enabled for conversations under this configuration. Defaults to false.

createdAtstring date-time

Timestamp when this Configuration was created.

updatedAtstring date-time

Timestamp when this Configuration was last updated.

versioninteger

Version number used for optimistic locking.

Example response

{
  "id": "conv_configuration_01k1etk2y5f1y9fpe2epfdtvv2",
  "displayName": "Multi Channel Config",
  "description": "Configuration supporting SMS, WhatsApp, and RCS channels",
  "conversationGroupingType": "GROUP_BY_PROFILE",
  "memoryStoreId": "mem_store_01k1etk2y5f1y9fpe2epfdtvv2",
  "channelSettings": {
    "SMS": {
      "statusTimeouts": {
        "inactive": 10,
        "closed": 15
      },
      "captureRules": [
        {
          "from": "+18005550100",
          "to": "*",
          "metadata": {}
        }
      ]
    },
    "WHATSAPP": {
      "statusTimeouts": {
        "inactive": 15,
        "closed": 60
      },
      "captureRules": [
        {
          "from": "whatsapp:+18005550100",
          "to": "*",
          "metadata": {}
        }
      ]
    },
    "RCS": {
      "statusTimeouts": {
        "inactive": 15,
        "closed": 60
      },
      "captureRules": [
        {
          "from": "rcs:brand_acme_agent",
          "to": "*",
          "metadata": {}
        }
      ]
    }
  },
  "statusCallbacks": [
    {
      "url": "https://webhook.example.com/conversation/status",
      "method": "POST"
    }
  ],
  "intelligenceConfigurationIds": [],
  "memoryExtractionEnabled": false,
  "conversationsV1Bridge": {
    "serviceId": "IS00000000000000000000000000000000"
  },
  "createdAt": "2023-10-14T10:30:00Z",
  "updatedAt": "2023-10-14T15:45:30Z",
  "version": 1
}