Skip to content Skip to navigation Skip to topbar

On this page

Credential Resource

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

Credential Properties

The Credential resource contains these properties:

Property nameTypeRequiredDescriptionChild properties

sidSID<CR>Optional

A 34 character string that uniquely identifies this resource.

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

account_sidSID<AC>Optional

The unique ID of the Account responsible for this credential.

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

friendly_namestringOptional

PII MTL: 30 days

The human-readable name of this credential, limited to 64 characters. Optional.

typeenum<string>Optional

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

Possible values:

apngcmfcm

sandboxstringOptional

[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 that this resource was created.

date_updatedstring<date-time>Optional

The date that this resource was last updated.

urlstring<uri>Optional

An absolute API resource URL for this credential.

Create a Credential resource

POST https://conversations.twilio.com/v1/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: fcm, gcm, or apn.

Possible values:

apngcmfcm

FriendlyNamestringOptional

PII MTL: 30 days

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

CertificatestringOptional

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

PrivateKeystringOptional

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

SandboxbooleanOptional

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

ApiKeystringOptional

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

SecretstringOptional

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

Create a Credential

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.conversations.v1.credentials.create({
12    type: "apn",
13  });
14
15  console.log(credential.sid);
16}
17
18createCredential();

Output

1{
2  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Test slow create",
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://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
10}

Fetch a Credential resource

GET https://conversations.twilio.com/v1/Credentials/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<CR>required

A 34 character string that uniquely identifies this resource.

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

Fetch a Credential

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 fetchCredential() {
11  const credential = await client.conversations.v1
12    .credentials("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .fetch();
14
15  console.log(credential.sid);
16}
17
18fetchCredential();

Output

1{
2  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Test slow create",
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://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
10}

Read multiple Credential resources

GET https://conversations.twilio.com/v1/Credentials

Query parameters

Property nameTypeRequiredPIIDescription

PageSizeintegerOptional

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

Minimum: 1Maximum: 1000

PageintegerOptional

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

Minimum: 0

PageTokenstringOptional

The page token. This is provided by the API.

List multiple Credentials

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.conversations.v1.credentials.list({
12    limit: 20,
13  });
14
15  credentials.forEach((c) => console.log(c.sid));
16}
17
18listCredential();

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://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
12    }
13  ],
14  "meta": {
15    "page": 0,
16    "page_size": 50,
17    "first_page_url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0",
18    "previous_page_url": null,
19    "url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0",
20    "next_page_url": null,
21    "key": "credentials"
22  }
23}

Update a Credential resource

POST https://conversations.twilio.com/v1/Credentials/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<CR>required

A 34 character string that uniquely identifies this resource.

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

Typeenum<string>Optional

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

Possible values:

apngcmfcm

FriendlyNamestringOptional

PII MTL: 30 days

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

CertificatestringOptional

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

PrivateKeystringOptional

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

SandboxbooleanOptional

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

ApiKeystringOptional

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

SecretstringOptional

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

Update a Credential

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.conversations.v1
12    .credentials("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .update({ type: "apn" });
14
15  console.log(credential.sid);
16}
17
18updateCredential();

Output

1{
2  "sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "friendly_name": "Test slow create",
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://conversations.twilio.com/v1/Credentials/CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
10}

Delete a Credential resource

DELETE https://conversations.twilio.com/v1/Credentials/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

SidSID<CR>required

A 34 character string that uniquely identifies this resource.

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

Delete a Credential

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.conversations.v1
12    .credentials("CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .remove();
14}
15
16deleteCredential();