On this page

Notify API Binding Resource

The Binding resource binds an identity to the address used by a notification channel. For example, iOS push notifications use an APNS device token for their address and SMS uses a phone number. Creating a Binding allows you to send notifications by referring to an identity rather than a specific device. You can create up to 20 Bindings with the same identity in a given Service.

You can add tags to a Binding that describe related Bindings. For example, you can add a tag to the Bindings of a user's preferred devices and then refer to that tag to notify them on only their preferred devices. Read more about Sending Notifications.

(error)

Do not use Personally Identifiable Information (PII) for identity

The systems that process this parameter assume it does not contain PII.

You should use a GUID or other pseudonymized identifier for identity instead of PII such as a person's name, home address, email or phone number. If you identify your users with PII, we recommend creating a pseudonymized identifier from their PII, for example by hashing or encrypting it, before you use it for identity.

You can read more about how we process your data in our privacy policy.

(warning)

Make sure you have consent from users before storing their device's address

It's a good practice to obtain your end users' consent before you send them messages and some jurisdictions might require it by law.

We recommend that you consult with your legal counsel to make sure that your communications comply with all applicable laws.

To make sure your messages reach the right people, you should make sure that they have given you their consent to send them messages and that their contact information is current.

Check out the Twilio Marketplace for Add-ons from our partners that can help you keep your database up to date.

Address for push notifications

While the address of an SMS message is the phone number, the address to use for push notifications is obtained by your client-side mobile app. Learn how to:

Register for Notifications on iOS to obtain the APNS address, called a device token.
Register for Notifications on Android to obtain the FCM address, called a registration token.

Binding Properties

Property nameTypeRequiredDescriptionChild properties

sidSID<BS>Optional

The unique string that we created to identify the Binding resource.

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

account_sidSID<AC>Optional

The SID of the Account that created the Binding resource.

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

service_sidSID<IS>Optional

The SID of the Service the resource is associated with.

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

credential_sidSID<CR>Optional

The SID of the Credential resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applicable only to apn, fcm, and gcm type Bindings.

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

date_createdstring<date-time>Optional

The date and time in GMT when the resource was created specified in RFC 2822 format.

date_updatedstring<date-time>Optional

The date and time in GMT when the resource was last updated specified in RFC 2822 format.

notification_protocol_versionstringOptional

The protocol version to use to send the notification. This defaults to the value of default_xxxx_notification_protocol_version in the Service for the protocol. The current version is "3" for apn, fcm, and gcm type Bindings. The parameter is not applicable to sms and facebook-messenger type Bindings as the data format is fixed.

endpointstringOptional

Deprecated.

identitystringOptional

PII MTL: 120 days

The identity value that uniquely identifies the resource's User within the Service. Up to 20 Bindings can be created for the same Identity in a given Service.

binding_typestringOptional

The transport technology to use for the Binding. Can be: apn, fcm, gcm, sms, or facebook-messenger.

addressstringOptional

PII MTL: 120 days

The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.

tagsarray[string]Optional

PII MTL: 120 days

The list of tags associated with this Binding. Tags can be used to select the Bindings to use when sending a notification. Maximum 20 tags are allowed.

urlstring<uri>Optional

The absolute URL of the Binding resource.

linksobject<uri-map>Optional

The URLs of related resources.

Endpoint (DEPRECATED)

We deprecated endpoint and trust the push-channel provider (such as APNS or Firebase) to let us know when an app has changed or invalidated the device token used as the address.

The endpoint property was used to uniquely identify push notification Bindings when the app installation's address changed, such as when the device token changed in an iOS app. You can still include an Endpoint parameter when you create a Binding; however, it will be ignored.

Create a Binding resource

POST https://notify.twilio.com/v1/Services/{ServiceSid}/Bindings

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to create the resource under.

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

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

Identitystringrequired

PII MTL: 120 days

The identity value that uniquely identifies the new resource's User within the Service. Up to 20 Bindings can be created for the same Identity in a given Service.

BindingTypeenum<string>required

The transport technology to use for the Binding. Can be: apn, fcm, gcm, sms, or facebook-messenger.

Possible values:

apngcmsmsfcmfacebook-messengeralexa

Addressstringrequired

PII MTL: 120 days

The channel-specific address. For APNS, the device token. For FCM and GCM, the registration token. For SMS, a phone number in E.164 format. For Facebook Messenger, the Messenger ID of the user or a phone number in E.164 format.

Tagarray[string]Optional

A tag that can be used to select the Bindings to notify. Repeat this parameter to specify more than one tag, up to a total of 20 tags.

NotificationProtocolVersionstringOptional

The protocol version to use to send the notification. This defaults to the value of default_xxxx_notification_protocol_version for the protocol in the Service. The current version is "3" for apn, fcm, and gcm type Bindings. The parameter is not applicable to sms and facebook-messenger type Bindings as the data format is fixed.

