Push Notification Configuration for Programmable Chat

The following Push Notifications can be configured for a Chat Service instance:

Note: The default enabled flag for new Service instances for all Push Notifications is false. This means that Push will be disabled until you explicitly enable it.

Note: You may configure a sound parameter value for each of the Push Notification types (detailed below).

Each of the Push Notification types has a default template for the payload (or notification body). Each of these templates can be overridden per Service instance via the Push Notification configuration. The templating employs markup for a limited set of variables:

Note: The maximum length of the entire notification payload is 110 characters. This substring is applied after the notification payload is constructed and the variables data applied. Thus, freeform text and the variable data are compiled into a string and the first 110 characters are then used as the notification payload.

Note: Variables can be used multiple times within a template, but each variable will contribute to the maximum number of available characters.

Each Push Notification type can be configured for a Service instance. The configuration allows each notification type to be enabled or disabled. This also handles custom template configuration as per the templating mechanism described above.

The following are the eligible notification type names:

• NewMessage
• AddedToChannel
• InvitedToChannel
• RemovedFromChannel

The following are the configuration parameters used:

This setting is only for the NewMessage notification type. Currently, only APNS push notifications for iOS will use this and include the badge property in the payload. If enabled, the value of this property will represent the count of 1:1 Channels the User is a Member of which have any unread Messages for the User.

If Notifications.NewMessage.BadgeCountEnabled is set to true, decrements to the count of 1:1 Channels with unread messages will be sent to all registered iOS endpoints for that User.

1
// Download the helper library from https://www.twilio.com/docs/node/install
2
const twilio = require("twilio"); // Or, for ESM: import twilio from "twilio";
3

4
// Find your Account SID and Auth Token at twilio.com/console
5
// and set the environment variables. See http://twil.io/secure
6
const accountSid = process.env.TWILIO_ACCOUNT_SID;
7
const authToken = process.env.TWILIO_AUTH_TOKEN;
8
const client = twilio(accountSid, authToken);
9

10
async function updateService() {
11
  const service = await client.chat.v2
12
    .services("ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX")
13
    .update({
14
      "notifications.addedToChannel.enabled": true,
15
      "notifications.addedToChannel.sound": "default",
16
      "notifications.addedToChannel.template":
17
        "A New message in ${CHANNEL} from ${USER}: ${MESSAGE}",
18
    });
19

20
  console.log(service.sid);
21
}
22

23
updateService();

1
{
2
  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3
  "consumption_report_interval": 100,
4
  "date_created": "2015-07-30T20:00:00Z",
5
  "date_updated": "2015-07-30T20:00:00Z",
6
  "default_channel_creator_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
7
  "default_channel_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
8
  "default_service_role_sid": "RLaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
9
  "friendly_name": "friendly_name",
10
  "limits": {
11
    "channel_members": 500,
12
    "user_channels": 600
13
  },
14
  "links": {
15
    "channels": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Channels",
16
    "users": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Users",
17
    "roles": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Roles",
18
    "bindings": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Bindings"
19
  },
20
  "notifications": {
21
    "log_enabled": true,
22
    "added_to_channel": {
23
      "enabled": false,
24
      "template": "notifications.added_to_channel.template"
25
    },
26
    "invited_to_channel": {
27
      "enabled": false,
28
      "template": "notifications.invited_to_channel.template"
29
    },
30
    "new_message": {
31
      "enabled": false,
32
      "template": "notifications.new_message.template",
33
      "badge_count_enabled": true
34
    },
35
    "removed_from_channel": {
36
      "enabled": false,
37
      "template": "notifications.removed_from_channel.template"
38
    }
39
  },
40
  "post_webhook_url": "post_webhook_url",
41
  "pre_webhook_url": "pre_webhook_url",
42
  "pre_webhook_retry_count": 2,
43
  "post_webhook_retry_count": 3,
44
  "reachability_enabled": false,
45
  "read_status_enabled": false,
46
  "sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
47
  "typing_indicator_timeout": 100,
48
  "url": "https://chat.twilio.com/v2/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
49
  "webhook_filters": [
50
    "webhook_filters"
51
  ],
52
  "webhook_method": "webhook_method",
53
  "media": {
54
    "size_limit_mb": 150,
55
    "compatibility_message": "new media compatibility message"
56
  }
57
}

Setting additional notification types requires including them in your configuration request. For instance, to include the AddedToChannel Push Notification type, you can add

1
'Notifications.AddedToChannel.Enabled=true' 
2
'Notifications.AddedToChannel.Template=You are now a Member of ${CHANNEL}!  Added by ${USER}' 
3
'Notifications.AddedToChannel.Sound=default'

to your curl request.

Next: Notifications on iOS