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?

Bindings Resource

The Bindings resource of Programmable Chat represents push notification subscriptions for Users within the Service instance. Bindings are unique per service instance, user identity, device, and notification channel (APNS, GCM, FCM).

Bindings for Programmable Chat are created and updated by the chat client SDKs, with the ability to list, inspect and remove bindings being offered through the REST API.

Properties

Each binding has these properties:

Names in PHP format
sid
sid<BS> Not PII

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

accountSid
sid<AC> Not PII

The SID of the Account that created the Binding resource.

serviceSid
sid<IS> Not PII

The SID of the Service the resource is associated with.

dateCreated
date_time<iso8601> Not PII

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

dateUpdated
date_time<iso8601> Not PII

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

endpoint

The unique endpoint identifier for the Binding. The format of the 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.

credentialSid
sid<CR> Not PII

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

bindingType
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 information.

messageTypes
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 Users for the Binding.

List All Bindings for an Service

GET /Services/{Service SID}/Bindings
        
        
        
        

        Read a Binding

        GET /Services/{Service SID}/Bindings/{Binding SID}
        
              
              
              
              

              Delete a Binding

              DELETE /Services/{Service SID}/Bindings/{Binding SID}
              
                    
                    
                    
                    

                    List All Bindings for a User on an Service

                    GET /Services/{Service SID}/Users/{User SID|Identity}/Bindings
                    
                          
                          
                          
                          

                          Read a Binding for a User

                          GET /Services/{Service SID}/Users/{User SID|Identity}/Bindings/{Binding SID}
                          
                                
                                
                                
                                

                                Delete a Binding for a User

                                DELETE /Services/{Service SID}/Users/{User SID|Identity}/Bindings/{Binding SID}
                                
                                      
                                      
                                      
                                      
                                      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 browsing the Twilio tag on Stack Overflow.