CredentialSidSID<CR>Optional

The SID of the Credential resource to be used to send notifications to this Binding. If present, this overrides the Credential specified in the Service resource. Applies to only apn, fcm, and gcm type Bindings.

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

EndpointstringOptional

Deprecated.

Create a Binding resource

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 createBinding() {
11  const binding = await client.notify.v1
12    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .bindings.create({
14      address: "Address",
15      bindingType: "apn",
16      identity: "Identity",
17    });
18
19  console.log(binding.sid);
20}
21
22createBinding();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "address": "Address",
4  "binding_type": "apn",
5  "credential_sid": null,
6  "date_created": "2015-07-30T20:00:00Z",
7  "date_updated": "2015-07-30T20:00:00Z",
8  "endpoint": "26607274",
9  "identity": "Identity",
10  "notification_protocol_version": "3",
11  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12  "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "tags": [
14    "26607274"
15  ],
16  "links": {
17    "user": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039"
18  },
19  "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
20}

Existing Bindings with the same Address are replaced

If the Service already has a Binding with the same Address as specified in the create request, the Binding being created replaces the existing Binding.

The new Binding replaces the existing one under these conditions to prevent leaking notifications between users when, for example, a new user logs into your app on a device that has already been registered to another user.

To register the same address twice, such as when someone is a buyer and a seller at the same time in a marketplace, we recommend creating separate Service instances, such as one for buyers and one for sellers.

Endpoint (DEPRECATED)

We deprecated endpoint and trust the push-channel provider (such as APNS or Firebase) to let us know when an app has changed or invalidated the device token used as the address.

The endpoint property was used to uniquely identify push notification Bindings when the app installation's address changed, such as when the device token changed in an iOS app. You can still include an Endpoint parameter when you create a Binding; however, it will be ignored.

Fetch a Binding resource

GET https://notify.twilio.com/v1/Services/{ServiceSid}/Bindings/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to fetch the resource from.

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

SidSID<BS>required

The Twilio-provided string that uniquely identifies the Binding resource to fetch.

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

Fetch a Binding resource

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 fetchBinding() {
11  const binding = await client.notify.v1
12    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .bindings("BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .fetch();
15
16  console.log(binding.sid);
17}
18
19fetchBinding();

Output

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "address": "a7c658f4111ec4ff5a1a647f9d0edd819025b9f20522d2fae897049f32873e73",
4  "binding_type": "apn",
5  "credential_sid": null,
6  "date_created": "2015-07-30T20:00:00Z",
7  "date_updated": "2015-07-30T20:00:00Z",
8  "endpoint": "26607274",
9  "identity": "24987039",
10  "notification_protocol_version": "3",
11  "service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
12  "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
13  "tags": [
14    "26607274"
15  ],
16  "links": {
17    "user": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users/24987039"
18  },
19  "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
20}

Read multiple Binding resources

GET https://notify.twilio.com/v1/Services/{ServiceSid}/Bindings

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to read the resource from.

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

Query parameters

Property nameTypeRequiredPIIDescription

StartDatestring<date>Optional

Only include usage that has occurred on or after this date. Specify the date in GMT and format as YYYY-MM-DD.

EndDatestring<date>Optional

Only include usage that occurred on or before this date. Specify the date in GMT and format as YYYY-MM-DD.

Identityarray[string]Optional

PII MTL: 120 days

The User's identity value of the resources to read.

Tagarray[string]Optional

Only list Bindings that have all of the specified Tags. The following implicit tags are available: all, apn, fcm, gcm, sms, facebook-messenger. Up to 5 tags are allowed.

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.

Read multiple Binding resources

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 listBinding() {
11  const bindings = await client.notify.v1
12    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .bindings.list({ limit: 20 });
14
15  bindings.forEach((b) => console.log(b.sid));
16}
17
18listBinding();

Output

1{
2  "bindings": [],
3  "meta": {
4    "first_page_url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0",
5    "key": "bindings",
6    "next_page_url": null,
7    "page": 0,
8    "page_size": 50,
9    "previous_page_url": null,
10    "url": "https://notify.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?Tag=tag&Identity=identity&PageSize=50&Page=0"
11  }
12}

Note that no more than 50 Bindings are returned at a time.

Delete a Binding resource

DELETE https://notify.twilio.com/v1/Services/{ServiceSid}/Bindings/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ServiceSidSID<IS>required

The SID of the Service to delete the resource from.

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

SidSID<BS>required

The Twilio-provided string that uniquely identifies the Binding resource to delete.

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

Delete a Binding resource

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 deleteBinding() {
11  await client.notify.v1
12    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .bindings("BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
14    .remove();
15}
16
17deleteBinding();