Listing Available Oracle Radio WebSocket Channels
Send a LIST_ALL_CHANNELS message to list the Radio channels visible to the authenticated user.
Permissions and Prerequisites
The following permissions and prerequisites apply to this operation.
| Requirement | Value |
|---|---|
| Authentication | Complete the supported authentication path for the client before sending this operation. See authentication. |
| Radio permission | radio.channel.list |
| Channel access | The service filters the result by the user's domain and channel access. A nonadministrator sees channels in the user's domain. A hidden channel is returned only when the user has explicit access. |
| Session state | The WebSocket connection must be open. The user doesn't need to join a channel before listing it. |
Request
Send the LIST_ALL_CHANNELS message as a JSON text message.
| Name | Data type | Required | Default | Constraints | Description |
|---|---|---|---|---|---|
type | string | Yes | None | Must be LIST_ALL_CHANNELS. | Identifies the available-channel list operation. |
{
"type": "LIST_ALL_CHANNELS"
}Responses
The following table lists the messages the client can receive and explains their purpose.
| Message type | Kind | Description |
|---|---|---|
ALL_CHANNELS_LIST | Direct response | Returns the channels visible to the user and the current summary for each channel. |
ERROR | Denial or error | Indicates a permission, identity-domain, validation, or processing failure. |
ALL_CHANNELS_LIST Response
The following table describes the response properties, their data types, and whether they are required.
| Name | Data type | Required | Description |
|---|---|---|---|
type | string | Yes | Response type. The value is ALL_CHANNELS_LIST. |
channels | array of objects | Yes | Channels visible to the user. |
channels[].channel | string | No | Channel name. |
channels[].mode | string | No | Channel mode. |
channels[].subscribers | integer | No | Current subscriber count. |
channels[].busy | boolean | No | Whether the channel is busy. |
channels[].busyBy | string | No | Username of the current talk-token holder. |
channels[].busyByDisplayName | string | No | Display name of the current talk-token holder. |
channels[].domain | string | No | Channel domain. |
timestamp | string | No | Server date and time in ISO 8601 format. |
{
"type": "ALL_CHANNELS_LIST",
"channels": [
{
"channel": "operations",
"mode": "normal",
"subscribers": 5,
"busy": false,
"domain": "acme"
}
],
"timestamp": "2026-09-02T14:30:00Z"
}