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 .
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
Resource properties chat_service_sid
type: SID<IS> Not PIIThe Push Notification configuration for New Messages.
added_to_conversation
type: object Not PIIThe Push Notification configuration for being added to a Conversation.
removed_from_conversation
type: object Not PIIThe Push Notification configuration for being removed from a Conversation.
Weather the notification logging is enabled.
An absolute API resource URL for this configuration.
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications
_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 client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .then(notification => console.log(notification.chatServiceSid));
_26 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26 "chat_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26 "log_enabled": false,
_26 "added_to_conversation": {
_26 "template": "You have been added to a Conversation: ${CONVERSATION}",
_26 "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}",
_26 "badge_count_enabled": false,
_26 "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}"
_26 "removed_from_conversation": {
_26 "template": "You have been removed from a Conversation: ${CONVERSATION}",
_26 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configuration/Notifications"
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications
URI parameters Request body parameters Weather the notification logging is enabled.
NewMessage.Enabled
type: boolean Not PIIWhether to send a notification when a new message is added to a conversation. The default is false
.
NewMessage.Template
type: string Not PIIThe 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.Sound
type: string Not PIIThe name of the sound to play when a new message is added to a conversation and new_message.enabled
is true
.
NewMessage.BadgeCountEnabled
type: boolean Not PIIWhether the new message badge is enabled. The default is false
.
AddedToConversation.Enabled
type: boolean Not PIIWhether to send a notification when a participant is added to a conversation. The default is false
.
AddedToConversation.Template
type: string Not PIIThe 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.Sound
type: string Not PIIThe name of the sound to play when a participant is added to a conversation and added_to_conversation.enabled
is true
.
RemovedFromConversation.Enabled
type: boolean Not PIIWhether to send a notification to a user when they are removed from a conversation. The default is false
.
RemovedFromConversation.Template
type: string Not PIIThe 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.Sound
type: string Not PIIThe 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.Enabled
type: boolean Not PIIWhether to send a notification when a new message with media/file attachments is added to a conversation. The default is false
.
NewMessage.WithMedia.Template
type: string Not PIIThe 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
.
_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 client.conversations.v1.services('ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX')
_12 .update({logEnabled: true})
_12 .then(notification => console.log(notification.chatServiceSid));
_26 "account_sid": "ACXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26 "chat_service_sid": "ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
_26 "added_to_conversation": {
_26 "template": "You have been added to a Conversation: ${CONVERSATION}",
_26 "template": "You have a new message in ${CONVERSATION} from ${PARTICIPANT}: ${MESSAGE}",
_26 "badge_count_enabled": true,
_26 "template": "You have a new message in ${CONVERSATION} with ${MEDIA_COUNT} media files: ${MEDIA}"
_26 "removed_from_conversation": {
_26 "template": "You have been removed from a Conversation: ${CONVERSATION}",
_26 "url": "https://conversations.twilio.com/v1/Services/ISXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/Configuration/Notifications"