> To build a Wix site agentically, or add Wix features like bookings or a store to a site you already have, follow https://www.wix.com/headless/skill.md
> 
> Portal Navigation:
> 
> - Append `.md` to any URL under `https://dev.wix.com/docs/` to get its markdown version.
> - Pages are either content pages (article or reference text) or menu pages (a list of links to child pages).
> - To get a menu page, truncate any URL to a parent path and append `.md` (e.g. `https://dev.wix.com/docs/sdk.md`, `https://dev.wix.com/docs/sdk/core-modules.md`).
> - If a reference page seems to be missing its schema (parameters, return types, or type definitions), append `?schema=true` to its `.md` URL (e.g. `https://dev.wix.com/docs/contexts/contexts/stores/category-info/use-category-info-context.md?schema=true`).
> - Top-level index of all portals: https://dev.wix.com/docs/llms.txt
> - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt

# GetAssistantInboxChannelsSettings

# Package: aiSiteChat

# Namespace: AssistantInboxChannelsSettingsService

# Method link: https://dev.wix.com/docs/api-reference/business-management/ai-site-chat/assistant-inbox-channels-settings-v1/get-assistant-inbox-channels-settings.md

## Permission Scopes:
Innovation Lab Administrator: SCOPE.INNOVATION_LAB.ADMIN

## Introduction

Retrieves the AI assistant inbox channel settings for the caller's site.
Creates the settings record with defaults if it doesn't yet exist.

The response also includes the connection status and the effective operating mode of the AI assistant on each channel.
If the connection statuses can't be retrieved, the request fails.

---

## REST API

### Schema

```
 Method: getAssistantInboxChannelsSettings
 Description: Retrieves the AI assistant inbox channel settings for the caller's site. Creates the settings record with defaults if it doesn't yet exist.  The response also includes the connection status and the effective operating mode of the AI assistant on each channel. If the connection statuses can't be retrieved, the request fails.
 URL: https://www.wixapis.com/assistant-inbox-channels-settings/v1/assistant-inbox-channels-settings
 Method: GET
 Return type: GetAssistantInboxChannelsSettingsResponse
  - name: assistantInboxChannelsSettings | type: AssistantInboxChannelsSettings | description: The caller's AI assistant inbox channel settings.  
     - name: id | type: string | description: Settings GUID.  | read-only: true | validation: format GUID
     - name: createdDate | type: string | description: Date and time the settings were created.  | read-only: true | validation: format date-time
     - name: updatedDate | type: string | description: Date and time the settings were last updated.  | read-only: true | validation: format date-time
     - name: revision | type: string | description: Revision number, which increments by 1 each time the settings are updated. To prevent conflicting changes, the current revision must be passed when updating the settings.  | read-only: true | validation: format int64
     - name: whatsapp | type: WhatsAppChannelSettings | description: WhatsApp channel configuration.  
        - name: enabled | type: boolean | description: Whether the AI assistant is enabled for this channel. New sites start with `false`. When omitted in an update, the current value is left unchanged.  Default: `false`  
        - name: activeHours | type: ActiveHours | description: Days and times the AI assistant is available on the channel.  
           - name: schedule | type: array<ActiveHoursFrame> | description: Array of time frames during which the AI assistant is available to respond in the chat. Only used when `mode` is `SCHEDULED`. Ignored for all other modes.  Each frame's `startTime` must be before its `endTime`, and frames must not overlap on shared days. Updates violating these rules fail with `INVALID_ARGUMENT`.  Must be passed together with `timeZone`: when you pass one, you must pass the other too.  | validation: maxItems 500
              - name: startTime | type: string | description: Start time of the active hours in ISO-8601 local time. For example, 9:00 AM = "09:00". Inclusive.  | validation: format LOCAL_TIME
              - name: endTime | type: string | description: End time of the active hours in ISO-8601 local time. For example, 5:00 PM = "17:00". Exclusive. Must be later than `startTime` on the same day, except that "00:00" means the end of the day, so the frame runs until midnight. For example, 9:00 AM to midnight = "09:00" to "00:00". "24:00" isn't valid. To cover hours that span midnight, use one frame ending at "00:00" and another starting at "00:00" on the next day.  | validation: format LOCAL_TIME
              - name: days | type: array<DayOfWeek> | description: Days of the week on which the frame applies.  | validation: minItems 1, maxItems 7
                     - enum:
                     -     MONDAY: Monday.
                     -     TUESDAY: Tuesday.
                     -     WEDNESDAY: Wednesday.
                     -     THURSDAY: Thursday.
                     -     FRIDAY: Friday.
                     -     SATURDAY: Saturday.
                     -     SUNDAY: Sunday.
           - name: timeZone | type: string | description: Time zone used for the schedule, as a standard IANA time zone identifier (for example, "America/New_York", "Europe/London", "Asia/Tokyo"). Fixed offsets such as "+02:00" and the "UTC" alias are also accepted, but non-standard abbreviations such as "EST" or "PST" are not.  See the list of valid identifiers: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones  Must be passed together with `schedule`: when you pass one, you must pass the other too. Otherwise, or if the time zone is unrecognized, the update fails with `INVALID_ARGUMENT`. Leave both out when `mode` is `ALWAYS_WITH_AI`.  | validation: maxLength 256
           - name: mode | type: Mode | description: Determines when the AI assistant responds in the chat. Use `SCHEDULED` to define availability per time frame via the `schedule` field.  
                 - enum:
                 -     ALWAYS_WITH_AI: AI assistant is always available. The `schedule` field is ignored.
                 -     SCHEDULED: AI assistant availability is determined by the `schedule` field. Set time frames in `activeHours.schedule`.
     - name: instagram | type: InstagramChannelSettings | description: Instagram channel configuration.  
        - name: enabled | type: boolean | description: Whether the AI assistant is enabled for this channel. New sites start with `false`. When omitted in an update, the current value is left unchanged.  Default: `false`  
        - name: activeHours | type: ActiveHours | description: Days and times the AI assistant is available on the channel.  
  - name: connectionStatuses | type: ChannelsConnectionStatuses | description: Current connection status of each supported channel account.  | read-only: true 
     - name: whatsapp | type: ChannelConnectionStatus | description: Connection status of the WhatsApp account.  | read-only: true 
         - enum:
         -     UNKNOWN_CONNECTION_STATUS: The connection status couldn't be determined.
         -     ACTIVE: The channel account is connected.
         -     INACTIVE: The channel account isn't connected.
     - name: instagram | type: ChannelConnectionStatus | description: Connection status of the Instagram account.  | read-only: true 
  - name: operatingModes | type: ChannelsOperatingModes | description: Effective operating mode of the AI assistant per channel.  Computed at request time from the channel connection status, the `enabled` flag, and the active hours schedule. Consumers deciding whether the AI assistant should handle an incoming message must use this value instead of combining `enabled` and `connection_statuses` themselves.  | read-only: true 
     - name: whatsapp | type: OperatingMode | description: Operating mode of the AI assistant on the WhatsApp channel.  | read-only: true 
         - enum:
         -     ACTIVE: The AI assistant responds to incoming messages on the channel.
         -     OUTSIDE_ACTIVE_HOURS: The AI assistant is enabled, but the current time is outside the scheduled active hours.
         -     DISABLED: The AI assistant is turned off for the channel.
         -     CHANNEL_NOT_CONNECTED: The channel account is not connected.
     - name: instagram | type: OperatingMode | description: Operating mode of the AI assistant on the Instagram channel.  | read-only: true 


```

