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

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 business linked to this record.

integer

ID of the user linked to this record.

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).

string

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

string

ID of the customer linked to the AI channel session.

string

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

string

Full name of the customer linked to the AI channel session.

string

Mobile phone number of the customer linked to the AI channel session.

string

Landline phone number of the customer linked to the AI channel session.

string

Billing name of the customer linked to the AI channel session.

string

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

string

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

integer

The action value for this open ai chat message. See eOpenAiChatMessageType enum values: 1 = Operator.

string

The content value for this open ai chat message.

string

The chat session value for this open ai chat message.

string

Display name of the linked responder (read-only).

string

The chat message role value for this open ai chat message.

integer

The rating value for this open ai chat message.

string

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

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,
  "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 multiple OpenAiChatMessagesRetrieve multiple OpenAiChatMessage records by their Ids in a single request.

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": "<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>"
}

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