Search OpenAiChatMessages

GET

api

sys

openaichatmessages

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/openaichatmessages \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/openaichatmessages"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/openaichatmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

An OpenAiChatMessage records a message in an AI-powered chat conversation. Each message tracks the content, the associated customer or operator, and the action type.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the OpenAiChatMessage-List role.

Enums

eOpenAiChatMessageType — Action values

Value	Name
1	Operator

Query Parameters

Pagination & Sorting

integer

default:"1"

The page number to retrieve.

integer

default:"25"

The number of records per page.

string

The property name to sort results by (e.g. Name, CreatedOn).

integer

Sort direction. 0 for ascending, 1 for descending.

Filters

integer

Filter by iD of the business linked to this record.

integer

Filter by iD of the user linked to this record.

integer

Filter by iD of the AI channel session linked to this message. Sessions group all messages in a conversation and link it to a specific user and AI channel (e.g. email, chat, WhatsApp).

string

Filter by external identifier of the AI channel session linked to this message. Email address for email sessions, phone number for WhatsApp, etc..

string

Filter by iD of the customer linked to the AI channel session.

string

Filter by the type of the customer linked to the AI channel session (e.g. Individual or Company).

string

Filter by full name of the customer linked to the AI channel session.

string

Filter by mobile phone number of the customer linked to the AI channel session.

string

Filter by landline phone number of the customer linked to the AI channel session.

string

Filter by billing name of the customer linked to the AI channel session.

string

Filter by company name of the customer linked to the AI channel session (if the customer is a company).

string

Filter by comma-separated list of team names that the customer linked to the AI channel session belongs to.

integer

Filter by the action value for this open ai chat message.

string

Filter by the content value for this open ai chat message.

string

Filter by the chat session value for this open ai chat message.

string

Filter by display name of the linked responder (read-only).

string

Filter by the chat message role value for this open ai chat message.

integer

Filter by the rating value for this open ai chat message.

string

Filter by the AI channel through which this message was sent (e.g. Email, Chat, WhatsApp).

Range Filters

integer

Filter by the rating value for this open ai chat message greater than or equal to this value.

integer

Filter by the rating value for this open ai chat message less than or equal to this value.

string

Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.

string

Filter records updated on or before this date. Format: YYYY-MM-DDTHH:mm.

Code Examples

Simple listing

curl -X GET \
  "https://spaces.nexudus.com/api/sys/openaichatmessages?page=1&size=15&orderBy=Content&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/openaichatmessages?' + new URLSearchParams({
    page: 1,
    size: 15,
    orderBy: 'Content',
    dir: 1 // Ascending
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/openaichatmessages',
    params={
        'page': 1,
        'size': 15,
        'orderBy': 'Content',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Filtering by Content

curl -X GET \
  "https://spaces.nexudus.com/api/sys/openaichatmessages?OpenAiChatMessage_Content=example-value&orderBy=Content&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/openaichatmessages?' + new URLSearchParams({
    OpenAiChatMessage_Content: 'example-value',
    orderBy: 'Content',
    dir: 1
  }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/openaichatmessages',
    params={
        'OpenAiChatMessage_Content': 'example-value',
        'orderBy': 'Content',
        'dir': 0 // Ascending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Range filters

curl -X GET \
  "https://spaces.nexudus.com/api/sys/openaichatmessages?from_OpenAiChatMessage_UpdatedOn=2025-01-01T00:00&to_OpenAiChatMessage_UpdatedOn=2025-12-31T23:59&orderBy=UpdatedOn&dir=0" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/openaichatmessages?' + new URLSearchParams({
    from_OpenAiChatMessage_UpdatedOn: '2025-01-01T00:00',
    to_OpenAiChatMessage_UpdatedOn: '2025-12-31T23:59',
    orderBy: 'UpdatedOn',
    dir: 1 // Descending
   }),
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const data = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/openaichatmessages',
    params={
        'from_OpenAiChatMessage_UpdatedOn': '2025-01-01T00:00',
        'to_OpenAiChatMessage_UpdatedOn': '2025-12-31T23:59',
        'orderBy': 'UpdatedOn',
        'dir': 1 // Descending
    },
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

