Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

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

api-base-url page anchor

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


_10
https://conversations.twilio.com/v1

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:


_10
GET /v1/Services/ISxx/Conversations/CHxx/Messages


ServiceNotification Properties

servicenotification-properties page anchor
account_sidSID<AC>
Not PII

The unique ID of the Account(link takes you to an external page) responsible for this configuration.

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

chat_service_sidSID<IS>

The SID of the Conversation Service(link takes you to an external page) the Configuration applies to.

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

new_messageobject

The Push Notification configuration for New Messages.


added_to_conversationobject

The Push Notification configuration for being added to a Conversation.


removed_from_conversationobject

The Push Notification configuration for being removed from a Conversation.


log_enabledboolean

Weather the notification logging is enabled.


urlstring<uri>

An absolute API resource URL for this configuration.


Fetch a ServiceNotification resource

fetch-a-servicenotification-resource page anchor
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications

Path parameters

path-parameters page anchor
ChatServiceSidSID<IS>required

The SID of the Conversation Service(link takes you to an external page) the Configuration applies to.

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

Fetch a ServiceNotification

fetch-a-servicenotification page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.configuration
_12
.notifications()
_12
.fetch()
_12
.then(notification => console.log(notification.chatServiceSid));

Output

_26
{
_26
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26
"chat_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26
"log_enabled": false,
_26
"added_to_conversation": {
_26
"enabled": true,
_26
"template": "You have been added to a Conversation: ${CONVERSATION}",
_26
"sound": "ring"
_26
},
_26
"new_message": {
_26
"enabled": true,
_26
"template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}",
_26
"badge_count_enabled": false,
_26
"sound": "ring",
_26
"with_media": {
_26
"enabled": false,
_26
"template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}"
_26
}
_26
},
_26
"removed_from_conversation": {
_26
"enabled": true,
_26
"template": "You have been removed from a Conversation: ${CONVERSATION}",
_26
"sound": "ring"
_26
},
_26
"url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configuration/Notifications"
_26
}


Update a ServiceNotification resource

update-a-servicenotification-resource page anchor
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications

ChatServiceSidSID<IS>required

The SID of the Conversation Service(link takes you to an external page) the Configuration applies to.

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

Weather the notification logging is enabled.


NewMessage.Enabledboolean

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


NewMessage.Templatestring

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.


NewMessage.Soundstring

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


NewMessage.BadgeCountEnabledboolean

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


AddedToConversation.Enabledboolean

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


AddedToConversation.Templatestring

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.


AddedToConversation.Soundstring

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


RemovedFromConversation.Enabledboolean

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


RemovedFromConversation.Templatestring

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.


RemovedFromConversation.Soundstring

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


NewMessage.WithMedia.Enabledboolean

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


NewMessage.WithMedia.Templatestring

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 ServiceNotification

update-a-servicenotification page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
twilio-cli
curl

_12
// Download the helper library from https://www.twilio.com/docs/node/install
_12
// Find your Account SID and Auth Token at twilio.com/console
_12
// and set the environment variables. See http://twil.io/secure
_12
const accountSid = process.env.TWILIO_ACCOUNT_SID;
_12
const authToken = process.env.TWILIO_AUTH_TOKEN;
_12
const client = require('twilio')(accountSid, authToken);
_12
_12
client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12
.configuration
_12
.notifications()
_12
.update({logEnabled: true})
_12
.then(notification => console.log(notification.chatServiceSid));

Output

_26
{
_26
"account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26
"chat_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26
"log_enabled": true,
_26
"added_to_conversation": {
_26
"enabled": false,
_26
"template": "You have been added to a Conversation: ${CONVERSATION}",
_26
"sound": "ring"
_26
},
_26
"new_message": {
_26
"enabled": false,
_26
"template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}",
_26
"badge_count_enabled": true,
_26
"sound": "ring",
_26
"with_media": {
_26
"enabled": false,
_26
"template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}"
_26
}
_26
},
_26
"removed_from_conversation": {
_26
"enabled": false,
_26
"template": "You have been removed from a Conversation: ${CONVERSATION}",
_26
"sound": "ring"
_26
},
_26
"url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configuration/Notifications"
_26
}


Rate this page: