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:
_10https://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:
_10GET /v1/Services/ISxx/Conversations/CHxx/Messages
account_sid
type: SID<AC>The unique ID of the Account responsible for this configuration.
^AC[0-9a-fA-F]{32}$
34
34
chat_service_sid
type: SID<IS>The SID of the Conversation Service the Configuration applies to.
^IS[0-9a-fA-F]{32}$
34
34
added_to_conversation
type: objectThe Push Notification configuration for being added to a Conversation.
removed_from_conversation
type: objectThe Push Notification configuration for being removed from a Conversation.
GET https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications
ChatServiceSid
type: SID<IS>The SID of the Conversation Service the Configuration applies to.
^IS[0-9a-fA-F]{32}$
34
34
POST https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications
ChatServiceSid
type: SID<IS>The SID of the Conversation Service the Configuration applies to.
^IS[0-9a-fA-F]{32}$
34
34
NewMessage.Enabled
type: booleanWhether to send a notification when a new message is added to a conversation. The default is false
.
NewMessage.Template
type: stringThe 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: stringThe name of the sound to play when a new message is added to a conversation and new_message.enabled
is true
.
NewMessage.BadgeCountEnabled
type: booleanWhether the new message badge is enabled. The default is false
.
AddedToConversation.Enabled
type: booleanWhether to send a notification when a participant is added to a conversation. The default is false
.
AddedToConversation.Template
type: stringThe 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: stringThe name of the sound to play when a participant is added to a conversation and added_to_conversation.enabled
is true
.
RemovedFromConversation.Enabled
type: booleanWhether to send a notification to a user when they are removed from a conversation. The default is false
.
RemovedFromConversation.Template
type: stringThe 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: stringThe 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: booleanWhether 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: stringThe 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
.