Skip to content Skip to navigation Skip to topbar

On this page

Function

Functions are JavaScript Node.js code that execute at a particular domain.

The steps to create Functions are as follows:

Create a Function (this resource)
Create a Function Version via serverless.twilio.com

We will need the Function Version SID to include this Function in a Build.

Function Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<ZH>Optional

Not PII

The unique string that we created to identify the Function resource.

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

account_sidSID<AC>Optional

Not PII

The SID of the Account that created the Function resource.

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

service_sidSID<ZS>Optional

Not PII

The SID of the Service that the Function resource is associated with.

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

friendly_namestringOptional

PII MTL: 7 days

The string that you assigned to describe the Function resource. It can be a maximum of 255 characters.

date_createdstring<date-time>Optional

Not PII

The date and time in GMT when the Function resource was created specified in ISO 8601 format.

date_updatedstring<date-time>Optional

Not PII

The date and time in GMT when the Function resource was last updated specified in ISO 8601 format.

urlstring<uri>Optional

Not PII

The absolute URL of the Function resource.

linksobject<uri-map>Optional

Not PII

The URLs of nested resources of the Function resource.

Create a Function resource

POST https://serverless.twilio.com/v1/Services/{ServiceSid}/Functions

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to create the Function resource under.

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestringrequired

PII MTL: 7 days

A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters.

Create a Function

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function createFunction() {
11  const func = await client.serverless.v1
12    .services("ServiceSid")
13    .functions.create({ friendlyName: "FriendlyName" });
14
15  console.log(func.sid);
16}
17
18createFunction();

Output

1{
2  "sid": "ZH00000000000000000000000000000000",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "friendly_name": "FriendlyName",
6  "date_created": "2018-11-10T20:00:00Z",
7  "date_updated": "2018-11-10T20:00:00Z",
8  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000",
9  "links": {
10    "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions"
11  }
12}

Fetch a Function resource

GET https://serverless.twilio.com/v1/Services/{ServiceSid}/Functions/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to fetch the Function resource from.

SidSID<ZH>required

Not PII

The SID of the Function resource to fetch.

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

Fetch a Function

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchFunction() {
11  const func = await client.serverless.v1
12    .services("ServiceSid")
13    .functions("ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .fetch();
15
16  console.log(func.sid);
17}
18
19fetchFunction();

Output

1{
2  "sid": "ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "friendly_name": "test-function",
6  "date_created": "2018-11-10T20:00:00Z",
7  "date_updated": "2018-11-10T20:00:00Z",
8  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000",
9  "links": {
10    "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions"
11  }
12}

Read multiple Function resources

GET https://serverless.twilio.com/v1/Services/{ServiceSid}/Functions

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to read the Function resources from.

Query parameters

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 Functions

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function listFunction() {
11  const funcs = await client.serverless.v1
12    .services("ServiceSid")
13    .functions.list({ limit: 20 });
14
15  funcs.forEach((f) => console.log(f.sid));
16}
17
18listFunction();

Output

1{
2  "functions": [],
3  "meta": {
4    "first_page_url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0",
5    "key": "functions",
6    "next_page_url": null,
7    "page": 0,
8    "page_size": 50,
9    "previous_page_url": null,
10    "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions?PageSize=50&Page=0"
11  }
12}

Update a Function resource

POST https://serverless.twilio.com/v1/Services/{ServiceSid}/Functions/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to update the Function resource from.

SidSID<ZH>required

Not PII

The SID of the Function resource to update.

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestringrequired

PII MTL: 7 days

A descriptive string that you create to describe the Function resource. It can be a maximum of 255 characters.

Update a Function

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateFunction() {
11  const func = await client.serverless.v1
12    .services("ServiceSid")
13    .functions("ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .update({ friendlyName: "FriendlyName" });
15
16  console.log(func.sid);
17}
18
19updateFunction();

Output

1{
2  "sid": "ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "service_sid": "ServiceSid",
5  "friendly_name": "FriendlyName",
6  "date_created": "2018-11-10T20:00:00Z",
7  "date_updated": "2018-11-10T20:00:00Z",
8  "url": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000",
9  "links": {
10    "function_versions": "https://serverless.twilio.com/v1/Services/ZS00000000000000000000000000000000/Functions/ZH00000000000000000000000000000000/Versions"
11  }
12}

Delete a Function resource

DELETE https://serverless.twilio.com/v1/Services/{ServiceSid}/Functions/{Sid}

(information)

Info

A Function will fail to delete if any of its Versions are referenced by an active Build.

If necessary, create a new Build that does not include the Function to be deleted, and delete the Function only once the Build has completed.

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidstringrequired

Not PII

The SID of the Service to delete the Function resource from.

SidSID<ZH>required

Not PII

The SID of the Function resource to delete.

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

Delete a Function

1// Download the helper library from https://www.twilio.com/docs/node/install
2const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3
4// Find your Account SID and Auth Token at twilio.com/console
5// and set the environment variables. See http://twil.io/secure
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function deleteFunction() {
11  await client.serverless.v1
12    .services("ServiceSid")
13    .functions("ZHaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .remove();
15}
16
17deleteFunction();