Get one OpenAiChatMessage

GET

api

sys

openaichatmessages

{id}

Get one OpenAiChatMessage

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "UserId": 123,
  "AiChannelSessionId": 123,
  "AiChannelSessionExternalIdentifier": "<string>",
  "AiChannelSessionCoworkerId": 123,
  "AiChannelSessionCoworkerCoworkerType": "<string>",
  "AiChannelSessionCoworkerFullName": "<string>",
  "AiChannelSessionCoworkerMobilePhone": "<string>",
  "AiChannelSessionCoworkerLandLine": "<string>",
  "AiChannelSessionCoworkerBillingName": "<string>",
  "AiChannelSessionCoworkerCompanyName": "<string>",
  "AiChannelSessionCoworkerTeamNames": "<string>",
  "Action": 123,
  "Content": "<string>",
  "ChatSession": "<string>",
  "ResponderName": "<string>",
  "ChatMessageRole": "<string>",
  "Rating": 123,
  "Channel": "<string>",
  "CoworkerMessageId": 123,
  "HelpDeskMessageId": 123,
  "HelpDeskCommentId": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

An OpenAiChatMessage is a single turn in an AI conversation — what the contact said, what the AI answered, a tool the AI ran, or a message an operator pushed into the thread. Messages belong to an AiChannelSession and share its ChatSession GUID, so filtering by conversation and ordering by creation time reproduces the transcript. This entity is read-only: turns are written by the AI pipeline as the conversation happens and are never edited afterwards.

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-Read role.

Path Parameters

integer

required

The Id of the OpenAiChatMessage record to retrieve.

Code Examples

curl -X GET \
  "https://spaces.nexudus.com/api/sys/openaichatmessages/87654321" \
  -H "Authorization: Bearer YOUR_TOKEN"

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/openaichatmessages/87654321',
  {
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN'
    }
  }
);

const record = await response.json();

import requests

response = requests.get(
    'https://spaces.nexudus.com/api/sys/openaichatmessages/87654321',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN'
    }
)

record = response.json()

Response

200

integer

ID of the location that owns this message, inherited from its conversation..

integer

ID of the platform user this message is attributed to. Set for messages exchanged inside an authenticated session; empty for anonymous web-chat and inbound email or WhatsApp contacts..

integer

ID of the conversation this message belongs to. Filter on it to read one conversation’s transcript in order..

string

Display value for AiChannelSession.ExternalIdentifier..

integer

Display value for AiChannelSession.Coworker.Id..

string

Display value for AiChannelSession.Coworker.CoworkerType..

string

Display value for AiChannelSession.Coworker.FullName..

string

Display value for AiChannelSession.Coworker.MobilePhone..

string

Display value for AiChannelSession.Coworker.LandLine..

string

Display value for AiChannelSession.Coworker.BillingName..

string

Display value for AiChannelSession.Coworker.CompanyName..

string

Display value for AiChannelSession.Coworker.TeamNames..

integer

What this message was, beyond its role: Operator for ordinary AI or operator turns; OutboundCoworkerMessage and OutboundHelpDesk for AI replies delivered as a customer message or a help desk ticket; InboundCoworkerReply and InboundHelpDeskReply for the customer answering through those channels. Use it with the CoworkerMessage, HelpDeskMessage and HelpDeskComment links to show where a turn actually happened.. See eOpenAiChatMessageType enum values: 1 = Operator.

string

Message body. User and assistant turns hold the text shown to people, in Markdown or HTML depending on channel; Tool turns hold a serialised tool result, and the assistant turn that requests tools holds a JSON array of tool calls rather than prose..

string

GUID of the conversation, matching AiChannelSession.ChatSession. Identical for every message in the same conversation..

string

Which internal responder produced the message, such as CompleteWithTools, KbOpenAiResponder or ProactiveExecutionEngine. Useful for tracing why the AI answered the way it did; empty for messages that came from a person..

string

Conversation role: User for the contact, Assistant for the AI, Tool for a tool result, System for prompt scaffolding, and operator-outbound for a message an operator sent into the thread. A transcript normally shows only User, Assistant and operator-outbound..

integer

Feedback the recipient left on this answer through the members portal. Empty when nobody rated it..

string

Channel this turn travelled on, stored as text and matching its conversation: Chat, Email, WhatsApp, Voice, CoworkerMessage or HelpDesk..

integer

ID of the customer message this turn was delivered as or came from, when the AI replied over the CoworkerMessage channel..

integer

ID of the help desk ticket this turn created or belongs to, set when the conversation was escalated to the help desk..

integer

ID of the help desk comment this turn came from, set when the customer or an operator replied on the escalated ticket..

integer

Unique record identifier.

string

UUID of the record.

string

Date and time the record was created (ISO 8601).

string

Date and time the record was last updated (ISO 8601).

string

Email of the user who last updated this record.

boolean

Whether the record was recently created.

string

External system identifier.

Example Response

{
  "BusinessId": 0,
  "UserId": null,
  "AiChannelSessionId": null,
  "AiChannelSessionExternalIdentifier": null,
  "AiChannelSessionCoworkerId": null,
  "AiChannelSessionCoworkerCoworkerType": null,
  "AiChannelSessionCoworkerFullName": null,
  "AiChannelSessionCoworkerMobilePhone": null,
  "AiChannelSessionCoworkerLandLine": null,
  "AiChannelSessionCoworkerBillingName": null,
  "AiChannelSessionCoworkerCompanyName": null,
  "AiChannelSessionCoworkerTeamNames": null,
  "Action": 0,
  "Content": "",
  "ChatSession": null,
  "ResponderName": null,
  "ChatMessageRole": null,
  "Rating": null,
  "Channel": null,
  "CoworkerMessageId": null,
  "HelpDeskMessageId": null,
  "HelpDeskCommentId": 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
}

Get one OpenAiChatMessage

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

import requests

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

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/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "BusinessId": 123,
  "UserId": 123,
  "AiChannelSessionId": 123,
  "AiChannelSessionExternalIdentifier": "<string>",
  "AiChannelSessionCoworkerId": 123,
  "AiChannelSessionCoworkerCoworkerType": "<string>",
  "AiChannelSessionCoworkerFullName": "<string>",
  "AiChannelSessionCoworkerMobilePhone": "<string>",
  "AiChannelSessionCoworkerLandLine": "<string>",
  "AiChannelSessionCoworkerBillingName": "<string>",
  "AiChannelSessionCoworkerCompanyName": "<string>",
  "AiChannelSessionCoworkerTeamNames": "<string>",
  "Action": 123,
  "Content": "<string>",
  "ChatSession": "<string>",
  "ResponderName": "<string>",
  "ChatMessageRole": "<string>",
  "Rating": 123,
  "Channel": "<string>",
  "CoworkerMessageId": 123,
  "HelpDeskMessageId": 123,
  "HelpDeskCommentId": 123,
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Authentication

Path Parameters

Code Examples

Response

200

​Authentication

​Path Parameters

​Code Examples

​Response

​200

Authentication

Path Parameters

Code Examples

Response

200