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.
The Credential resource contains these properties:
Resource properties
sid
type: SID<CR>
A 34 character string that uniquely identifies this resource.
Pattern:
^CR[0-9a-fA-F]{32}$
friendly_name
type: string
The human-readable name of this credential, limited to 64 characters. Optional.
type
type: enum<string>
The type of push-notification service the credential is for. Can be: fcm
, gcm
, or apn
.
Possible values:
apn
gcm
fcm
sandbox
type: string
[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_created
type: string<date-time>
The date that this resource was created.
date_updated
type: string<date-time>
The date that this resource was last updated.
url
type: string<uri>
An absolute API resource URL for this credential.
POST https://conversations.twilio.com/v1/Credentials
Request body parameters
Type
type: enum<string>Required
The type of push-notification service the credential is for. Can be: fcm
, gcm
, or apn
.
Possible values:
apn
gcm
fcm
FriendlyName
type: string
A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
Certificate
type: string
[APN only] The URL encoded representation of the certificate. For example,
-----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A== -----END CERTIFICATE-----
.
PrivateKey
type: string
[APN only] The URL encoded representation of the private key. For example,
-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----
.
Sandbox
type: boolean
[APN only] Whether to send the credential to sandbox APNs. Can be true
to send to sandbox APNs or false
to send to production.
ApiKey
type: string
[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
Secret
type: string
[FCM only] The Server key of your project from the Firebase console, found under Settings / Cloud messaging.
_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
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10client.conversations.v1.credentials
_10 .create({type: 'apn'})
_10 .then(credential => console.log(credential.sid));
_10 "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "friendly_name": "Test slow create",
_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"
GET https://conversations.twilio.com/v1/Credentials/{Sid}
URI parameters
Sid
type: SID<CR>
A 34 character string that uniquely identifies this resource.
Pattern:
^CR[0-9a-fA-F]{32}$
_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
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10client.conversations.v1.credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .then(credential => console.log(credential.friendlyName));
_10 "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "friendly_name": "Test slow create",
_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"
GET https://conversations.twilio.com/v1/Credentials
URI parameters
PageSize
type: integer
How many resources to return in each list page. The default is 50, and the maximum is 1000.
Page
type: integer
The page index. This value is simply for client state.
PageToken
type: string
The page token. This is provided by the API.
_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
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10client.conversations.v1.credentials
_10 .then(credentials => credentials.forEach(c => console.log(c.sid)));
_23 "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_23 "friendly_name": "Test slow create",
_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 "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",
POST https://conversations.twilio.com/v1/Credentials/{Sid}
URI parameters
Sid
type: SID<CR>
A 34 character string that uniquely identifies this resource.
Pattern:
^CR[0-9a-fA-F]{32}$
Request body parameters
Type
type: enum<string>
The type of push-notification service the credential is for. Can be: fcm
, gcm
, or apn
.
Possible values:
apn
gcm
fcm
FriendlyName
type: string
A descriptive string that you create to describe the new resource. It can be up to 64 characters long.
Certificate
type: string
[APN only] The URL encoded representation of the certificate. For example,
-----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEF.....A== -----END CERTIFICATE-----
.
PrivateKey
type: string
[APN only] The URL encoded representation of the private key. For example,
-----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fG... -----END RSA PRIVATE KEY-----
.
Sandbox
type: boolean
[APN only] Whether to send the credential to sandbox APNs. Can be true
to send to sandbox APNs or false
to send to production.
ApiKey
type: string
[GCM only] The API key for the project that was obtained from the Google Developer console for your GCM Service application credential.
Secret
type: string
[FCM only] The Server key of your project from the Firebase console, found under Settings / Cloud messaging.
_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
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10client.conversations.v1.credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_10 .update({type: 'apn'})
_10 .then(credential => console.log(credential.friendlyName));
_10 "sid": "CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_10 "friendly_name": "Test slow create",
_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"
DELETE https://conversations.twilio.com/v1/Credentials/{Sid}
URI parameters
Sid
type: SID<CR>
A 34 character string that uniquely identifies this resource.
Pattern:
^CR[0-9a-fA-F]{32}$
_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
_10const accountSid = process.env.TWILIO_ACCOUNT_SID;
_10const authToken = process.env.TWILIO_AUTH_TOKEN;
_10const client = require('twilio')(accountSid, authToken);
_10client.conversations.v1.credentials('CRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')