User Reachability Indicator

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.

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 unregisters from push notifications

1
/* Checking/listening to reachability */
2

3
// check if reachability function is enabled
4
if (!client.reachabilityEnabled) {
5
    // reachability function is disabled for the client
6
    return;
7
}
8

9
// listen to user reachability status updates
10
client.on("userUpdated", ({ user, updateReasons}) => {
11
    if (updateReasons.includes("reachabilityOnline")) {
12
        // user reachability status was updated
13
    }
14

15
    if (updateReasons.includes("reachabilityNotifiable")) {
16
        // user notifications status was updated
17
    }
18
})
19

20
const participants = await conversation.getParticipants();
21

22
participants.forEach(async (participant) => {
23
    const user = await participant.getUser();
24

25
    if (user.isOnline) {
26
        // conversation participant is online
27
    }
28

29
    if (user.isNotifiable) {
30
        // user has push notifications active
31
    }
32
});

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

• Explore the Read Horizon and Read Status Overview, or
• Check the Delivery Receipts Overview guide.