Skip to main content
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>'
{
  "BusinessId": 123,
  "UserId": 123,
  "AiChannelSessionId": 123,
  "AiChannelSessionExternalIdentifier": "<string>",
  "AiChannelSessionCoworkerId": "<string>",
  "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>",
  "Id": 123,
  "UniqueId": "<string>",
  "CreatedOn": "<string>",
  "UpdatedOn": "<string>",
  "UpdatedBy": "<string>",
  "IsNew": true,
  "SystemId": "<string>"
}
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-Read role.

​
Path Parameters

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

​
Response

​
200

​
BusinessId
integer
ID of the business linked to this record.
​
UserId
integer
ID of the user linked to this record.
​
AiChannelSessionId
integer
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).
​
AiChannelSessionExternalIdentifier
string
External identifier of the AI channel session linked to this message. Email address for email sessions, phone number for WhatsApp, etc..
​
AiChannelSessionCoworkerId
string
ID of the customer linked to the AI channel session.
​
AiChannelSessionCoworkerCoworkerType
string
The type of the customer linked to the AI channel session (e.g. Individual or Company).
​
AiChannelSessionCoworkerFullName
string
Full name of the customer linked to the AI channel session.
​
AiChannelSessionCoworkerMobilePhone
string
Mobile phone number of the customer linked to the AI channel session.
​
AiChannelSessionCoworkerLandLine
string
Landline phone number of the customer linked to the AI channel session.
​
AiChannelSessionCoworkerBillingName
string
Billing name of the customer linked to the AI channel session.
​
AiChannelSessionCoworkerCompanyName
string
Company name of the customer linked to the AI channel session (if the customer is a company).
​
AiChannelSessionCoworkerTeamNames
string
Comma-separated list of team names that the customer linked to the AI channel session belongs to.
​
Action
integer
The action value for this open ai chat message. See eOpenAiChatMessageType enum values: 1 = Operator.
​
Content
string
The content value for this open ai chat message.
​
ChatSession
string
The chat session value for this open ai chat message.
​
ResponderName
string
Display name of the linked responder (read-only).
​
ChatMessageRole
string
The chat message role value for this open ai chat message.
​
Rating
integer
The rating value for this open ai chat message.
​
Channel
string
The AI channel through which this message was sent (e.g. Email, Chat, WhatsApp).
​
Id
integer
Unique record identifier.
​
UniqueId
string
UUID of the record.
​
CreatedOn
string
Date and time the record was created (ISO 8601).
​
UpdatedOn
string
Date and time the record was last updated (ISO 8601).
​
UpdatedBy
string
Email of the user who last updated this record.
​
IsNew
boolean
Whether the record was recently created.
​
SystemId
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,
  "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
}