Menu

Rate this page:

Thanks for rating this page!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Credentials Resource

The Credential resource represents one credential record for a particular push notifications channel. Currently APNS, FCM and GCM types are supported. Credentials are different per push vendor, and are issued by the vendor themselves. This resource allows you to send Twilio credentials that should be used for push notifications.

You can learn more about provisioning vendor specific credentials in these documents:

Twilio Console

You can manage the Credentials for use with Programmable Chat using your Twilio console when logged in to the console.

Properties

Each credential resource has these properties:

Names in PHP format
sid
sid<CR> Not PII

A 34 character string that uniquely identifies this resource.

accountSid
sid<AC> Not PII

The unique id of the Account responsible for this resource.

friendlyName

The human-readable name of this resource.

type
enum:push_service Not PII

Indicates which push notifications service this credential is for - either gcm, fcm, or apn

sandbox
string Not PII

[APN only] true when this resource should use the sandbox APN service. false when it should use the production APN service.

dateCreated
date_time<iso8601> Not PII

The date that this resource was created.

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated.

url
url Not PII

An absolute URL for this credential resource.

List All Credentials

GET /Credentials
        
        
        
        

        Create a Credential

        POST /Credentials
        

        Parameters

        Names in PHP format
        type
        Required
        post enum:push_service Not PII

        Credential type, one of "gcm", "fcm", or "apn"

        friendlyName
        Optional
        post string PII MTL: 120 DAYS

        Friendly name for stored credential

        certificate
        Optional
        post string Not PII

        [APN only] URL encoded representation of the certificate, e.g. -----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A== -----END CERTIFICATE-----

        privateKey
        Optional
        post string Not PII

        [APN only] URL encoded representation of the private key, e.g. -----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. -----END RSA PRIVATE KEY-----

        sandbox
        Optional
        post boolean Not PII

        [APN only] use this credential for sending to production or sandbox APNs (string true or false)

        apiKey
        Optional
        post string Not PII

        [GCM only] This is the "API key" for project from Google Developer console for your GCM Service application credential

        secret
        Optional
        post string Not PII

        [FCM only] This is the "Server key" of your project from Firebase console under Settings / Cloud messaging.

              
              
              
              

              Retrieve a Credential

              GET /Credentials/{Credential SID}
              
                    
                    
                    
                    

                    Update a Credential

                    POST /Credentials/{Credential SID}
                    

                    Parameters

                    Names in PHP format
                    friendlyName
                    Optional
                    post string PII MTL: 120 DAYS

                    Friendly name for stored credential

                    certificate
                    Optional
                    post string Not PII

                    [APN only] URL encoded representation of the certificate, e.g. -----BEGIN CERTIFICATE----- MIIFnTCCBIWgAwIBAgIIAjy9H849+E8wDQYJKoZIhvcNAQEFBQAwgZYxCzAJBgNV.....A== -----END CERTIFICATE-----

                    privateKey
                    Optional
                    post string Not PII

                    [APN only] URL encoded representation of the private key, e.g. -----BEGIN RSA PRIVATE KEY----- MIIEpQIBAAKCAQEAuyf/lNrH9ck8DmNyo3fGgvCI1l9s+cmBY3WIz+cUDqmxiieR. -----END RSA PRIVATE KEY-----

                    sandbox
                    Optional
                    post boolean Not PII

                    [APN only] use this credential for sending to production or sandbox APNs (string true or false)

                    apiKey
                    Optional
                    post string Not PII

                    [GCM only] This is the "API key" for project from Google Developer console for your GCM Service application credential

                    secret
                    Optional
                    post string Not PII

                    [FCM only] This is the "Server key" of your project from Firebase console under Settings / Cloud messaging.

                          
                          
                          
                          

                          Delete a Credential

                          DELETE /Credentials/{Credential SID}
                          
                                
                                
                                
                                

                                Need some help?

                                We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the Twilio tag on Stack Overflow.