Skip to contentSkip to navigationSkip to topbar
Twilio Docs
Rate this page:
On this page

Plugin Configuration Resource

Configurations contain a snapshot of your contact center's customizations so that it can be audited or rolled back. It is a package of your plugin versions that you bundle together for a release. Configurations contain Plugin Version SIDs and are defined as a list of JSON strings. For example:


_10
[{"plugin_version": "FV00000000000000000000000000000000"}, {"plugin_version": "FV00000000000000000000000000000001"}]

Configurations are immutable; in order to update your contact center's Configuration, you must create a new Configuration.

PluginConfiguration Properties

pluginconfiguration-properties page anchor
Property nameTypePIIDescription
sidSID<FJ>
Not PII

The unique string that we created to identify the Flex Plugin Configuration resource.

Pattern: ^FJ[0-9a-fA-F]{32}$Min length: 34Max length: 34
account_sidSID<AC>
Not PII

The SID of the Account that created the Flex Plugin Configuration resource and owns this resource.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34
namestring
Not PII

The name of this Flex Plugin Configuration.

descriptionstring
PII MTL: 30 days

The description of the Flex Plugin Configuration resource.

archivedboolean
Not PII

Whether the Flex Plugin Configuration is archived. The default value is false.

date_createdstring<date-time>
Not PII

The date and time in GMT when the Flex Plugin Configuration was created specified in ISO 8601(link takes you to an external page) format.

urlstring<uri>
Not PII

The absolute URL of the Flex Plugin Configuration resource.

linksobject<uri-map>
Not PII

Create a PluginConfiguration resource

create-a-pluginconfiguration-resource page anchor
POST https://flex.twilio.com/v1/PluginService/Configurations

Headers

headers page anchor
Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional
Not PII

The Flex-Metadata HTTP request header

Request body parameters

request-body-parameters page anchor
Property nameTypeRequiredPIIDescription
Namestringrequired
Not PII

The Flex Plugin Configuration's name.

PluginsarrayOptional
Not PII

A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version.

DescriptionstringOptional
PII MTL: 30 days

The Flex Plugin Configuration's description.

Create a Configuration with a single Plugin

create-a-configuration-with-a-single-plugin page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_24
// Download the helper library from https://www.twilio.com/docs/node/install
_24
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_24
_24
// Find your Account SID and Auth Token at twilio.com/console
_24
// and set the environment variables. See http://twil.io/secure
_24
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_24
const authToken = process.env.TWILIO_AUTH_TOKEN;
_24
const client = twilio(accountSid, authToken);
_24
_24
async function createPluginConfiguration() {
_24
const pluginConfiguration =
_24
await client.flexApi.v1.pluginConfigurations.create({
_24
name: "Name",
_24
plugins: [
_24
{
_24
plugin_version: "FV00000000000000000000000000000000",
_24
},
_24
],
_24
});
_24
_24
console.log(pluginConfiguration.sid);
_24
}
_24
_24
createPluginConfiguration();

Output

_12
{
_12
"sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"name": "Name",
_12
"description": "description",
_12
"archived": false,
_12
"date_created": "2020-01-10T20:00:00Z",
_12
"url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"links": {
_12
"plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins"
_12
}
_12
}

Create a Configuration with multiple Plugins

create-a-configuration-with-multiple-plugins page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_27
// Download the helper library from https://www.twilio.com/docs/node/install
_27
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_27
_27
// Find your Account SID and Auth Token at twilio.com/console
_27
// and set the environment variables. See http://twil.io/secure
_27
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_27
const authToken = process.env.TWILIO_AUTH_TOKEN;
_27
const client = twilio(accountSid, authToken);
_27
_27
async function createPluginConfiguration() {
_27
const pluginConfiguration =
_27
await client.flexApi.v1.pluginConfigurations.create({
_27
name: "Name",
_27
plugins: [
_27
{
_27
plugin_version: "FV00000000000000000000000000000000",
_27
},
_27
{
_27
plugin_version: "FV00000000000000000000000000000001",
_27
},
_27
],
_27
});
_27
_27
console.log(pluginConfiguration.sid);
_27
}
_27
_27
createPluginConfiguration();

Output

_12
{
_12
"sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"name": "Name",
_12
"description": "description",
_12
"archived": false,
_12
"date_created": "2020-01-10T20:00:00Z",
_12
"url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"links": {
_12
"plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins"
_12
}
_12
}

Fetch a PluginConfiguration resource

fetch-a-pluginconfiguration-resource page anchor
GET https://flex.twilio.com/v1/PluginService/Configurations/{Sid}

Headers

headers-1 page anchor
Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional
Not PII

The Flex-Metadata HTTP request header

Path parameters

path-parameters page anchor
Property nameTypeRequiredPIIDescription
SidSID<FJ>required
Not PII

The SID of the Flex Plugin Configuration resource to fetch.

Pattern: ^FJ[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a PluginConfiguration

fetch-a-pluginconfiguration page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_18
// Download the helper library from https://www.twilio.com/docs/node/install
_18
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_18
_18
// Find your Account SID and Auth Token at twilio.com/console
_18
// and set the environment variables. See http://twil.io/secure
_18
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_18
const authToken = process.env.TWILIO_AUTH_TOKEN;
_18
const client = twilio(accountSid, authToken);
_18
_18
async function fetchPluginConfiguration() {
_18
const pluginConfiguration = await client.flexApi.v1
_18
.pluginConfigurations("FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
_18
.fetch();
_18
_18
console.log(pluginConfiguration.sid);
_18
}
_18
_18
fetchPluginConfiguration();

Output

_12
{
_12
"sid": "FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"name": "some name",
_12
"description": "description",
_12
"archived": false,
_12
"date_created": "2020-01-10T20:00:00Z",
_12
"url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
_12
"links": {
_12
"plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Plugins"
_12
}
_12
}

Read multiple PluginConfiguration resources

read-multiple-pluginconfiguration-resources page anchor
GET https://flex.twilio.com/v1/PluginService/Configurations

Headers

headers-2 page anchor
Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional
Not PII

The Flex-Metadata HTTP request header

Query parameters

query-parameters page anchor
Property nameTypeRequiredPIIDescription
PageSizeintegerOptional
Not PII

How many resources to return in each list page. The default is 50, and the maximum is 1000.

Minimum: 1Maximum: 1000
PageintegerOptional
Not PII

The page index. This value is simply for client state.

Minimum: 0
PageTokenstringOptional
Not PII

The page token. This is provided by the API.

List multiple PluginConfigurations

list-multiple-pluginconfigurations page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_17
// Download the helper library from https://www.twilio.com/docs/node/install
_17
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
_17
_17
// Find your Account SID and Auth Token at twilio.com/console
_17
// and set the environment variables. See http://twil.io/secure
_17
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_17
const authToken = process.env.TWILIO_AUTH_TOKEN;
_17
const client = twilio(accountSid, authToken);
_17
_17
async function listPluginConfiguration() {
_17
const pluginConfigurations =
_17
await client.flexApi.v1.pluginConfigurations.list({ limit: 20 });
_17
_17
pluginConfigurations.forEach((p) => console.log(p.sid));
_17
}
_17
_17
listPluginConfiguration();

Output

_12
{
_12
"configurations": [],
_12
"meta": {
_12
"page": 0,
_12
"page_size": 50,
_12
"first_page_url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0",
_12
"previous_page_url": null,
_12
"url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0",
_12
"next_page_url": null,
_12
"key": "configurations"
_12
}
_12
}

Rate this page: