Skip to contentSkip to navigationSkip to topbar
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>

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

The name of this Flex Plugin Configuration.


descriptionstring
PII MTL: 30 days

The description of the Flex Plugin Configuration resource.


archivedboolean

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


urlstring<uri>

The absolute URL of the Flex Plugin Configuration resource.


linksobject<uri-map>

Create a PluginConfiguration resource

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

Headers

headers page anchor
Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional

The Flex-Metadata HTTP request header

Property nameTypeRequiredPIIDescription
Namestringrequired

The Flex Plugin Configuration's name.


PluginsarrayOptional

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


DescriptionstringOptional

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

_13
// Download the helper library from https://www.twilio.com/docs/node/install
_13
// Find your Account SID and Auth Token at twilio.com/console
_13
// and set the environment variables. See http://twil.io/secure
_13
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13
const authToken = process.env.TWILIO_AUTH_TOKEN;
_13
const client = require('twilio')(accountSid, authToken);
_13
_13
client.flexApi.v1.pluginConfigurations
_13
.create({
_13
plugins: [{'plugin_version': 'FV00000000000000000000000000000000'}],
_13
name: 'name'
_13
})
_13
.then(plugin_configuration => console.log(plugin_configuration.sid));

Output

_12
{
_12
"sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_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/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"links": {
_12
"plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/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

_13
// Download the helper library from https://www.twilio.com/docs/node/install
_13
// Find your Account SID and Auth Token at twilio.com/console
_13
// and set the environment variables. See http://twil.io/secure
_13
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13
const authToken = process.env.TWILIO_AUTH_TOKEN;
_13
const client = require('twilio')(accountSid, authToken);
_13
_13
client.flexApi.v1.pluginConfigurations
_13
.create({
_13
plugins: [{'plugin_version': 'FV00000000000000000000000000000000'}, {'plugin_version': 'FV00000000000000000000000000000001'}],
_13
name: 'name'
_13
})
_13
.then(plugin_configuration => console.log(plugin_configuration.sid));

Output

_12
{
_12
"sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_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/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"links": {
_12
"plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Plugins"
_12
}
_12
}


Fetch a PluginConfiguration resource

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

Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional

The Flex-Metadata HTTP request header

Property nameTypeRequiredPIIDescription
SidSID<FJ>required

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

_10
// Download the helper library from https://www.twilio.com/docs/node/install
_10
// Find your Account SID and Auth Token at twilio.com/console
_10
// and set the environment variables. See http://twil.io/secure
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.flexApi.v1.pluginConfigurations('FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(plugin_configuration => console.log(plugin_configuration.name));

Output

_12
{
_12
"sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_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/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"links": {
_12
"plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Plugins"
_12
}
_12
}


Read multiple PluginConfiguration resources

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

Property nameTypeRequiredPIIDescription
Flex-MetadatastringOptional

The Flex-Metadata HTTP request header

Property nameTypeRequiredPIIDescription
PageSizeintegerOptional

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

Minimum: 1Maximum: 1000

PageintegerOptional

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

Minimum: 0

PageTokenstringOptional

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

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

Output

_25
{
_25
"configurations": [
_25
{
_25
"sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"name": "some name",
_25
"description": "description",
_25
"archived": false,
_25
"date_created": "2020-01-10T20:00:00Z",
_25
"url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"links": {
_25
"plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Plugins"
_25
}
_25
}
_25
],
_25
"meta": {
_25
"page": 0,
_25
"page_size": 50,
_25
"first_page_url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0",
_25
"previous_page_url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0",
_25
"url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=0",
_25
"next_page_url": "https://flex-api.twilio.com/v1/PluginService/Configurations?PageSize=50&Page=1",
_25
"key": "configurations"
_25
}
_25
}


Rate this page: