Getting Oracle Radio WebSocket Channel Status

Send a CHANNEL_STATUS message to determine whether a Radio channel is idle or busy and inspect its current talk-floor state.

Permissions and Prerequisites

The following permissions and prerequisites apply to this operation.

RequirementValue
AuthenticationComplete the supported authentication path for the client before sending this operation. See authentication.
Radio permissionNo operation-specific Radio permission is defined for this message.
Channel accessThe channel name is interpreted in the authenticated user's Radio channel scope. The contract doesn't require a live channel subscription.
Session stateThe WebSocket connection must be open.

Request

Send the CHANNEL_STATUS message as a JSON text message.

NameData typeRequiredDefaultConstraintsDescription
typestringYesNoneMust be CHANNEL_STATUS.Identifies the channel-status operation.
channelstringNodefaultChannel name.Channel for which to return status.
{
  "type": "CHANNEL_STATUS",
  "channel": "operations"
}

Responses

The following table lists the messages the client can receive and explains their purpose.

Message typeKindDescription
CHANNEL_STATUSDirect responseReturns channel metadata, subscriber count, and current talk-floor state.
ERRORErrorIndicates that the request message is invalid or couldn't be processed.

CHANNEL_STATUS Response

The following table describes the response properties, their data types, and whether they are required.

NameData typeRequiredDescription
typestringYesResponse type. The value is CHANNEL_STATUS.
channelstringYesChannel name.
modestringNoChannel mode.
ownerstringNoChannel owner.
subscriberCountintegerNoCurrent subscriber count.
busybooleanYesWhether the channel is busy.
busyBystringNoUsername of the current talk-token holder.
busyByDisplayNamestringNoDisplay name of the current talk-token holder.
priorityintegerNoPriority of the current talk token.
expiresAtstringNoTalk-token expiration date and time in ISO 8601 format.
isTransmittingbooleanNoWhether a user is currently transmitting.
{
  "type": "CHANNEL_STATUS",
  "channel": "operations",
  "mode": "normal",
  "owner": "admin",
  "subscriberCount": 5,
  "busy": true,
  "busyBy": "dispatcher1",
  "busyByDisplayName": "Dispatch One",
  "priority": 50,
  "expiresAt": "2026-09-02T14:35:00Z",
  "isTransmitting": true
}