Skip to content

Latest commit

 

History

History
49 lines (42 loc) · 4.78 KB

WebUpdate.md

File metadata and controls

49 lines (42 loc) · 4.78 KB
Raw

SunshineConversationsClient::WebUpdate

Properties

Name Type Description Notes
display_name String A human-friendly name used to identify the integration. `displayName` can be unset by changing it to `null`. [optional]
default_responder_id String The default responder ID for the integration. This is the ID of the responder that will be used to send messages to the user. For more information, refer to <a href=&quot;https://docs.smooch.io/guide/switchboard/#per-channel-default-responder\&quot;&gt;Per-channel default responder</a> guide. [optional]
brand_color String This color will be used in the messenger header and the button or tab in idle state. Must be a 3 or 6-character hexadecimal color. [optional] [default to '65758e']
fixed_intro_pane Boolean When true, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. [optional] [default to false]
conversation_color String This color will be used for customer messages, quick replies and actions in the footer. Must be a 3 or 6-character hexadecimal color. [optional] [default to '0099ff']
action_color String This color will be used for call-to-actions inside your messages. Must be a 3 or 6-character hexadecimal color. [optional] [default to '0099ff']
display_style String Choose how the messenger will appear on your website. Must be either button or tab. [optional] [default to 'button']
button_icon_url String With the button style Web Messenger, you have the option of selecting your own button icon. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. [optional]
button_width String With the button style Web Messenger, you have the option of specifying the button width. [optional] [default to '58']
button_height String With the button style Web Messenger, you have the option of specifying the button height. [optional] [default to '58']
integration_order Array<String> Array of integration IDs, order will be reflected in the Web Messenger. When set, only integrations from this list will be displayed in the Web Messenger. If unset, all integrations will be displayed. [optional]
business_name String A custom business name for the Web Messenger. [optional]
business_icon_url String A custom business icon url for the Web Messenger. The image must be at least 200 x 200 pixels and must be in either JPG, PNG, or GIF format. [optional]
background_image_url String A background image url for the conversation. Image will be tiled to fit the window. [optional]
origin_whitelist Array<String> A list of origins to whitelist. When set, only the origins from this list will be able to initialize the Web Messenger. If unset, all origins are whitelisted. The elements in the list should follow the serialized-origin format from RFC 6454: scheme &quot;://&quot; host [ &quot;:&quot; port ], where scheme is http or https. [optional]
prechat_capture PrechatCapture Object whose properties can be set to specify the add-on’s options. See the guide to learn more about Prechat Capture. [optional]
can_user_create_more_conversations Boolean Allows users to create more than one conversation on the web messenger integration. [optional]

Code Sample

require 'SunshineConversationsClient'

instance = SunshineConversationsClient::WebUpdate.new(display_name: My awesome integration,
                                 default_responder_id: null,
                                 brand_color: null,
                                 fixed_intro_pane: null,
                                 conversation_color: null,
                                 action_color: null,
                                 display_style: null,
                                 button_icon_url: null,
                                 button_width: null,
                                 button_height: null,
                                 integration_order: [&quot;59fc8466260f48003505228b&quot;,&quot;59d79780481d34002b7d3617&quot;],
                                 business_name: Kent Shop,
                                 business_icon_url: https://www.gravatar.com/image.jpg,
                                 background_image_url: https://a-beautiful-tile.png,
                                 origin_whitelist: null,
                                 prechat_capture: null,
                                 can_user_create_more_conversations: null)