Get a user-visible app channel | Cessy Builder Docs

const url = 'https://cessy.ai/api/rest/tenant-id/app-id/channels/channelId';
const options = {
  method: 'GET',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "channel": {
    "id": "channel_9f8b7c6d",
    "name": "Project Phoenix",
    "createdAt": "2024-06-10T09:15:00Z",
    "type": "team",
    "description": "Channel for Project Phoenix team collaboration"
  },
  "participants": [
    {
      "id": "user_12345",
      "name": "Alice Johnson",
      "role": "admin",
      "joinedAt": "2024-01-15T08:00:00Z",
      "status": "active"
    }
  ],
  "messages": [
    {
      "id": "msg_98765",
      "senderId": "user_12345",
      "content": "Welcome to the Project Phoenix channel!",
      "timestamp": "2024-06-10T09:20:00Z",
      "type": "text"
    }
  ],
  "turnState": {
    "lastReadMessageId": "msg_98765",
    "typingUsers": [
      "user_67890"
    ]
  },
  "hasMore": true
}

Authentication

AuthorizationBearer

Tenant/app API key or OAuth/JWT bearer token.

Path parameters

channelIdstringRequired

Channel id.

Query parameters

agentIdstringOptional

Optional agent participant id filter within this app.

workspaceIdstringOptionalformat: "^ws_[A-Za-z0-9_-]+$"

Optional Workspace runtime selector for preview or validation calls. If supplied with X-CES-Workspace-ID, both values must match.

Response

Channel details

channelmap from strings to any

participantslist of maps from strings to any

messageslist of maps from strings to any

turnStatemap from strings to any or null

hasMoreboolean

Errors

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

Authentication

Path parameters

Headers

Query parameters

Response

Errors