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

Plugin Version Resource


A Plugin Version contains all the information about a particular version of a Plugin. Some notable fields include the URL to the plugin package, the version number and what plugin is it the version of.

Providing a URL to the built package in the plugin version provides you the flexibility of hosting your package in the software of your choice.


PluginVersion Properties

pluginversion-properties page anchor
Resource properties
sidtype: SID<FV>Not PII

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


plugin_sidtype: SID<FP>Not PII

The SID of the Flex Plugin resource this Flex Plugin Version belongs to.


versiontype: stringNot PII

The unique version of this Flex Plugin Version.


plugin_urltype: string<URI>PII MTL: 30 days

The URL of where the Flex Plugin Version JavaScript bundle is hosted on.


changelogtype: stringPII MTL: 30 days

A changelog that describes the changes this Flex Plugin Version brings.


privatetype: booleanNot PII

Whether to inject credentials while accessing this Plugin Version. The default value is false.


archivedtype: booleanNot PII

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


date_createdtype: string<DATE TIME>Not PII

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


urltype: string<URI>Not PII

The absolute URL of the Flex Plugin Version resource.


Create a PluginVersion resource

create-a-pluginversion-resource page anchor
POST https://flex-api.twilio.com/v1/PluginService/Plugins/{PluginSid}/Versions

Parameters

create-parameters page anchor
Request headers
Flex-Metadatatype: stringNot PII

The Flex-Metadata HTTP request header


URI parameters
PluginSidtype: stringNot PII
Path Parameter

The SID of the Flex Plugin the resource to belongs to.


Request body parameters
Versiontype: stringNot PII
Required

The Flex Plugin Version's version.


PluginUrltype: string<URI>PII MTL: 30 days
Required

The URL of the Flex Plugin Version bundle


Changelogtype: stringPII MTL: 30 days

The changelog of the Flex Plugin Version.


Privatetype: booleanNot PII

Whether this Flex Plugin Version requires authorization.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_14
// Download the helper library from https://www.twilio.com/docs/node/install
_14
// Find your Account SID and Auth Token at twilio.com/console
_14
// and set the environment variables. See http://twil.io/secure
_14
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_14
const authToken = process.env.TWILIO_AUTH_TOKEN;
_14
const client = require('twilio')(accountSid, authToken);
_14
_14
client.flexApi.v1.plugins('FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_14
.pluginVersions
_14
.create({
_14
version: 'version',
_14
pluginUrl: 'https://example.com'
_14
})
_14
.then(plugin_versions => console.log(plugin_versions.sid));

Output

_12
{
_12
"sid": "FVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"plugin_sid": "FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"version": "1.0.0",
_12
"plugin_url": "https://sample.twil.io/plugin.js",
_12
"changelog": "the changelog",
_12
"private": true,
_12
"archived": false,
_12
"date_created": "2020-01-10T20:00:00Z",
_12
"url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions/FVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_12
}


Fetch a PluginVersion resource

fetch-a-pluginversion-resource page anchor
GET https://flex-api.twilio.com/v1/PluginService/Plugins/{PluginSid}/Versions/{Sid}

Request headers
Flex-Metadatatype: stringNot PII

The Flex-Metadata HTTP request header


URI parameters
PluginSidtype: stringNot PII
Path Parameter

The SID of the Flex Plugin the resource to belongs to.


Sidtype: stringNot PII
Path Parameter

The SID of the Flex Plugin Version resource to fetch.

Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

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

Output

_12
{
_12
"sid": "FVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"plugin_sid": "FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_12
"version": "1.0.0",
_12
"plugin_url": "https://sample.twil.io/plugin.js",
_12
"changelog": "the changelog",
_12
"private": false,
_12
"archived": false,
_12
"date_created": "2020-01-10T20:00:00Z",
_12
"url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions/FVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_12
}


Read multiple PluginVersion resources

read-multiple-pluginversion-resources page anchor
GET https://flex-api.twilio.com/v1/PluginService/Plugins/{PluginSid}/Versions

Request headers
Flex-Metadatatype: stringNot PII

The Flex-Metadata HTTP request header


URI parameters
PluginSidtype: stringNot PII
Path Parameter

The SID of the Flex Plugin the resource to belongs to.


PageSizetype: integerNot PII
Query Parameter

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


Pagetype: integerNot PII
Query Parameter

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


PageTokentype: stringNot PII
Query Parameter

The page token. This is provided by the API.

List multiple PluginVersions

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

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

Output

_25
{
_25
"plugin_versions": [
_25
{
_25
"sid": "FVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"plugin_sid": "FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_25
"version": "1.0.0",
_25
"plugin_url": "https://sample.twil.io/plugin.js",
_25
"changelog": "the changelog",
_25
"private": false,
_25
"archived": false,
_25
"date_created": "2020-01-10T20:00:00Z",
_25
"url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions/FVXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_25
}
_25
],
_25
"meta": {
_25
"page": 0,
_25
"page_size": 50,
_25
"first_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions?PageSize=50&Page=0",
_25
"previous_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions?PageSize=50&Page=0",
_25
"url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions?PageSize=50&Page=0",
_25
"next_page_url": "https://flex-api.twilio.com/v1/PluginService/Plugins/FPXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Versions?PageSize=50&Page=1",
_25
"key": "plugin_versions"
_25
}
_25
}


Rate this page: