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.
Resource properties
sid
type: SID<FJ>
The unique string that we created to identify the Flex Plugin Configuration resource.
Pattern:
^FJ[0-9a-fA-F]{32}$
name
type: string
The name of this Flex Plugin Configuration.
description
type: string
The description of the Flex Plugin Configuration resource.
archived
type: boolean
Whether the Flex Plugin Configuration is archived. The default value is false.
date_created
type: string<date-time>
url
type: string<uri>
The absolute URL of the Flex Plugin Configuration resource.
links
type: object<uri-map>
POST https://flex-api.twilio.com/v1/PluginService/Configurations
Request headers
Flex-Metadata
type: string
The Flex-Metadata HTTP request header
Request body parameters
Name
type: stringRequired
The Flex Plugin Configuration's name.
Plugins
type: array
A list of objects that describe the plugin versions included in the configuration. Each object contains the sid of the plugin version.
Description
type: string
The Flex Plugin Configuration's description.
_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
_13const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13const authToken = process.env.TWILIO_AUTH_TOKEN;
_13const client = require('twilio')(accountSid, authToken);
_13client.flexApi.v1.pluginConfigurations
_13 plugins: [{'plugin_version': 'FV00000000000000000000000000000000'}],
_13 .then(plugin_configuration => console.log(plugin_configuration.sid));
_12 "sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "description": "description",
_12 "date_created": "2020-01-10T20:00:00Z",
_12 "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Plugins"
_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
_13const accountSid = process.env.TWILIO_ACCOUNT_SID;
_13const authToken = process.env.TWILIO_AUTH_TOKEN;
_13const client = require('twilio')(accountSid, authToken);
_13client.flexApi.v1.pluginConfigurations
_13 plugins: [{'plugin_version': 'FV00000000000000000000000000000000'}, {'plugin_version': 'FV00000000000000000000000000000001'}],
_13 .then(plugin_configuration => console.log(plugin_configuration.sid));
_12 "sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "description": "description",
_12 "date_created": "2020-01-10T20:00:00Z",
_12 "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Plugins"
GET https://flex-api.twilio.com/v1/PluginService/Configurations/{Sid}
Request headers
Flex-Metadata
type: string
The Flex-Metadata HTTP request header
URI parameters
Sid
type: SID<FJ>
The SID of the Flex Plugin Configuration resource to fetch.
Pattern:
^FJ[0-9a-fA-F]{32}$
_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
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10client.flexApi.v1.pluginConfigurations('FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .then(plugin_configuration => console.log(plugin_configuration.name));
_12 "sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "description": "description",
_12 "date_created": "2020-01-10T20:00:00Z",
_12 "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12 "plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Plugins"
GET https://flex-api.twilio.com/v1/PluginService/Configurations
Request headers
Flex-Metadata
type: string
The Flex-Metadata HTTP request header
URI parameters
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_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
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10client.flexApi.v1.pluginConfigurations
_10 .then(pluginConfigurations => pluginConfigurations.forEach(p => console.log(p.sid)));
_25 "sid": "FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "description": "description",
_25 "date_created": "2020-01-10T20:00:00Z",
_25 "url": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25 "plugins": "https://flex-api.twilio.com/v1/PluginService/Configurations/FJXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Plugins"
_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"