### Examples

### Get Assistant Inbox Channels Settings
Retrieves the AI assistant settings, channel connection statuses, and current operating modes for the site

```curl
curl -X GET \
  'https://www.wixapis.com/assistant-inbox-channels-settings/v1/assistant-inbox-channels-settings' \
  -H 'Authorization: <AUTH>'
```

---

## JavaScript SDK

### Schema

```
 Method: wixClientAdmin.assistantInboxChannelsSettings.assistantInboxChannelsSettings.getAssistantInboxChannelsSettings()
 Description: Retrieves the AI assistant inbox channel settings for the caller's site. Creates the settings record with defaults if it doesn't yet exist.  The response also includes the connection status and the effective operating mode of the AI assistant on each channel. If the connection statuses can't be retrieved, the request fails.
 Return type: PROMISE<AssistantInboxChannelsSettings>
  - name: _id | type: string | description: Settings GUID.  | read-only: true | validation: format GUID
  - name: _createdDate | type: Date | description: Date and time the settings were created.  | read-only: true 
  - name: _updatedDate | type: Date | description: Date and time the settings were last updated.  | read-only: true 
  - name: revision | type: string | description: Revision number, which increments by 1 each time the settings are updated. To prevent conflicting changes, the current revision must be passed when updating the settings.  | read-only: true | validation: format int64
  - name: whatsapp | type: WhatsAppChannelSettings | description: WhatsApp channel configuration.  
     - name: enabled | type: boolean | description: Whether the AI assistant is enabled for this channel. New sites start with `false`. When omitted in an update, the current value is left unchanged.  Default: `false`  
     - name: activeHours | type: ActiveHours | description: Days and times the AI assistant is available on the channel.  
        - name: schedule | type: array<ActiveHoursFrame> | description: Array of time frames during which the AI assistant is available to respond in the chat. Only used when `mode` is `SCHEDULED`. Ignored for all other modes.  Each frame's `startTime` must be before its `endTime`, and frames must not overlap on shared days. Updates violating these rules fail with `INVALID_ARGUMENT`.  Must be passed together with `timeZone`: when you pass one, you must pass the other too.  | validation: maxItems 500
           - name: startTime | type: string | description: Start time of the active hours in ISO-8601 local time. For example, 9:00 AM = "09:00". Inclusive.  | validation: format LOCAL_TIME
           - name: endTime | type: string | description: End time of the active hours in ISO-8601 local time. For example, 5:00 PM = "17:00". Exclusive. Must be later than `startTime` on the same day, except that "00:00" means the end of the day, so the frame runs until midnight. For example, 9:00 AM to midnight = "09:00" to "00:00". "24:00" isn't valid. To cover hours that span midnight, use one frame ending at "00:00" and another starting at "00:00" on the next day.  | validation: format LOCAL_TIME
           - name: days | type: array<DayOfWeek> | description: Days of the week on which the frame applies.  | validation: minItems 1, maxItems 7
                 - enum:
                 -     MONDAY: Monday.
                 -     TUESDAY: Tuesday.
                 -     WEDNESDAY: Wednesday.
                 -     THURSDAY: Thursday.
                 -     FRIDAY: Friday.
                 -     SATURDAY: Saturday.
                 -     SUNDAY: Sunday.
        - name: timeZone | type: string | description: Time zone used for the schedule, as a standard IANA time zone identifier (for example, "America/New_York", "Europe/London", "Asia/Tokyo"). Fixed offsets such as "+02:00" and the "UTC" alias are also accepted, but non-standard abbreviations such as "EST" or "PST" are not.  See the list of valid identifiers: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones  Must be passed together with `schedule`: when you pass one, you must pass the other too. Otherwise, or if the time zone is unrecognized, the update fails with `INVALID_ARGUMENT`. Leave both out when `mode` is `ALWAYS_WITH_AI`.  | validation: maxLength 256
        - name: mode | type: Mode | description: Determines when the AI assistant responds in the chat. Use `SCHEDULED` to define availability per time frame via the `schedule` field.  
             - enum:
             -     ALWAYS_WITH_AI: AI assistant is always available. The `schedule` field is ignored.
             -     SCHEDULED: AI assistant availability is determined by the `schedule` field. Set time frames in `activeHours.schedule`.
  - name: instagram | type: InstagramChannelSettings | description: Instagram channel configuration.  
     - name: enabled | type: boolean | description: Whether the AI assistant is enabled for this channel. New sites start with `false`. When omitted in an update, the current value is left unchanged.  Default: `false`  
     - name: activeHours | type: ActiveHours | description: Days and times the AI assistant is available on the channel.  


```

