SunshineConversationsClient::Whatsapp
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 | To configure a WhatsApp integration, use your WhatsApp API Client connection information. Sunshine Conversations can provide WhatsApp API Client hosting for approved brands. See our WhatsApp guide for more details on WhatsApp API Client hosting. | [optional][default to 'whatsapp'] |
| hsm_fallback_language | String | Specify a fallback language to use when sending WhatsApp message template using the short hand syntax. Defaults to en_US. See WhatsApp documentation for more info. | [optional][default to 'en_US'] |
| account_id | String | The business ID associated with the WhatsApp account. In combination with accountManagementAccessToken, it’s used for Message Template Reconstruction. | [optional] |
| account_management_access_token | String | An access token associated with the accountId used to query the WhatsApp Account Management API. In combination with accountId, it’s used for Message Template Reconstruction. | [optional] |
| phone_number | String | The phone number that is associated with the deployment of this integration, if one exists. | [optional][readonly] |
Example
require 'sunshine-conversations-client'
instance = SunshineConversationsClient::Whatsapp.new(
default_responder_id: null,
default_responder: null,
type: null,
hsm_fallback_language: null,
account_id: your_whatsApp_account_id,
account_management_access_token: your_access_token,
phone_number: 15144441919
)