Get a Realtime channel

GET

/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}

const channel = await bird.realtime.channels.get("rap_01krdgeqcxet5s7t44vh8rt9mg", "presence-lobby", {
  include: ["member_count"],
});
console.log(channel.occupied, channel.member_count);

channel = client.realtime.channels.get(
    "rap_01krdgeqcxet5s7t44vh8rt9mg", "presence-lobby", include=["member_count"]
)
print(channel.occupied, channel.member_count)

channel, err := client.Realtime.Channels.Get(context.Background(), "rap_123", "presence-lobby", bird.RealtimeChannelGetParams{
	Include: []bird.RealtimeChannelInclude{bird.RealtimeIncludeMemberCount},
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(channel.Occupied, channel.MemberCount)

$channel = $bird->realtime->channels->get($appId, 'room-42');
echo $channel->getMemberCount(), ' members';

curl -X GET "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}" \
  -H "Authorization: Bearer $TOKEN"

Returns a single channel's occupancy and optional counts. A channel appears when its first connection subscribes and disappears when its last connection leaves. An unknown or unused name returns 200 OK with occupied: false.

Paramètres

realtime_app_id

string

ID of the Realtime app (rap_ prefix), as returned when the app was created.

channel_name

string

Name of the Realtime channel to retrieve.

Paramètres de requête

include

array

Attributes to include. Repeatable. Requesting member_count for a non-presence channel, or connection_count when the app's connection-counting flag is off, returns a validation error (400).

Contenu de la réponse

member_count

integer

Distinct members (presence channels only; requires include=member_count).

connection_count

integer

Connections currently subscribed to this channel (requires include=connection_count and the app's connection-counting flag). Channel-scoped: distinct from the app-wide peak connections metric.

occupied

boolean

obligatoire

Whether at least one client is subscribed.

Ressources associées

Poursuivez avec la documentation, les guides et les exemples sur ce sujet. Les ressources sont en anglais.

Explorer la fonctionnalitéRealtime Suivre le parcours d'apprentissageBuild your first integration Guide d'implémentationSend your first realtime event

Essayez la pratique et obtenez un guide d'implémentation

const channel = await bird.realtime.channels.get("rap_01krdgeqcxet5s7t44vh8rt9mg", "presence-lobby", {
  include: ["member_count"],
});
console.log(channel.occupied, channel.member_count);

channel = client.realtime.channels.get(
    "rap_01krdgeqcxet5s7t44vh8rt9mg", "presence-lobby", include=["member_count"]
)
print(channel.occupied, channel.member_count)

channel, err := client.Realtime.Channels.Get(context.Background(), "rap_123", "presence-lobby", bird.RealtimeChannelGetParams{
	Include: []bird.RealtimeChannelInclude{bird.RealtimeIncludeMemberCount},
})
if err != nil {
	log.Fatal(err)
}
fmt.Println(channel.Occupied, channel.MemberCount)

$channel = $bird->realtime->channels->get($appId, 'room-42');
echo $channel->getMemberCount(), ' members';

curl -X GET "https://us1.platform.bird.com/v1/realtime/apps/{realtime_app_id}/channels/{channel_name}" \
  -H "Authorization: Bearer $TOKEN"