SunshineConversationsClient::Android
August 27, 2025 ยท View on GitHub
Properties
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 the <a href="https://developer.zendesk.com/documentation/conversations/messaging-platform/programmable-conversations/switchboard/#default-integration-assignment\">Switchboard guide</a>. | [optional] |
| default_responder | DefaultResponderDefaultResponder | [optional] | |
| type | String | <aside class="notice"><strong>Note:</strong> Firebase Cloud Messaging has deprecated its legacy APIs for HTTP and XMPP. Legacy credentials <code>serverKey</code> and <code>senderId</code> will stop working as of June 2024 and must be replaced with OAuth 2.0 access token based credentials.</aside> To configure an android integration, first visit the Firebase Console. Generate a private key from the Service accounts tab in the settings. Copy the `project_id`, `client_email` and `private_key` from the generated JSON file and call the create integrations endpoint with this data. | [optional][default to 'android'] |
| project_id | String | Your project ID from your generated private key file. | [optional] |
| client_email | String | Your client email from your generated private key file. | [optional] |
| private_key | String | Your private key from your generated private key file. | [optional] |
| server_key | String | Your server key from the fcm console. | [optional] |
| sender_id | String | Your sender id from the fcm console. | [optional] |
| can_user_see_conversation_list | Boolean | Allows users to view their list of conversations. By default, the list of conversations will be visible. This setting only applies to apps where `settings.multiConvoEnabled` is set to `true`. | [optional] |
| can_user_create_more_conversations | Boolean | Allows users to create more than one conversation on the android integration. | [optional] |
| attachments_enabled | Boolean | Allows users to send attachments. By default, the setting is set to true. This setting can only be configured in Zendesk Admin Center. | [optional][readonly] |
Example
require 'sunshine-conversations-client'
instance = SunshineConversationsClient::Android.new(
default_responder_id: null,
default_responder: null,
type: null,
project_id: <project-id>,
client_email: <client-email>,
private_key: <private-key>,
server_key: <server-key>,
sender_id: <sender-id>,
can_user_see_conversation_list: false,
can_user_create_more_conversations: null,
attachments_enabled: null
)