Skip to content Skip to navigation Skip to topbar

On this page

Programmable Chat API Credential Resource

(error)

Danger

Programmable Chat has been deprecated and is no longer supported. Instead, we'll be focusing on the next generation of chat: Twilio Conversations. Find out more about the EOL process here.

If you're starting a new project, please visit the Conversations Docs to begin. If you've already built on Programmable Chat, please visit our Migration Guide to learn about how to switch.

A Credential resource represents one credential record for a specific push notifications channel. We support the APNS, FCM, and GCM push notification channels. Each push notification channel vendor issues its own Credentials and they can vary between vendors. This resource allows you to save the Credentials that should be used for push notifications to a specific channel.

You can learn more about provisioning vendor-specific credentials in these topics.

Twilio Console

You can also manage the Credentials for Programmable Chat in your Twilio console when you are logged in.

Credential Properties

Each Credential resource contains these properties.

Property nameTypeRequiredDescriptionChild properties

sidSID<CR>

Optional

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

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

account_sidSID<AC>

Optional

The SID of the Account that created the Credential resource.

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

friendly_namestring

Optional

PII MTL: 30 days

The string that you assigned to describe the resource.

typeenum<string>

Optional

The type of push-notification service the credential is for. Can be: gcm, fcm, or apn.

Possible values:

gcmapnfcm

sandboxstring

Optional

[APN only] Whether to send the credential to sandbox APNs. Can be true to send to sandbox APNs or false to send to production.

date_createdstring<date-time>

Optional

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

date_updatedstring<date-time>

Optional

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

urlstring<uri>

Optional

The absolute URL of the Credential resource.

Create a Credential resource

POST https://chat.twilio.com/v2/Credentials

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

Typeenum<string>required

The type of push-notification service the credential is for. Can be: gcm, fcm, or apn.

Possible values:

gcmapnfcm

FriendlyNamestring

Optional

PII MTL: 30 days

A descriptive string that you create to describe the new resource. It can be up to 64 characters long.

Certificatestring

Optional

[APN only] The URL encoded representation of the certificate. For example, -----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A== -----END CERTIFICATE-----

PrivateKeystring

Optional

[APN only] The URL encoded representation of the private key. For example, -----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----

Sandboxboolean

Optional

[APN only] Whether to send the credential to sandbox APNs. Can be true to send to sandbox APNs or false to send to production.

ApiKeystring

Optional

[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.

Secretstring

Optional

[FCM only] The Server key of your project from the Firebase console, found under Settings / Cloud messaging.

Create a Credential resource

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 createCredential() {
11  const credential = await client.chat.v2.credentials.create({ type: "gcm" });
12
13  console.log(credential.sid);
14}
15
16createCredential();

Output

1{
2  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Test slow create",
5  "type": "gcm",
6  "sandbox": "False",
7  "date_created": "2015-10-07T17:50:01Z",
8  "date_updated": "2015-10-07T17:50:01Z",
9  "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
10}

Fetch a Credential resource

GET https://chat.twilio.com/v2/Credentials/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<CR>required

The SID of the Credential resource to fetch.

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

Fetch a Credential resource

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 createCredential() {
11  const credential = await client.chat.v2.credentials.create({ type: "gcm" });
12
13  console.log(credential.sid);
14}
15
16createCredential();

Output

1{
2  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Test slow create",
5  "type": "gcm",
6  "sandbox": "False",
7  "date_created": "2015-10-07T17:50:01Z",
8  "date_updated": "2015-10-07T17:50:01Z",
9  "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
10}

Read multiple Credential resources

GET https://chat.twilio.com/v2/Credentials

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeinteger

Optional

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

Minimum: 1Maximum: 1000

Pageinteger

Optional

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

Minimum: 0

PageTokenstring

Optional

The page token. This is provided by the API.

Read multiple Credential resources

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 listCredential() {
11  const credentials = await client.chat.v2.credentials.list({ limit: 20 });
12
13  credentials.forEach((c) => console.log(c.sid));
14}
15
16listCredential();

Output

1{
2  "credentials": [
3    {
4      "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
6      "friendly_name": "Test slow create",
7      "type": "apn",
8      "sandbox": "False",
9      "date_created": "2015-10-07T17:50:01Z",
10      "date_updated": "2015-10-07T17:50:01Z",
11      "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
12    }
13  ],
14  "meta": {
15    "page": 0,
16    "page_size": 50,
17    "first_page_url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0",
18    "previous_page_url": null,
19    "url": "https://chat.twilio.com/v2/Credentials?PageSize=50&Page=0",
20    "next_page_url": null,
21    "key": "credentials"
22  }
23}

Update a Credential resource

POST https://chat.twilio.com/v2/Credentials/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<CR>required

The SID of the Credential resource to update.

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

Request body parameters

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

SchemaExample

Property nameTypeRequiredDescriptionChild properties

FriendlyNamestring

Optional

PII MTL: 30 days

A descriptive string that you create to describe the resource. It can be up to 64 characters long.

Certificatestring

Optional

[APN only] The URL encoded representation of the certificate. For example, -----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A== -----END CERTIFICATE-----

PrivateKeystring

Optional

[APN only] The URL encoded representation of the private key. For example, -----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----

Sandboxboolean

Optional

[APN only] Whether to send the credential to sandbox APNs. Can be true to send to sandbox APNs or false to send to production.

ApiKeystring

Optional

[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.

Secretstring

Optional

[FCM only] The Server key of your project from the Firebase console, found under Settings / Cloud messaging.

Update a Credential resource

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 updateCredential() {
11  const credential = await client.chat.v2
12    .credentials("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .update({ friendlyName: "FriendlyName" });
14
15  console.log(credential.sid);
16}
17
18updateCredential();

Output

1{
2  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "FriendlyName",
5  "type": "apn",
6  "sandbox": "False",
7  "date_created": "2015-10-07T17:50:01Z",
8  "date_updated": "2015-10-07T17:50:01Z",
9  "url": "https://chat.twilio.com/v2/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
10}

Delete a Credential resource

DELETE https://chat.twilio.com/v2/Credentials/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<CR>required

The SID of the Credential resource to delete.

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

Delete a Credential resource

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 deleteCredential() {
11  await client.chat.v2
12    .credentials("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .remove();
14}
15
16deleteCredential();