Rate this page:

User Reachability Indicator

The Conversations SDKs include optional built-in presence functionality. You can use the Reachability Indicator feature to:

  • Check a Chat (SDK) User’s status (i.e. online or offline)
  • Check if a User is notifiable via Push Notification
  • Receive SDK events when these statuses change

These properties will be available when you enable the Reachability Indicator feature.

Enable the Reachability Indicator

By default, the Reachability Indicator state is disabled.

To turn on the Reachability Indicator, you’ll need to use the REST API.

Once you enable the feature, Twilio will automatically update and synchronize the state. The Reachability Indicator properties are exposed on the User resource in the REST API and on User objects in the SDKs. They are "read only", which means you can't modify these properties.

Check the state of the Reachability Indicator

You can check User objects to determine their current reachability status and push notification availability.

Updates to other User’s Reachability Indicator states are also communicated via the update event on User objects and the userUpdated event on the Client object.

Any of the following events can change the Reachability Indicator state:

  • When a User goes online
  • When a User goes offline
  • When a User registers for push notifications
  • When a User deregisters from push notifications

Online/Offline status may take up to a couple of minutes to become consistent with a user’s actual state.

Loading Code Sample...

        Listening for Reachability status

        What’s Next?

        Well done! You have learned about the User Reachability Indicator feature! As a following step, you can:

        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!