SunshineConversationsClient::Messenger

August 27, 2025 · View on GitHub

Properties

NameTypeDescriptionNotes
default_responder_idStringThe 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 the <a href=&quot;https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\&quot;&gt;Switchboard guide</a>.[optional]
default_responderDefaultResponderDefaultResponder[optional]
typeStringFacebook Messenger Setup steps: - Take note of your Facebook app ID and secret (apps can be created at developer.facebook.com); - The Facebook app must have been submitted to Meta for app review with the “pages_manage_metadata” (to retrieve Page Access Tokens for the Pages, apps that the app user administers and set a webhook) and “pages_messaging” (to send messages) permissions. - In order to integrate a Facebook Messenger app you must acquire a Page Access Token from your user. Once you have acquired a page access token from your user, call the Create Integration endpoint with your app secret and ID and the user’s page access token.[optional][default to 'messenger']
page_access_tokenStringA Facebook Page Access Token.
app_idStringA Facebook App ID.
app_secretStringA Facebook App Secret.
page_idFloatA Facebook page ID.[optional]
page_nameStringA Facebook page name.[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::Messenger.new(
  default_responder_id: null,
  default_responder: null,
  type: null,
  page_access_token: your_access_token,
  app_id: your_facebook_app_id,
  app_secret: your_facebook_app_secret,
  page_id: 123212323432123,
  page_name: An Awesome Page
)