Menu

Expand
Rate this page:

Programmable Chat Binding Resource

Programmable Chat has been deprecated and is no longer supported. Instead, we'll be focusing on the next generation of chat: Twilio Conversations. Find out more about the EOL process here.

If you're starting a new project, please visit the Conversations Docs to begin. If you've already built on Programmable Chat, please visit our Migration Guide to learn about how to switch.

A Binding resource of Programmable Chat 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).

We recommend following the standard URI specification and avoid the following reserved characters ! * ' ( ) ; : @ & = + $ , / ? % # [ ] for values such as identity and friendly name.

Binding properties

Each Binding resource contains these properties.

Resource Properties in REST API format
sid
sid<BS> Not PII

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

account_sid
sid<AC> Not PII

The SID of the Account that created the Binding resource.

service_sid
sid<IS> Not PII

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

date_created
date_time<iso8601> Not PII

The date and time in GMT when the resource was created specified in ISO 8601 format.

date_updated
date_time<iso8601> Not PII

The date and time in GMT when the resource was last updated specified in ISO 8601 format.

endpoint

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

identity

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

credential_sid
sid<CR> Not PII

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

binding_type
enum:binding_type Not PII

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

message_types
string[] Not PII

The Programmable Chat message types the binding is subscribed to.

url
url Not PII

The absolute URL of the Binding resource.

links
uri_map Not PII

The absolute URLs of the Binding's User.

Fetch a Binding resource

get
https://chat.twilio.com/v2/Services/{ServiceSid}/Bindings/{Sid}
Parameters
Parameters in REST API format
service_sid
Path
get sid<IS> Not PII

The SID of the Service to fetch the Binding resource from.

sid
Path
get sid<BS> Not PII

The SID of the Binding resource to fetch.

Example 1
Loading Code Sample...
        
        

        Fetch a Binding resource

        Read multiple Binding resources

        get
        https://chat.twilio.com/v2/Services/{ServiceSid}/Bindings
        Parameters
        Parameters in REST API format
        service_sid
        Path
        get sid<IS> Not PII

        The SID of the Service to read the Binding resources from.

        binding_type
        Optional
        get enum:binding_type[] 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.

        identity
        Optional
        get string[] PII MTL: 30 DAYS

        The User's identity value of the resources to read. See access tokens for more details.

        Example 1
        Loading Code Sample...
              
              

              Read multiple Binding resources

              Delete a Binding resource

              delete
              https://chat.twilio.com/v2/Services/{ServiceSid}/Bindings/{Sid}
              Parameters
              Parameters in REST API format
              service_sid
              Path
              delete sid<IS> Not PII

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

              sid
              Path
              delete sid<BS> Not PII

              The SID of the Binding resource to delete.

              Example 1
              Loading Code Sample...
                    
                    

                    Delete a Binding resource

                    Rate this page:

                    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 by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.

                    Loading Code Sample...
                          
                          
                          

                          Thank you for your feedback!

                          Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

                          Sending your feedback...
                          🎉 Thank you for your feedback!
                          Something went wrong. Please try again.

                          Thanks for your feedback!

                          thanks-feedback-gif