TWtwilio
ConversationsV1Notification

Update push notification service settings

Changed on

Update push notification service settings

post/v1/Services/{ChatServiceSid}/Configuration/Notifications

Request

  • Base URL
    https://conversations.twilio.com
  • URL
    https://conversations.twilio.com/v1/Services/{ChatServiceSid}/Configuration/Notifications
  • Auth
    HTTP basic

Path parameters

ChatServiceSidstring required

The SID of the Conversation Service the Configuration applies to.

Request body application/x-www-form-urlencoded

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.

Response

OK

account_sidstring nullable

The unique ID of the Account responsible for this configuration.

chat_service_sidstring nullable

The SID of the Conversation Service the Configuration applies to.

new_messageunknown
added_to_conversationunknown
removed_from_conversationunknown
log_enabledboolean nullable

Weather the notification logging is enabled.

urlstring uri nullable

An absolute API resource URL for this configuration.

Changes

  • v192d1169c37c2Revision changes
    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

    • breaking

      the response's property type changed from object to no type for status

  • v1b4d0e634cd69Revision changes
    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status

    • breaking

      the response's property type changed from no type to object for status