Channel Groups API for PubNub PHP SDK
Channel Groups allows PubNub developers to bundle thousands of channels into a group that can be identified by name. These Channel Groups can then be subscribed to, receiving data from the many back-end channels the channel group contains.
Learn more about our Channel Groups here.
Channel Group operations
You can't publish to a Channel Group. You can only subscribe to it. To publish within Channel Group, you need to publish to each channel individually.
Adding Channels
Requires Stream Controller add-on
This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.
Description
This function adds a channel to a channel group.
Method(s)
Adding Channels
is accomplished by using the following method(s) in the PHP V4 SDK:
Maximum number of channels
200 channels
can be added to the channel group
per API call.
$pubnub->addChannelToChannelGroup()->channels(string|array)->channelGroup(string)->sync();
Parameter | Type | Required | Description |
---|---|---|---|
channels | String|Array | Yes | The channels to add to the channel group. |
channelGroup | String | Yes | The channelGroup to add the channels to. |
Basic Usage
Adding Channels
$pubnub->addChannelToChannelGroup()
->channels(["ch1", "ch2"])
->channelGroup("cg1")
->sync();
Rest Response from Server
{
"service" : "channel-registry",
"status" : 200,
"error" : false,
"message" : "OK"
}
Listing Channels
Requires Stream Controller add-on
This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.
Description
This function lists all the channels of the channel group.
Method(s)
Listing Channels
is accomplished by using the following method(s) in the PHP V4 SDK:
$pubnub->listChannelsInChannelGroup()->channelGroup(string)->sync();
Parameter | Type | Required | Description |
---|---|---|---|
channelGroup | String | Yes | The channel group to fetch channels. |
Basic Usage
Listing Channels
$pubnub->listChannelsInChannelGroup()
->channelGroup("cg1")
->sync();
Rest Response from Server
{
"status" : 200,
"payload" : {
"channels" : ["hi"],
"group" : "abcd"
},
"service" : "channel-registry",
"error" : False
}
Removing Channels
Requires Stream Controller add-on
This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.
Description
This function removes the channels from the channel group.
Method(s)
Removing Channels
is accomplished by using the following method(s) in the PHP V4 SDK:
$pubnub->removeChannelFromChannelGroup()->channels(string|array)->channelGroup(string)->sync();
Parameter | Type | Required | Description |
---|---|---|---|
channels | String|Array | Yes | channels to remove from the channel group. |
channelGroup | String | Yes | Specifies ChannelGroup to remove. |
Basic Usage
Removing channels
$pubnub->removeChannelFromChannelGroup()
->channels("son")
->channelGroup("family")
->sync();
Rest Response from Server
{
"status" : 200,
"message" : "OK",
"service" : "channel-registry",
"error" : False
}
Deleting Channel Group
Requires Stream Controller add-on
This method requires that the Stream Controller add-on is enabled for your key in the Admin Portal. Read the support page on enabling add-on features on your keys.
Description
This function removes the channel group.
Method(s)
Deleting Channel Group
is accomplished by using the following method(s) in the PHP V4 SDK:
$pubnub->removeChannelGroup()->channelGroup(string)->sync();
Parameter | Type | Required | Description |
---|---|---|---|
channelGroup | String | Yes | The channelGroup to remove. |
Basic Usage
Deleting Channel Group
$pubnub->removeChannelGroup()
->channelGroup("family")
->sync();
Rest Response from Server
{
"status" : 200,
"message" : "OK",
"service" : "channel-registry",
"error" : False
}