List Realtime channels

GET

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

const { data } = await bird.realtime.channels.list("rap_01krdgeqcxet5s7t44vh8rt9mg", {
  prefix: "presence-",
  include: ["member_count"],
});
for (const channel of data) console.log(channel.name, channel.member_count);

channels = client.realtime.channels.list(
    "rap_01krdgeqcxet5s7t44vh8rt9mg", prefix="presence-", include=["member_count"]
)
for channel in channels.data:
    print(channel.name, channel.member_count)

channels, err := client.Realtime.Channels.List(context.Background(), "rap_123", bird.RealtimeChannelListParams{
	Prefix:  "presence-",
	Include: []bird.RealtimeChannelInclude{bird.RealtimeIncludeMemberCount},
})
if err != nil {
	log.Fatal(err)
}
for _, ch := range channels.Data {
	fmt.Println(ch.Name, ch.MemberCount)
}

foreach ($bird->realtime->channels->list($appId, ['prefix' => 'room-'])->getData() ?? [] as $channel) {
    echo $channel->getName(), ' ', $channel->getMemberCount(), "\n";
}

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

响应200

{
  "data": [
    {
      "name": "orders-42"
    }
  ]
}

Lists the app's currently occupied channels, optionally filtered by name prefix.

参数

realtime_app_id

string

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

查询参数

prefix

string

Only channels whose name starts with this prefix (for example, presence-).

include

array

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

响应载荷

data

array of object

必填

The occupied channels, sorted by name.

显示子属性

data.member_count

integer

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

data.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.

data.name

string

必填

A Realtime channel name. Only letters, digits, and _ - = @ , . ; Prefix with private- or presence- for authenticated channels, or private-encrypted- for channels whose payloads are end-to-end encrypted with a key only you hold.

Related resources

Continue with the documentation, guides and examples for this topic. Resources are in English.

Explore the capabilityRealtime Follow the learning pathBuild your first integration Implementation guideSend your first realtime event

Try the practice and get an implementation brief

const { data } = await bird.realtime.channels.list("rap_01krdgeqcxet5s7t44vh8rt9mg", {
  prefix: "presence-",
  include: ["member_count"],
});
for (const channel of data) console.log(channel.name, channel.member_count);

channels = client.realtime.channels.list(
    "rap_01krdgeqcxet5s7t44vh8rt9mg", prefix="presence-", include=["member_count"]
)
for channel in channels.data:
    print(channel.name, channel.member_count)

channels, err := client.Realtime.Channels.List(context.Background(), "rap_123", bird.RealtimeChannelListParams{
	Prefix:  "presence-",
	Include: []bird.RealtimeChannelInclude{bird.RealtimeIncludeMemberCount},
})
if err != nil {
	log.Fatal(err)
}
for _, ch := range channels.Data {
	fmt.Println(ch.Name, ch.MemberCount)
}

foreach ($bird->realtime->channels->list($appId, ['prefix' => 'room-'])->getData() ?? [] as $channel) {
    echo $channel->getName(), ' ', $channel->getMemberCount(), "\n";
}

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

响应200

{
  "data": [
    {
      "name": "orders-42"
    }
  ]
}