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:
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:
GET /v1/Services/ISxx/Conversations/CHxx/Messages
ServiceNotification properties
| Resource Properties in REST API format | |
|---|---|
account_sid
|
The unique ID of the Account responsible for this configuration. |
chat_service_sid
|
The SID of the Conversation Service the Configuration applies to. |
new_message
|
The Push Notification configuration for New Messages. |
added_to_conversation
|
The Push Notification configuration for being added to a Conversation. |
removed_from_conversation
|
The Push Notification configuration for being removed from a Conversation. |
log_enabled
|
Weather the notification logging is enabled. |
url
|
An absolute API resource URL for this configuration. |
Fetch a ServiceNotification resource
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Configuration applies to. |
Example 1
Update a ServiceNotification resource
https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications
Parameters
| Parameters in REST API format | |
|---|---|
chat_service_sid
Path
|
The SID of the Conversation Service the Configuration applies to. |
log_enabled
Optional
|
Weather the notification logging is enabled. |
new_message.enabled
Optional
|
Whether to send a notification when a new message is added to a conversation. The default is |
new_message.template
Optional
|
The template to use to create the notification text displayed when a new message is added to a conversation and |
new_message.sound
Optional
|
The name of the sound to play when a new message is added to a conversation and |
new_message.badge_count_enabled
Optional
|
Whether the new message badge is enabled. The default is |
added_to_conversation.enabled
Optional
|
Whether to send a notification when a participant is added to a conversation. The default is |
added_to_conversation.template
Optional
|
The template to use to create the notification text displayed when a participant is added to a conversation and |
added_to_conversation.sound
Optional
|
The name of the sound to play when a participant is added to a conversation and |
removed_from_conversation.enabled
Optional
|
Whether to send a notification to a user when they are removed from a conversation. The default is |
removed_from_conversation.template
Optional
|
The template to use to create the notification text displayed to a user when they are removed from a conversation and |
removed_from_conversation.sound
Optional
|
The name of the sound to play to a user when they are removed from a conversation and |
new_message.with_media.enabled
Optional
|
Whether to send a notification when a new message with media/file attachments is added to a conversation. The default is |
new_message.with_media.template
Optional
|
The template to use to create the notification text displayed when a new message with media/file attachments is added to a conversation and |
Example 1
Need some help?
We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.
