ConversationsV1Credential

Add a new push notification credential to your account

Changed on

Add a new push notification credential to your account

post/v1/Credentials

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v1/Credentials
  • Auth
    HTTP basic

Request body application/x-www-form-urlencoded

Type'apn' | 'gcm' | 'fcm' required

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

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.

Response

Created

sidstring nullable

A 34 character string that uniquely identifies this resource.

account_sidstring nullable

The unique ID of the Account responsible for this credential.

friendly_namestring nullable

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

type'apn' | 'gcm' | 'fcm'

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

sandboxstring nullable

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

The date that this resource was created.

date_updatedstring date-time nullable

The date that this resource was last updated.

urlstring uri nullable

An absolute API resource URL for this credential.

Changes