Service-Scoped Notification Resource

The Twilio Conversations Service Notification resource manages a set of settings to determine push notification Service Binding behavior for a specific Conversation Service.

API Base URL

All URLs in the reference documentation use the following base URL:

1https://conversations.twilio.com/v1
2

For Conversations applications that build on more than one Conversation Service instance, you will need to specify the Conversation Service SID in the REST API call:

1GET /v1/Services/ISxx/Conversations/CHxx/Messages
2

Notification Properties

Property nameTypeRequiredDescriptionChild properties

accountSidSID<AC>

Optional

Not PII

The unique ID of the Account responsible for this configuration.

Pattern: ^AC[0-9a-fA-F]{32}$Min length: 34Max length: 34

chatServiceSidSID<IS>

Optional

Not PII

The SID of the Conversation Service the Configuration applies to.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

newMessageobject

Optional

Not PII

The Push Notification configuration for New Messages.

addedToConversationobject

Optional

Not PII

The Push Notification configuration for being added to a Conversation.

removedFromConversationobject

Optional

Not PII

The Push Notification configuration for being removed from a Conversation.

logEnabledboolean

Optional

Not PII

Weather the notification logging is enabled.

urlstring<uri>

Optional

Not PII

An absolute API resource URL for this configuration.

Fetch a ServiceNotification resource

GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications

Path parameters

Property nameTypeRequiredPIIDescription

chatServiceSidSID<IS>

required

Not PII

The SID of the Conversation Service the Configuration applies to.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

Fetch a Notification

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function fetchServiceNotification() {
11  const notification = await client.conversations.v1
12    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .configuration.notifications()
14    .fetch();
15
16  console.log(notification.accountSid);
17}
18
19fetchServiceNotification();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "log_enabled": false,
5  "added_to_conversation": {
6    "enabled": true,
7    "template": "You have been added to a Conversation: ${CONVERSATION}",
8    "sound": "ring"
9  },
10  "new_message": {
11    "enabled": true,
12    "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}",
13    "badge_count_enabled": false,
14    "sound": "ring",
15    "with_media": {
16      "enabled": false,
17      "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}"
18    }
19  },
20  "removed_from_conversation": {
21    "enabled": true,
22    "template": "You have been removed from a Conversation: ${CONVERSATION}",
23    "sound": "ring"
24  },
25  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications"
26}

Update a ServiceNotification resource

POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications

Path parameters

Property nameTypeRequiredPIIDescription

chatServiceSidSID<IS>

required

Not PII

The SID of the Conversation Service the Configuration applies to.

Pattern: ^IS[0-9a-fA-F]{32}$Min length: 34Max length: 34

Request body parameters

Encoding type:application/x-www-form-urlencoded

SchemaExample

Property nameTypeRequiredDescriptionChild properties

logEnabledboolean

Optional

Not PII

Weather the notification logging is enabled.

newMessageEnabledboolean

Optional

Not PII

Whether to send a notification when a new message is added to a conversation. The default is false.

newMessageTemplatestring

Optional

Not PII

The template to use to create the notification text displayed when a new message is added to a conversation and new_message.enabled is true.

newMessageSoundstring

Optional

Not PII

The name of the sound to play when a new message is added to a conversation and new_message.enabled is true.

newMessageBadgeCountEnabledboolean

Optional

Not PII

Whether the new message badge is enabled. The default is false.

addedToConversationEnabledboolean

Optional

Not PII

Whether to send a notification when a participant is added to a conversation. The default is false.

addedToConversationTemplatestring

Optional

Not PII

The template to use to create the notification text displayed when a participant is added to a conversation and added_to_conversation.enabled is true.

addedToConversationSoundstring

Optional

Not PII

The name of the sound to play when a participant is added to a conversation and added_to_conversation.enabled is true.

removedFromConversationEnabledboolean

Optional

Not PII

Whether to send a notification to a user when they are removed from a conversation. The default is false.

removedFromConversationTemplatestring

Optional

Not PII

The template to use to create the notification text displayed to a user when they are removed from a conversation and removed_from_conversation.enabled is true.

removedFromConversationSoundstring

Optional

Not PII

The name of the sound to play to a user when they are removed from a conversation and removed_from_conversation.enabled is true.

newMessageWithMediaEnabledboolean

Optional

Not PII

Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is false.

newMessageWithMediaTemplatestring

Optional

Not PII

The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and new_message.attachments.enabled is true.

Update a Notification

1// Download the helper library from https://www.twilio.com/docs/node/install
2const 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
6const accountSid = process.env.TWILIO_ACCOUNT_SID;
7const authToken = process.env.TWILIO_AUTH_TOKEN;
8const client = twilio(accountSid, authToken);
9
10async function updateServiceNotification() {
11  const notification = await client.conversations.v1
12    .services("ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa")
13    .configuration.notifications()
14    .update({ logEnabled: false });
15
16  console.log(notification.accountSid);
17}
18
19updateServiceNotification();

Response

1{
2  "account_sid": "ACaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
3  "chat_service_sid": "ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
4  "log_enabled": false,
5  "added_to_conversation": {
6    "enabled": false,
7    "template": "You have been added to a Conversation: ${CONVERSATION}",
8    "sound": "ring"
9  },
10  "new_message": {
11    "enabled": false,
12    "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}",
13    "badge_count_enabled": true,
14    "sound": "ring",
15    "with_media": {
16      "enabled": false,
17      "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}"
18    }
19  },
20  "removed_from_conversation": {
21    "enabled": false,
22    "template": "You have been removed from a Conversation: ${CONVERSATION}",
23    "sound": "ring"
24  },
25  "url": "https://conversations.twilio.com/v1/Services/ISaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa/Configuration/Notifications"
26}