> 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`). > - Top-level index of all portals: https://dev.wix.com/docs/llms.txt > - Full concatenated docs: https://dev.wix.com/docs/llms-full.txt # QueryChatSettings # Package: forms # Namespace: ChatSettingsService # Method link: https://dev.wix.com/docs/api-reference/crm/forms/chat-settings/query-chat-settings.md ## Permission Scopes: Manage Submissions: SCOPE.DC-FORMS.MANAGE-SUBMISSIONS ## Introduction Retrieves a list of chat settings entities given the provided paging, filtering, and sorting. --- ## REST API ### Schema ``` Method: queryChatSettings Description: Retrieves a list of chat settings entities given the provided paging, filtering, and sorting. ### Defaults Query Chat Settings has the following default settings, which you can override: + Sorted by `id` in ascending order. + `cursorPaging.limit` set to `100`. URL: https://www.wixapis.com/forms/ai/v1/chat-settings/query Method: POST Method parameters: param name: query | type: CursorQuery - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: QueryChatSettingsResponse - name: chatSettings | type: array | description: List of chat settings matching the query. - name: id | type: string | description: The GUID of the chat settings. The chat settings specified in this object apply to the form with a matching GUID. - name: greetingMessage | type: string | description: Custom greeting message displayed when a visitor opens the AI chat. - name: chatEnabled | type: boolean | description: Whether AI chat is enabled for this form. Default: `true` - name: revision | type: string | description: Revision number, which increments by 1 each time the chat settings are updated. To prevent conflicting changes, the current revision must be passed when updating the chat settings. - name: createdDate | type: string | description: Date and time the chat settings were created. - name: updatedDate | type: string | description: Date and time the chat settings were last updated. - name: summaryMessage | type: string | description: Message that summarizes the contents of the form. Appears after the greeting message. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: manualSummary | type: boolean | description: Whether the summary message is manually set or AI-generated. When `false` the summary message is automatically generated by AI when the chat settings are saved. When `true`, the summary message can be manually set and won't be overwritten by AI. Default: `false` - name: personality | type: Personality | description: Personality of the AI when interacting with visitors. Defines the communication style of the AI chat responses. - enum: PROFESSIONAL, FRIENDLY, PLAYFUL, DIRECT - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata about the pagination of the results. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` --- ## JavaScript SDK ### Schema ``` Method: wixClientAdmin.forms.ChatSettingsService.queryChatSettings(query) Description: Retrieves a list of chat settings entities given the provided paging, filtering, and sorting. ### Defaults Query Chat Settings has the following default settings, which you can override: + Sorted by `id` in ascending order. + `cursorPaging.limit` set to `100`. # Note: If the parameter `a.b` is listed under required parameters, `b` is only required if `a` is also present. Required parameters: query Method parameters: param name: query | type: ChatSettingsQuery | required: true - name: cursorPaging | type: CursorPaging | description: Cursor paging options. Learn more about [cursor paging](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#cursor-paging). - name: limit | type: integer | description: Maximum number of items to return in the results. - name: cursor | type: string | description: Pointer to the next or previous page in the list of results. Pass the relevant cursor token from the `pagingMetadata` object in the previous call's response. Not relevant for the first request. - name: filter | type: object | description: Filter object. Learn more about [filtering](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#filters). - name: sort | type: array | description: Sort object. Learn more about [sorting](https://dev.wix.com/docs/rest/articles/getting-started/api-query-language.md#sorting). - name: fieldName | type: string | description: Name of the field to sort by. - name: order | type: SortOrder | description: Sort order. - enum: ASC, DESC Return type: PROMISE - name: chatSettings | type: array | description: List of chat settings matching the query. - name: _id | type: string | description: The GUID of the chat settings. The chat settings specified in this object apply to the form with a matching GUID. - name: greetingMessage | type: string | description: Custom greeting message displayed when a visitor opens the AI chat. - name: chatEnabled | type: boolean | description: Whether AI chat is enabled for this form. Default: `true` - name: revision | type: string | description: Revision number, which increments by 1 each time the chat settings are updated. To prevent conflicting changes, the current revision must be passed when updating the chat settings. - name: _createdDate | type: Date | description: Date and time the chat settings were created. - name: _updatedDate | type: Date | description: Date and time the chat settings were last updated. - name: summaryMessage | type: string | description: Message that summarizes the contents of the form. Appears after the greeting message. - name: extendedFields | type: ExtendedFields | description: Extended fields. - name: namespaces | type: object | description: Extended field data. Each key corresponds to the namespace of the app that created the extended fields. The value of each key is structured according to the schema defined when the extended fields were configured. You can only access fields for which you have the appropriate permissions. Learn more about [extended fields](https://dev.wix.com/docs/rest/articles/getting-started/extended-fields.md). - name: manualSummary | type: boolean | description: Whether the summary message is manually set or AI-generated. When `false` the summary message is automatically generated by AI when the chat settings are saved. When `true`, the summary message can be manually set and won't be overwritten by AI. Default: `false` - name: personality | type: Personality | description: Personality of the AI when interacting with visitors. Defines the communication style of the AI chat responses. - enum: PROFESSIONAL, FRIENDLY, PLAYFUL, DIRECT - name: pagingMetadata | type: CursorPagingMetadata | description: Metadata about the pagination of the results. - name: count | type: integer | description: Number of items returned in current page. - name: cursors | type: Cursors | description: Cursor strings that point to the next page, previous page, or both. - name: next | type: string | description: Cursor string pointing to the next page in the list of results. - name: prev | type: string | description: Cursor pointing to the previous page in the list of results. - name: hasNext | type: boolean | description: Whether there are more pages to retrieve following the current page. + `true`: Another page of results can be retrieved. + `false`: This is the last page. ``` ### Examples ### queryChatSettings ```javascript import { chatSettings } from '@wix/forms'; async function queryChatSettings(query) { const response = await chatSettings.queryChatSettings(query); }; ``` ### queryChatSettings (with elevated permissions) ```javascript import { chatSettings } from '@wix/forms'; import { auth } from '@wix/essentials'; async function myQueryChatSettingsMethod(query) { const elevatedQueryChatSettings = auth.elevate(chatSettings.queryChatSettings); const response = await elevatedQueryChatSettings(query); } ``` ### queryChatSettings (self-hosted) Self-hosted 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 { chatSettings } from '@wix/forms'; // Import the auth strategy for the relevant access type // Import the relevant host module if needed const myWixClient = createClient ({ modules: { chatSettings }, // Include the auth strategy and host as relevant }); async function queryChatSettings(query) { const response = await myWixClient.chatSettings.queryChatSettings(query); }; ``` ---