data = response.json()

Response

200

OpenAiChatMessage[]

The list of OpenAiChatMessage records matching the query. See the Get one OpenAiChatMessage endpoint for the full list of properties returned for each record.

Partial records — The listing endpoint returns a summary representation of each OpenAiChatMessage. The following fields are not populated in the Records[] response: Action.To get all fields, fetch the full record using the Get one OpenAiChatMessage endpoint.Important for updates: When updating a record via PUT, always retrieve the full record with a GET request first, apply your changes to that complete data, and then send the updated record. Do not use data from a listing response as the base for a PUT request, as missing fields may be unintentionally cleared.

integer

Current page number.

integer

Number of records per page.

string

The field used for sorting.

integer

The sort direction (0 = ascending, 1 = descending).

integer

Index of the first item on the current page.

integer

Index of the last item on the current page.

integer

Total number of matching records across all pages.

integer

Total number of pages.

boolean

Whether there is a next page of results.

boolean

Whether there is a previous page of results.

Example Response

{
  "Records": [
    {
      "BusinessId": 0,
      "UserId": null,
      "AiChannelSessionId": null,
      "AiChannelSessionExternalIdentifier": null,
      "AiChannelSessionCoworkerId": null,
      "AiChannelSessionCoworkerCoworkerType": null,
      "AiChannelSessionCoworkerFullName": null,
      "AiChannelSessionCoworkerMobilePhone": null,
      "AiChannelSessionCoworkerLandLine": null,
      "AiChannelSessionCoworkerBillingName": null,
      "AiChannelSessionCoworkerCompanyName": null,
      "AiChannelSessionCoworkerTeamNames": null,
      "Content": "",
      "ChatSession": null,
      "ResponderName": null,
      "ChatMessageRole": null,
      "Rating": null,
      "Channel": null,
      "Id": 87654321,
      "UpdatedOn": "2025-01-15T10:30:00Z",
      "CreatedOn": "2025-01-10T08:00:00Z",
      "UniqueId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "UpdatedBy": "admin@example.com",
      "IsNew": false,
      "SystemId": null,
      "ToStringText": "OpenAiChatMessage Example",
      "LocalizationDetails": null,
      "CustomFields": null
    }
  ],
  "CurrentPageSize": 15,
  "CurrentPage": 1,
  "CurrentOrderField": "Content",
  "CurrentSortDirection": 1,
  "FirstItem": 1,
  "HasNextPage": false,
  "HasPreviousPage": false,
  "LastItem": 1,
  "PageNumber": 1,
  "PageSize": 15,
  "TotalItems": 1,
  "TotalPages": 1
}

Get one OpenAiChatMessageRetrieve a single OpenAiChatMessage record by its Id.

Search OpenAiChatMessages

curl --request GET \
  --url https://spaces.nexudus.com/api/sys/openaichatmessages \
  --header 'Authorization: Basic <encoded-value>'

import requests

url = "https://spaces.nexudus.com/api/sys/openaichatmessages"

headers = {"Authorization": "Basic <encoded-value>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://spaces.nexudus.com/api/sys/openaichatmessages', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Records": [
    {}
  ],
  "CurrentPage": 123,
  "CurrentPageSize": 123,
  "CurrentOrderField": "<string>",
  "CurrentSortDirection": 123,
  "FirstItem": 123,
  "LastItem": 123,
  "TotalItems": 123,
  "TotalPages": 123,
  "HasNextPage": true,
  "HasPreviousPage": true
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Enums

Query Parameters

Filters

Range Filters

Code Examples

Simple listing

Filtering by Content

Range filters

Response

200

​Authentication

​Enums

​Query Parameters

​Pagination & Sorting

​Filters

​Range Filters

​Code Examples

​Simple listing

​Filtering by Content

​Range filters

​Response

​200

Authentication

Enums

Query Parameters

Pagination & Sorting

Filters

Range Filters

Code Examples

Simple listing

Filtering by Content

Range filters

Response

200