Plugin Resource
A Plugin is a resource that contains information about a given plugin, like its name, description, and the account that owns the plugin.
While the Plugin Version Resource contains information on the actual source code for a deployed Plugin, the Plugin Resource serves as an identifier for the Plugin itself. For example, you might have a CRM plugin. You can use the Plugin Resource to describe the plugin itself, and then a series of Plugin Versions to reference the source code of your various iterations of the Plugin.
Resource properties
sid
type: SID<FP>
The unique string that we created to identify the Flex Plugin resource.
Pattern:
^FP[0-9a-fA-F]{32}$
unique_name
type: string
The name that uniquely identifies this Flex Plugin resource.
friendly_name
type: string
The friendly name this Flex Plugin resource.
description
type: string
A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
archived
type: boolean
Whether the Flex Plugin is archived. The default value is false.
date_created
type: string<date-time>
date_updated
type: string<date-time>
url
type: string<uri>
The absolute URL of the Flex Plugin resource.
links
type: object<uri-map>
POST https://flex-api.twilio.com/v1/PluginService/Plugins
Request headers
Flex-Metadata
type: string
The Flex-Metadata HTTP request header
Request body parameters
UniqueName
type: stringRequired
The Flex Plugin's unique name.
FriendlyName
type: string
The Flex Plugin's friendly name.
Description
type: string
A descriptive string that you create to describe the plugin resource. It can be up to 500 characters long
_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.plugins
_10 .create({uniqueName: 'unique_name'})
_10 .then(plugin => console.log(plugin.sid));
_14 "sid": "FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "unique_name": "unique-name",
_14 "friendly_name": "friendly name",
_14 "description": "description",
_14 "date_created": "2020-01-10T20:00:00Z",
_14 "date_updated": "2020-01-10T20:00:00Z",
_14 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions"
GET https://flex-api.twilio.com/v1/PluginService/Plugins/{Sid}
Request headers
Flex-Metadata
type: string
The Flex-Metadata HTTP request header
URI parameters
Sid
type: string
The SID of the Flex Plugin resource to fetch.
_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.plugins('FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .then(plugin => console.log(plugin.uniqueName));
_14 "sid": "FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "unique_name": "unique-name",
_14 "friendly_name": "friendly name",
_14 "description": "description",
_14 "date_created": "2020-01-10T20:00:00Z",
_14 "date_updated": "2020-01-10T20:00:00Z",
_14 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions"
GET https://flex-api.twilio.com/v1/PluginService/Plugins
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.plugins
_10 .then(plugins => plugins.forEach(p => console.log(p.sid)));
_27 "sid": "FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_27 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_27 "unique_name": "unique-name",
_27 "friendly_name": "friendly name",
_27 "description": "description",
_27 "date_created": "2020-01-10T20:00:00Z",
_27 "date_updated": "2020-01-10T20:00:00Z",
_27 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_27 "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions"
_27 "first_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0",
_27 "previous_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0",
_27 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=0",
_27 "next_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins?PageSize=50&Page=1",
POST https://flex-api.twilio.com/v1/PluginService/Plugins/{Sid}
Request headers
Flex-Metadata
type: string
The Flex-Metadata HTTP request header
URI parameters
Sid
type: string
The SID of the Flex Plugin resource to update.
Request body parameters
FriendlyName
type: string
The Flex Plugin's friendly name.
Description
type: string
A descriptive string that you update to describe the plugin resource. It can be up to 500 characters long
_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.plugins('FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .update({friendlyName: 'friendly_name'})
_10 .then(plugin => console.log(plugin.uniqueName));
_14 "sid": "FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "unique_name": "unique-name",
_14 "friendly_name": "friendly name update",
_14 "description": "description update",
_14 "date_created": "2020-01-10T20:00:00Z",
_14 "date_updated": "2020-01-10T20:00:00Z",
_14 "url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_14 "plugin_versions": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions"