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

A 34 character string that uniquely identifies this resource.

accountSid
sid<AC> Not PII

The unique id of the Account responsible for this binding.

serviceSid
sid<IS> Not PII

The unique id of the Service this binding belongs to.

dateCreated
date_time<iso8601> Not PII

The date that this resource was created.

dateUpdated
date_time<iso8601> Not PII

The date that this resource was last updated.

endpoint

The unique endpoint identifier for this Binding, the composition of which depends on the binding type.

identity

A unique string identifier for the User this Binding is for in this Service. See the access tokens docs for more details.

credentialSid
sid<CR> Not PII

The unique id of the Credential for this binding. See push notification configuration for more information.

bindingType
enum:binding_type Not PII

The push technology to use for this Binding. Supported values are apn, gcm and fcm. See push notification configuration for more information.

messageTypes
string[] Not PII

List of the Programmable Chat message types this binding is subcribed to.

url
url Not PII

An absolute URL for this binding.

links
uri_map Not PII

Absolute URLs to access the Users for this 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}
                                
                                      
                                      
                                      
                                      

                                      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.