List user-visible app channels | Cessy Builder Docs

const url = 'https://cessy.ai/api/rest/tenant-id/app-id/channels';
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);
}

{
  "channels": [
    {
      "id": "ch_9f8a7b6c5d4e3f2a1b0c",
      "name": "Support Team",
      "type": "group",
      "status": "active",
      "createdAt": "2024-06-10T09:15:00Z",
      "participants": [
        {
          "agentId": "agent_12345",
          "role": "member",
          "joinedAt": "2024-05-01T08:00:00Z"
        },
        {
          "agentId": "agent_67890",
          "role": "admin",
          "joinedAt": "2024-04-20T10:30:00Z"
        }
      ],
      "lastMessage": {
        "id": "msg_abcdef123456",
        "senderId": "agent_12345",
        "sentAt": "2024-06-10T09:10:00Z",
        "content": "Please review the latest ticket updates."
      }
    }
  ]
}

Lists channels visible to the authenticated OAuth user and scoped to agent participants from this app.

Authentication

AuthorizationBearer

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

Query parameters

typestringOptional

Optional channel type filter, for example dm, group, entity, or ext-slack.

statusenumOptional

Optional channel status filter.

Allowed values:

agentIdstringOptional

Optional agent participant id filter within this app.

limitintegerOptional1-200Defaults to 200

Maximum number of entries to return.

qstringOptional

Optional case-insensitive channel search query.

viewenumOptional

Use summary for compact channel list rows.

Allowed values:

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

Visible channels

channelslist of maps from strings to any

Errors

401

Unauthorized Error

403

Forbidden Error

Authentication

Headers

Query parameters

Response

Errors