SunshineConversationsClient::AppSettings

August 27, 2025 · View on GitHub

Properties

NameTypeDescriptionNotes
conversation_retention_secondsIntegerNumber of seconds of inactivity before a conversation’s messages will be automatically deleted. See Conversation Retention Seconds for more information.[optional]
mask_credit_card_numbersBooleanA boolean specifying whether credit card numbers should be masked when sent through Sunshine Conversations.[optional]
use_animal_namesBooleanA boolean specifying whether animal names should be used for unnamed users. See the user naming guide for details.[optional]
echo_postbackBooleanA boolean specifying whether a message should be added to the conversation history when a postback button is clicked. See Echo Postbacks for more information.[optional]
ignore_auto_conversation_startBooleanA boolean specifying whether a non message event coming from a channel will trigger a start conversation event and count as a monthly active user (MAU). <aside class=&quot;notice&quot;><strong>Note:</strong> Calling <code>startConversation()</code> (or equivalent) from the Android, iOS or Web SDK will count as a MAU, regardless of the value of this setting.</aside>[optional]
multi_convo_enabledBooleanA boolean specifying whether users are allowed to be part of several conversations. Enabling `multiConvo` is irreversible.[optional]
app_localization_enabledBooleanA boolean specifying whether the messages authored by the Sunshine Conversations platform should be localized.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::AppSettings.new(
  conversation_retention_seconds: null,
  mask_credit_card_numbers: null,
  use_animal_names: null,
  echo_postback: null,
  ignore_auto_conversation_start: null,
  multi_convo_enabled: true,
  app_localization_enabled: null
)