Skip to content Skip to navigation Skip to topbar

On this page

Service Binding Resource

A Binding resource in Twilio Conversations represents a Push notification subscription for a User within their Service instance. Bindings are unique per Service instance, User identity, device, and notification channel (such as APNS, GCM, FCM).

Binding Properties

Each Binding resource has the following properties:

Property nameTypeRequiredDescriptionChild properties

sidSID<BS>

Optional

Not PII

A 34 character string that uniquely identifies this resource.

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

account_sidSID<AC>

Optional

Not PII

The unique ID of the Account responsible for this binding.

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

chat_service_sidSID<IS>

Optional

Not PII

The SID of the Conversation Service the Binding resource is associated with.

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

credential_sidSID<CR>

Optional

Not PII

The SID of the Credential for the binding. See push notification configuration for more info.

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

date_createdstring<date-time>

Optional

Not PII

The date that this resource was created.

date_updatedstring<date-time>

Optional

Not PII

The date that this resource was last updated.

endpointstring

Optional

PII MTL: 30 days

The unique endpoint identifier for the Binding. The format of this value depends on the binding_type.

identitystring

Optional

PII MTL: 30 days

The application-defined string that uniquely identifies the Conversation User within the Conversation Service. See access tokens for more info.

binding_typeenum<string>

Optional

Not PII

The push technology to use for the Binding. Can be: apn, gcm, or fcm. See push notification configuration for more info.

Possible values:

apngcmfcm

message_typesarray[string]

Optional

Not PII

The Conversation message types the binding is subscribed to.

urlstring<uri>

Optional

Not PII

An absolute API resource URL for this binding.

Fetch a ServiceBinding resource

GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Bindings/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ChatServiceSidSID<IS>required

Not PII

The SID of the Conversation Service the Binding resource is associated with.

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

SidSID<BS>required

Not PII

A 34 character string that uniquely identifies this resource.

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

Fetch a Binding

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

Output

1{
2  "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
5  "date_created": "2016-10-21T11:37:03Z",
6  "date_updated": "2016-10-21T11:37:03Z",
7  "endpoint": "TestUser-endpoint",
8  "identity": "TestUser",
9  "binding_type": "gcm",
10  "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
11  "message_types": [
12    "removed_from_conversation",
13    "new_message",
14    "added_to_conversation"
15  ],
16  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
17}

Read multiple ServiceBinding resources

GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Bindings

Path parameters

Property nameTypeRequiredPIIDescription

ChatServiceSidSID<IS>required

Not PII

The SID of the Conversation Service the Binding resource is associated with.

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

Query parameters

Property nameTypeRequiredPIIDescription

BindingTypearray[enum<string>]

Optional

Not PII

The push technology used by the Binding resources to read. Can be: apn, gcm, or fcm. See push notification configuration for more info.

Possible values:

apngcmfcm

Identityarray[string]

Optional

PII MTL: 30 days

The identity of a Conversation User this binding belongs to. See access tokens for more details.

PageSizeinteger

Optional

Not PII

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

Minimum: 1Maximum: 1000

Pageinteger

Optional

Not PII

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

Minimum: 0

PageTokenstring

Optional

Not PII

The page token. This is provided by the API.

List multiple Bindings

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

Output

1{
2  "meta": {
3    "page": 0,
4    "page_size": 50,
5    "first_page_url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0",
6    "previous_page_url": null,
7    "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings?PageSize=50&Page=0",
8    "next_page_url": null,
9    "key": "bindings"
10  },
11  "bindings": [
12    {
13      "sid": "BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
14      "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
15      "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
16      "date_created": "2016-10-21T11:37:03Z",
17      "date_updated": "2016-10-21T11:37:03Z",
18      "endpoint": "TestUser-endpoint",
19      "identity": "TestUser",
20      "binding_type": "gcm",
21      "credential_sid": "CRaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
22      "message_types": [
23        "removed_from_conversation",
24        "new_message",
25        "added_to_conversation"
26      ],
27      "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings/BSaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa"
28    }
29  ]
30}

Delete a ServiceBinding resource

DELETE https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Bindings/{Sid}

Path parameters

Property nameTypeRequiredPIIDescription

ChatServiceSidSID<IS>required

Not PII

The SID of the Conversation Service to delete the Binding resource from.

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

SidSID<BS>required

Not PII

The SID of the Binding resource to delete.

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

Delete a Binding

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