Fetch Configuration

(information)

Legal information

Conversation Orchestrator, including the APIs, may use artificial intelligence or machine learning technologies and is subject to the terms of the Predictive and Generative AI/ML Features Addendum. For details on AI usage and data, see the AI Nutrition Facts for Real-Time Transcription and Conversation Relay.

Conversation Orchestrator is not a HIPAA Eligible Service or PCI compliant and should not be enabled in workflows that are subject to HIPAA or PCI.

Conversations products are only available in the new Twilio Console. If your account hasn't been migrated, you'll be redirected to the legacy Console where these products won't appear.

GET/v2/ControlPlane/Configurations/{Sid}

Base url: https://conversations.twilio.com (base url)

Retrieve a Configuration.

Request

Authentication

Basic Auth

Path parameters

Property nameTypeRequiredPIIDescription

sidstring

required

Not PII

Responses

200404429500503

SchemaExample

Property nameTypeRequiredPIIDescriptionChild properties

idstring

Optional

Not PII

Configuration ID.

Example: conv_configuration_01k1etk2y5f1y9fpe2epfdtvv2

displayNamestring

Optional

Not PII

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

Example: My Support ConfigPattern: ^[a-zA-Z0-9-_ ]+$Max length: 32

descriptionstring

Optional

Not PII

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.

Example: Customer Support Configuration for handling all inbound customer inquiries

conversationGroupingTypeenum<string>

Optional

Not PII

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.

Example: GROUP_BY_PROFILEPossible values:

GROUP_BY_PROFILEGROUP_BY_PARTICIPANT_ADDRESSESGROUP_BY_PARTICIPANT_ADDRESSES_AND_CHANNEL_TYPE

memoryStoreIdstring

Optional

Not PII

Memory Store ID for Profile resolution.

Example: mem_store_01k1etk2y5f1y9fpe2epfdtvv2

channelSettingsobject

Optional

Not PII

Channel-specific configuration settings including timeout settings and capture rules.

Example:

{"SMS":{"statusTimeouts":{"inactive":10,"closed":15},"captureRules":[{"from":"+18005550100","to":"+18005550101","metadata":{}},{"from":"+18005550103","to":"*","metadata":{}},{"from":"*","to":"+18005550103","metadata":{}}]},"VOICE":{"statusTimeouts":{"inactive":5,"closed":30},"captureRules":[{"from":"+18005550104","to":"+18005550105","metadata":{"callType":"PSTN"}},{"from":"+18005550106","to":"*","metadata":{}},{"from":"*","to":"+18005550106","metadata":{}}]},"WHATSAPP":{"statusTimeouts":{"inactive":15,"closed":60},"captureRules":[{"from":"whatsapp:+18005550100","to":"*","metadata":{}},{"from":"*","to":"whatsapp:+18005550100","metadata":{}}]},"RCS":{"statusTimeouts":{"inactive":15,"closed":60},"captureRules":[{"from":"rcs:brand_acme_agent","to":"*","metadata":{}},{"from":"*","to":"rcs:brand_acme_agent","metadata":{}},{"from":"rcs:+18005550107","to":"*","metadata":{}}]},"CHAT":{"statusTimeouts":{"inactive":15,"closed":60},"captureRules":[{"from":"*","to":"*","metadata":{"chatService":"IS00000000000000000000000000000000"}}]}}

Show channelSettings properties

statusCallbacksarray[object]

Optional

Not PII

List of default webhook configurations applied to Conversations under this Configuration.

Max items: 20

Show statusCallbacks properties

intelligenceConfigurationIdsarray[string]

Optional

Not PII

A list of Conversational Intelligence configuration IDs.

Example: ["agent1","agent2"]Max items: 5

memoryExtractionEnabledboolean

Optional

Not PII

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

Default: falseExample: false

conversationsV1Bridgeobject

Optional

Not PII

Configuration for Conversations V1 bridge. When set, messaging channels route through Conversations V1. Use this to integrate with existing Conversations V1 applications.

Example: {"serviceId":"IS00000000000000000000000000000000"}

Show conversationsV1Bridge properties

createdAtstring<date-time>

read-only

Optional

Not PII

Timestamp when this Configuration was created.

Example: 2023-10-14T10:30:00Z

updatedAtstring<date-time>

read-only

Optional

Not PII

Timestamp when this Configuration was last updated.

Example: 2023-10-14T15:45:30Z

versioninteger<int64>

read-only

Optional

Not PII

Version number used for optimistic locking.

Example: 1

Fetch Configuration

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchConfiguration() {
11  const configuration = await client.conversations.v2
12    .configurations("Sid")
13    .fetch();
14
15  console.log(configuration.id);
16}
17
18fetchConfiguration();

Response

1{
2  "channelSettings": {},
3  "conversationGroupingType": "GROUP_BY_PROFILE",
4  "conversationsV1Bridge": {
5    "serviceId": "IS00000000000000000000000000000000"
6  },
7  "createdAt": "2009-07-06T20:30:00Z",
8  "description": "description",
9  "displayName": "My Support Config",
10  "id": "id",
11  "intelligenceConfigurationIds": [
12    "intelligenceConfigurationIds"
13  ],
14  "memoryExtractionEnabled": false,
15  "memoryStoreId": "memoryStoreId",
16  "statusCallbacks": [
17    {
18      "url": "https://www.example.com",
19      "method": "POST"
20    }
21  ],
22  "updatedAt": "2009-07-06T20:30:00Z",
23  "version": 1
24}