### Examples

### Retrieve the AI assistant inbox channel settings
Retrieves the site's AI assistant settings for WhatsApp and Instagram.

```javascript
import { assistantInboxChannelsSettings } from "@wix/assistant-inbox-channels-settings";

async function getAssistantInboxChannelsSettings() {
  const settings =
    await assistantInboxChannelsSettings.getAssistantInboxChannelsSettings();

  return settings;
}

/* Promise resolves to:
 * {
 *   "_id": "8046df3c-7575-4098-a5ab-c91ad8f33c47",
 *   "revision": "2",
 *   "_createdDate": "2026-08-25T09:14:02.117Z",
 *   "_updatedDate": "2026-08-25T09:31:44.006Z",
 *   "whatsapp": {
 *     "enabled": true,
 *     "activeHours": {
 *       "mode": "SCHEDULED",
 *       "timeZone": "America/New_York",
 *       "schedule": [
 *         {
 *           "startTime": "09:00",
 *           "endTime": "17:00",
 *           "days": ["MONDAY", "TUESDAY", "WEDNESDAY", "THURSDAY", "FRIDAY"]
 *         }
 *       ]
 *     }
 *   },
 *   "instagram": {
 *     "enabled": false
 *   }
 * }
 */

```

### getAssistantInboxChannelsSettings (self-managed)
Self-managed SDK calls require you to [create a client](https://dev.wix.com/docs/sdk/articles/work-with-the-sdk/about-the-wix-client.md).

```javascript
import { createClient } from '@wix/sdk';
import { assistantInboxChannelsSettings } from '@wix/assistant-inbox-channels-settings';
// Import the auth strategy for the relevant access type
// Import the relevant host module if needed

const myWixClient = createClient ({
  modules: { assistantInboxChannelsSettings },
  // Include the auth strategy and host as relevant
});


async function getAssistantInboxChannelsSettings() {
  const response = await myWixClient.assistantInboxChannelsSettings.getAssistantInboxChannelsSettings();
};
```

---