# SmoochApi::Integration ## Properties Name | Type | Description | Notes ------------ | ------------- | ------------- | ------------- **id** | **String** | The integration ID, generated automatically. | **type** | **String** | The integration type. See [**IntegrationTypeEnum**](Enums.md#IntegrationTypeEnum) for available values. | **displayName** | **String** | The integration display name. Used to map a human-friendly name to an integration. | [optional] **pageAccessToken** | **String** | Facebook Page Access Token. Required for *messenger* integrations. | [optional] **appId** | **String** | Facebook App ID OR WeChat App ID. Required for *messenger* and *wechat* integrations. | [optional] **appSecret** | **String** | Facebook Page App Secret OR WeChat App Secret. Required for *messenger* and *wechat* integrations. | [optional] **accessTokenUrl** | **String** | Optional endpoint to generate access tokens for WeChat. Used to coordinate API access with third party systems. | [optional] **webhookSecret** | **String** | Secret to verify webhooks. Returned on successful *wechat* and *messagebird* integrations. | [optional] **pageId** | **String** | Facebook Page App ID. Returned on successful *messenger* integrations. | [optional] **accountSid** | **String** | Twilio Account SID. Required for *twilio* integrations. | [optional] **authToken** | **String** | Twilio Auth Token. Required for *twilio* integrations. | [optional] **phoneNumberSid** | **String** | SID for specific phone number. Required for *twilio* integrations. | [optional] **phoneNumber** | **String** | Smooch will receive all messages sent to this phone number. Returned on successful *twilio* integrations. | [optional] **name** | **String** | Name on the account. Returned on successful *twilio* integrations. | [optional] **token** | **String** | Telegram Bot Token OR Viber Public Account token. Required for *twilio* and *viber* integrations. | [optional] **uri** | **String** | The viber URI to find the account. Returned on successful *viber* integrations. | [optional] **channelId** | **String** | LINE Channel ID. Required for *line* integrations. | [optional] **channelSecret** | **String** | LINE Channel Secret. Required for *line* integrations. | [optional] **channelAccessToken** | **String** | LINE Channel Access Token. Required for *line* integrations. | [optional] **serviceCode** | **String** | LINE Service Code. | [optional] **switcherSecret** | **String** | LINE Switcher Secret. | [optional] **qrCodeUrl** | **String** | URL provided by LINE in the [Developer Console](https://developers.line.biz/console/). | [optional] **lineId** | **String** | LINE Basic ID. Generated automatically when a `qrCodeUrl` is updated. | [optional] **botName** | **String** | The bot's name. Returned on successful *line* integrations. | [optional] **encodingAesKey** | **String** | AES Encoding Key. (Optional) Used for *wechat* integrations. | [optional] **fromAddress** | **String** | Email address to use as the `From` and `Reply-To` address if it must be different from `incomingAddress`. Only use this option if the address that you supply is configured to forward emails to the `incomingAddress`, otherwise user replies will be lost. You must also make sure that the domain is properly configured as a mail provider so as to not be flagged as spam by the user's email client. (Optional) Used for *mailgun* integrations. | [optional] **certificate** | **String** | The binary of your APN certificate base64 encoded. Required for *apn* integrations. | [optional] **deploymentId** | **String** | Your WhatsApp deployment ID. Required for *WhatsApp* integrations. | [optional] **baseUrl** | **String** | Your WhatsApp API client's URL. Required for *WhatsApp* integrations. (this usage is deprecated) | [optional] **hsmFallbackLanguage** | **String** | Specification of a fallback language. (Optional) Used for *WhatsApp* integrations. | [optional] **password** | **String** | The password for your APN certificate or WhatsApp API client. Required for *WhatsApp* integrations. (this usage is deprecated) (Optional) Used for *apn* integrations. | [optional] **autoUpdateBadge** | **BOOLEAN** | Use the unread count of the conversation as the application badge. (Optional) Used for *apn* integrations. | [optional] **production** | **BOOLEAN** | Flag specifying whether the certificate is production. Returned on successful *apn* integrations. | [optional] **serverKey** | **String** | Your server key from the fcm console. Required for *fcm* integrations. | [optional] **senderId** | **String** | Your sender id from the fcm console. Required for *fcm* integrations. | [optional] **tier** | **String** | Your Twitter app’s tier. Accepted values are enterprise or premium. | [optional] **envName** | **String** | The Twitter environment name, e.g.: env-beta. Required for *twitter* integrations with *premium* tier. | [optional] **consumerKey** | **String** | The consumer key for your Twitter app. Required for *twitter* integrations. | [optional] **consumerSecret** | **String** | The consumer secret for your Twitter app. Required for *twitter* integrations. | [optional] **accessTokenKey** | **String** | The access token key obtained from your user via oauth. Required for *twitter* integrations. | [optional] **accessTokenSecret** | **String** | The access token secret obtained from your user via oauth. Required for *twitter* integrations. | [optional] **userId** | **String** | The twitter userId. Returned on successful *twitter* integrations. | [optional] **username** | **String** | The username for the account. Returned on successful *twitter* and *telegram* integrations. Required for *WhatsApp* integrations. (this usage is deprecated) | [optional] **apiKey** | **String** | The public API key of your Mailgun account. Required for *mailgun* integrations. | [optional] **domain** | **String** | The domain used to relay email. Required for *mailgun* integrations. | [optional] **incomingAddress** | **String** | Smooch will receive all emails sent to this address. Required for *mailgun* integrations. | [optional] **accessKey** | **String** | The public API key of your MessageBird account. Required for *messagebird* integrations. | [optional] **originator** | **String** | Smooch will receive all messages sent to this phone number. Required for *messagebird* integrations. | [optional] **brandColor** | **String** | This color will be used in the messenger header and the button or tab in idle state. (Optional) Used for *Web Messenger* integrations. | [optional] **fixedIntroPane** | **BOOLEAN** | When `true`, the introduction pane will be pinned at the top of the conversation instead of scrolling with it. The default value is `false`. (Optional) Used for *Web Messenger* integrations. | [optional] **conversationColor** | **String** | This color will be used for customer messages, quick replies and actions in the footer. (Optional) Used for *Web Messenger* integrations. | [optional] **actionColor** | **String** | This color will be used for call-to-actions inside your messages. (Optional) Used for *Web Messenger* integrations. | [optional] **displayStyle** | **String** | Choose how the messenger will appear on your website. Must be either button or tab. (Optional) Used for *Web Messenger* integrations. | [optional] **buttonIconUrl** | **String** | With the button style Web Messenger, you have the option of selecting your own button icon. (Optional) Used for *Web Messenger* integrations. | [optional] **buttonWidth** | **String** | With the button style Web Messenger, you have the option of specifying its width. (Optional) Used for *Web Messenger* integrations. | [optional] **buttonHeight** | **String** | With the button style Web Messenger, you have the option of specifying its height. (Optional) Used for *Web Messenger* integrations. | [optional] **integrationOrder** | **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) Used for *Web Messenger* integrations. | [optional] **businessName** | **String** | A custom business name for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional] **businessIconUrl** | **String** | A custom business icon url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional] **backgroundImageUrl** | **String** | A custom background url for the Web Messenger. (Optional) Used for *Web Messenger* integrations. | [optional] **originWhitelist** | **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 \"://\" host [ \":\" port ]`, where scheme is `http` or `https`. (Optional) Used for *Web Messenger* integrations. | [optional] **hideUnsubscribeLink** | **BOOLEAN** | When `true`, unsubscribe links will not be included in outbound emails. If this setting is enabled, it is expected that the business is providing the user a way to unsubscribe by some other means. (Optional) Used for *mailgun* integrations. | [optional] **status** | **String** | The integration status. See [**IntegrationStatusEnum**](Enums.md#IntegrationStatusEnum) for available values. [More info](https://docs.smooch.io/#integration-status). | [optional] **error** | **String** | The error causing the integration to fail. Will be present when `status` is 'error'. | [optional]