Skip to contentSkip to navigationSkip to topbar
Rate this page:
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

credential-properties page anchor

The Credential resource contains these properties:

sidSID<CR>
Not PII

A 34 character string that uniquely identifies this resource.

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

account_sidSID<AC>

friendly_namestring
PII MTL: 30 days

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


typeenum<string>

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

Possible values:
apngcmfcm

sandboxstring

[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>

The date that this resource was created.


date_updatedstring<date-time>

The date that this resource was last updated.


urlstring<uri>

An absolute API resource URL for this credential.


Create a Credential resource

create-a-credential-resource page anchor
POST https://conversations.twilio.com/v1/Credentials

Request body parameters

request-body-parameters page anchor
Typeenum<string>required

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

Possible values:
apngcmfcm

FriendlyNamestring

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


Certificatestring

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


PrivateKeystring

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


Sandboxboolean

[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

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


Secretstring

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

Create a Credential

create-a-credential page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conversations.v1.credentials
_10
.create({type: 'apn'})
_10
.then(credential => console.log(credential.sid));

Output

_10
{
_10
"sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"friendly_name": "Test slow create",
_10
"type": "apn",
_10
"sandbox": "False",
_10
"date_created": "2015-10-07T17:50:01Z",
_10
"date_updated": "2015-10-07T17:50:01Z",
_10
"url": "https://conversations.twilio.com/v1/Credentials/CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}


Fetch a Credential resource

fetch-a-credential-resource page anchor
GET https://conversations.twilio.com/v1/Credentials/{Sid}

SidSID<CR>required

A 34 character string that uniquely identifies this resource.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conversations.v1.credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.fetch()
_10
.then(credential => console.log(credential.friendlyName));

Output

_10
{
_10
"sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"friendly_name": "Test slow create",
_10
"type": "apn",
_10
"sandbox": "False",
_10
"date_created": "2015-10-07T17:50:01Z",
_10
"date_updated": "2015-10-07T17:50:01Z",
_10
"url": "https://conversations.twilio.com/v1/Credentials/CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}


Read multiple Credential resources

read-multiple-credential-resources page anchor
GET https://conversations.twilio.com/v1/Credentials

PageSizeinteger

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

Minimum: 1Maximum: 1000

Pageinteger

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

Minimum: 0

PageTokenstring

The page token. This is provided by the API.

List multiple Credentials

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

_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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conversations.v1.credentials
_10
.list({limit: 20})
_10
.then(credentials => credentials.forEach(c => console.log(c.sid)));

Output

_23
{
_23
"credentials": [
_23
{
_23
"sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23
"friendly_name": "Test slow create",
_23
"type": "apn",
_23
"sandbox": "False",
_23
"date_created": "2015-10-07T17:50:01Z",
_23
"date_updated": "2015-10-07T17:50:01Z",
_23
"url": "https://conversations.twilio.com/v1/Credentials/CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_23
}
_23
],
_23
"meta": {
_23
"page": 0,
_23
"page_size": 50,
_23
"first_page_url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0",
_23
"previous_page_url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0",
_23
"url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=0",
_23
"next_page_url": "https://conversations.twilio.com/v1/Credentials?PageSize=50&Page=1",
_23
"key": "credentials"
_23
}
_23
}


Update a Credential resource

update-a-credential-resource page anchor
POST https://conversations.twilio.com/v1/Credentials/{Sid}

SidSID<CR>required

A 34 character string that uniquely identifies this resource.

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

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

Possible values:
apngcmfcm

FriendlyNamestring

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


Certificatestring

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


PrivateKeystring

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


Sandboxboolean

[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

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


Secretstring

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

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

_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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conversations.v1.credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.update({type: 'apn'})
_10
.then(credential => console.log(credential.friendlyName));

Output

_10
{
_10
"sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10
"friendly_name": "Test slow create",
_10
"type": "apn",
_10
"sandbox": "False",
_10
"date_created": "2015-10-07T17:50:01Z",
_10
"date_updated": "2015-10-07T17:50:01Z",
_10
"url": "https://conversations.twilio.com/v1/Credentials/CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
_10
}


Delete a Credential resource

delete-a-credential-resource page anchor
DELETE https://conversations.twilio.com/v1/Credentials/{Sid}

SidSID<CR>required

A 34 character string that uniquely identifies this resource.

Pattern: ^CR[0-9a-fA-F]{32}$Min length: 34Max length: 34
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_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
_10
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10
const authToken = process.env.TWILIO_AUTH_TOKEN;
_10
const client = require('twilio')(accountSid, authToken);
_10
_10
client.conversations.v1.credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10
.remove();


Rate this page: