Removal of Contact Book Feature

Announcements
3

In preparation for the deprecation of Contact Book, please refer to the guide below to ensure you continue receiving notifications once this feature is removed.

Note: This guide assumes that users who have enabled Contact Book are power users who are comfortable navigating the IDE, mobile app, and custom code. There are numerous ways to leverage Contacts, especially with custom SmartApps, but this guide only provides a high-level overview of the steps needed to switch from using Contact Book to regular SMS/push notifications. If you require additional assistance, please contact our Support team directly at support.smartthings.com.

Removing Contacts from Contact Book
Before configuring your automations to use the supported SMS/Push notifications, you will first need to remove any Contacts you have created.

  1. Log in to graph.api.smartthings.com

  2. Click My Locations

  3. If you have multiple locations, click on the name of a location

  4. Click on the link to the right of Account

  5. In the address bar of your browser, replace “/account/show/” with “/contact/”

    For example

    Change https://graph.api.smartthings.com/account/show/123e4567-e89b-12d3-a456-426655440000
    to https://graph.api.smartthings.com/contact/123e4567-e89b-12d3-a456-426655440000

  6. For each contact listed, click on the name. Note the automations listed under “Referencing SmartApps” as these are the automations you will want to reconfigure to utilize SMS/Push after the Contact is deleted. You may want to copy/paste this list into a text editor as a reminder of which notifications you previously configured

  7. Once you have noted the currently configured notifications, you can click the Delete button to the right of Edit

  8. When the confirmation box pops up, click OK

  9. Repeat this process for each of your Contacts until the list is empty

Updating Automations to use SMS/Push Notifications
Once you have removed all Contacts from the Contact Book, you will need to configure your SmartApps to use SMS or Push notifications.

Update Smart Home Monitor

  1. Open the SmartThings Classic mobile app
  2. Tap Dashboard Dashboard
  3. Under Smart Home Monitor, tap Everything OK
  4. Tap the gear icon gear_icon
  5. For each configured component (Intrusion, Smoke, Leaks, Custom), tap the name
  6. Tap Next until you see Alarm & Notifications
  7. Tap Text & Push Notifications
  8. If you would like to receive push notifications, ensure the toggle is to the right
  9. If you would like to receive SMS notifications, enter a phone number
  10. Tap Save

Update Routines

  1. Open the SmartThings Classic mobile app
  2. Tap Automation Automation
  3. For each Routine configured with a notification, tap the gear icon gear_icon
  4. Under “Additional settings”, tap Automatically perform “Routine” when…
  5. Under “Advanced Options”, ensure the toggle is to the right if you would like to receive push notifications
  6. If you would like SMS notifications, enter a phone number
  7. Tap Save

Update SmartApps

  1. Open the SmartThings Classic mobile app
  2. Tap Automation
  3. Tap SmartApps
  4. For each SmartApp you wish to receive notifications from, tap the name of the SmartApp and enable push and/or SMS notifications

Updating custom code to remove references to Contacts

Use of Contact Book in custom SmartApps is defined by the sendNotificationToContacts() method. Push notifications are defined with sendPushMessage() or sendPush(). SMS notifications are defined with sendSmsMessage() or sendSms(). If the code guidelines were followed, your custom code should have a fallback to use SMS and/or push notifications such as

//check that Contact Book is enabled and recipients selected
if (location.contactBookEnabled && recipients) {
sendNotificationToContacts(“your message here”, recipients)
} else if (phone) { // check that the user did select a phone number
sendSms(phone, “your message here”)
}

If your custom SmartApp only uses Contact Book, you will want to replace the sendNotificationToContacts() method with one of the SMS or push notification methods referenced above.

8 Likes