Skip to content

List chat channels

GET
/api/channels
curl --request GET \
--url http://127.0.0.1:7799/api/channels \
--cookie cotal_web_session=<cotal_web_session>

List chat channels with message counts and effective replay and delivery policies. Event channels are excluded. description and replayWindow are absent when unset.

The current snapshot or history page.

Media typeapplication/json
Array<object>
object
channel
required
string
messages
required
integer
description
string
replay
required
boolean
replayWindow
string
deliveryClass
required
string

Examplegenerated

[
{
"channel": "example",
"messages": 1,
"description": "example",
"replay": true,
"replayWindow": "example",
"deliveryClass": "example"
}
]

A valid one-use k query token is exchanged for a dashboard session. The response redirects to the same path without its query. A valid existing cookie takes precedence over k.

Location
string

The requested path without the query string.

Set-Cookie
string

Cotal_web_session=; Path=/; HttpOnly; SameSite=Strict. The default local listener uses HTTP.

No valid session, an invalid launch token, or a spent launch token. The readiness credential does not authorize these routes.

Media typeapplication/json
object
error
required
string
Allowed values: unauthenticated launch-token-already-used

Example

{
"error": "unauthenticated"
}

Origin is checked before session authentication. An origin outside this listener’s allowed origins is refused.

Media typeapplication/json
object
error
required
string
Allowed value: cross-origin

Example

{
"error": "cross-origin"
}

These read routes accept no request body. An announced body is refused before it is read; the connection is closed.

Media typeapplication/json
object
error
required
string

Examplegenerated

{
"error": "example"
}

The request failed. The body names the failure; a failed read does not terminate the dashboard.

Media typeapplication/json
object
error
required
string

Examplegenerated

{
"error": "example"
}