Skip to main content
GET
/
api
/
sys
/
openaichatmessages
Search OpenAiChatMessages
curl --request GET \
  --url https://spaces.nexudus.com/api/sys/openaichatmessages \
  --header 'Authorization: Basic <encoded-value>'
{
  "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

ValueName
1Operator

​
Query Parameters

​
Pagination & Sorting

​
page
integer
default:"1"
The page number to retrieve.
​
size
integer
default:"25"
The number of records per page.
​
orderBy
string
The property name to sort results by (e.g. Name, CreatedOn).
​
dir
integer
Sort direction. 0 for ascending, 1 for descending.

​
Filters

​
OpenAiChatMessage_Business
integer
Filter by iD of the business linked to this record.
​
OpenAiChatMessage_User
integer
Filter by iD of the user linked to this record.
​
OpenAiChatMessage_AiChannelSession
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).
​
OpenAiChatMessage_AiChannelSession_ExternalIdentifier
string
Filter by external identifier of the AI channel session linked to this message. Email address for email sessions, phone number for WhatsApp, etc..
​
OpenAiChatMessage_AiChannelSession_Coworker_Id
string
Filter by iD of the customer linked to the AI channel session.
​
OpenAiChatMessage_AiChannelSession_Coworker_CoworkerType
string
Filter by the type of the customer linked to the AI channel session (e.g. Individual or Company).
​
OpenAiChatMessage_AiChannelSession_Coworker_FullName
string
Filter by full name of the customer linked to the AI channel session.
​
OpenAiChatMessage_AiChannelSession_Coworker_MobilePhone
string
Filter by mobile phone number of the customer linked to the AI channel session.
​
OpenAiChatMessage_AiChannelSession_Coworker_LandLine
string
Filter by landline phone number of the customer linked to the AI channel session.
​
OpenAiChatMessage_AiChannelSession_Coworker_BillingName
string
Filter by billing name of the customer linked to the AI channel session.
​
OpenAiChatMessage_AiChannelSession_Coworker_CompanyName
string
Filter by company name of the customer linked to the AI channel session (if the customer is a company).
​
OpenAiChatMessage_AiChannelSession_Coworker_TeamNames
string
Filter by comma-separated list of team names that the customer linked to the AI channel session belongs to.
​
OpenAiChatMessage_Action
integer
Filter by the action value for this open ai chat message.
​
OpenAiChatMessage_Content
string
Filter by the content value for this open ai chat message.
​
OpenAiChatMessage_ChatSession
string
Filter by the chat session value for this open ai chat message.
​
OpenAiChatMessage_ResponderName
string
Filter by display name of the linked responder (read-only).
​
OpenAiChatMessage_ChatMessageRole
string
Filter by the chat message role value for this open ai chat message.
​
OpenAiChatMessage_Rating
integer
Filter by the rating value for this open ai chat message.
​
OpenAiChatMessage_Channel
string
Filter by the AI channel through which this message was sent (e.g. Email, Chat, WhatsApp).

​
Range Filters

​
from_OpenAiChatMessage_Rating
integer
Filter by the rating value for this open ai chat message greater than or equal to this value.
​
to_OpenAiChatMessage_Rating
integer
Filter by the rating value for this open ai chat message less than or equal to this value.
​
from_OpenAiChatMessage_CreatedOn
string
Filter records created on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_OpenAiChatMessage_CreatedOn
string
Filter records created on or before this date. Format: YYYY-MM-DDTHH:mm.
​
from_OpenAiChatMessage_UpdatedOn
string
Filter records updated on or after this date. Format: YYYY-MM-DDTHH:mm.
​
to_OpenAiChatMessage_UpdatedOn
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"

​
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"

​
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"

​
Response

​
200

​
Records
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.
​
CurrentPage
integer
Current page number.
​
CurrentPageSize
integer
Number of records per page.
​
CurrentOrderField
string
The field used for sorting.
​
CurrentSortDirection
integer
The sort direction (0 = ascending, 1 = descending).
​
FirstItem
integer
Index of the first item on the current page.
​
LastItem
integer
Index of the last item on the current page.
​
TotalItems
integer
Total number of matching records across all pages.
​
TotalPages
integer
Total number of pages.
​
HasNextPage
boolean
Whether there is a next page of results.
​
HasPreviousPage
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
}