SunshineConversationsClient::Apple

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]
typeStringTo configure an Apple Messages for Business integration, acquire the required information and call the Create Integration endpoint.[optional][default to 'apple']
business_idStringApple Messages for Business ID.
api_secretStringYour Apple API secret which is tied to your Messaging Service Provider.
msp_idStringYour Messaging Service Provider ID.
authentication_message_secretStringA secret used to create the state value when sending Apple authentication 2.0 messages[optional]

Example

require 'sunshine-conversations-client'

instance = SunshineConversationsClient::Apple.new(
  default_responder_id: null,
  default_responder: null,
  type: null,
  business_id: 2740f141-89c1-515f-07eb-1128dd73491,
  api_secret: QLA//Z13paUYo/2tLReQa-43c5JEAASujGamiY/QTvs&#x3D;,
  msp_id: e7e495d5-bf78-531d-baf6-7f419f7fb592,
  authentication_message_secret: eH3Ea4329FzUGEsWkjQr1dbD1JDpn5Ygo/kbW0/f8gOQ4eHTr31bjDUcCfv3s9QaAwRgpd4sckdlSXwMOAGHBQ&#x3D;&#x3D;
)