Create / Delete Channel

1. Create Channel

You need to create a channel in order to chat.

• You can enter up to 5 key-value pairs in data field. The maximum size of key is 128 characters and the maximum size of value is 1024 characters. Both key and value must be strings.

• Supported channel types are as follows: private, public, invitationOnly, broadcast, super_broadcast, super_private and super_public.

• type field is required.

• invitationCode field is required for invitationOnly channel type.

• If hideMessagesBeforeJoin parameter is set to true, members who join the channel will not be able to see messages from before the time they join.

Type	Value	Can Join Channel	FCM Support
PRIVATE	private	X	O
PUBLIC	public	O	O
INVITATION ONLY	invitationOnly	O (need invitation code)	O
BROADCAST	broadcast	O	O
SUPER_BROADCAST	super_broadcast	O	X
SUPER_PRIVATE	super_private	X	X
SUPER_PUBLIC	super_public	O	X

• For private channel, setting reuseChannel to true allows you to reuse existing channel if channel ID and member IDs match those of existing channel and members. This feature is useful when implementing 1:1 chat.

• Anyone can join a public channel, except for banned users.

• For invitationOnly channel, invitationCode field is required.

• Only users with valid invitationCode can join an invitationOnly channel.

• For broadcast and super_broadcast channel:

  • When the channel owner sends a message, the message is sent to all channel members.

  • When a channel member sends a message, the message is sent only to the channel owner.

• For super_broadcast, super_private and super_public channel:

  • You can set the maximum number of members above 100.

  • Set the maximum member limit to -1 allows unlimited members.

  • super channel returns empty members , bannedUsers and mutedUsers fields

  • unreadCount, invitationCode, lastReadAt fields are not supported.

  • FCM push notifications are not sent since there can be too many users and notifications.

await client.createChannel({
      channelId: 'my_private_channel', // required
      name: 'my_private_channel', // optional
      type: 'private', // required
      members: ['my_user_id', 'another_user_id'], // optional. Current user(owner) added by default.
      invitationCode: 'secret invitation code', // required only for 'invitationOnly' channel type
      reuseChannel: true, // default: false
      imageUrl : 'image URL', // optional
      maxMemberCount: 10, // optional. default 100
      hideMessagesBeforeJoin: true, // if true, users cannot see messages older than their channel join date
      category: 'category 1', // optional. can be used for grouping/searching channels
      subcategory: 'subcategory 2', // optional. can be used for grouping/searching channels
      data: { // optional
        someMetaKey1: "someMetaValue1",
        someMetaKey2: "someMetaValue2",
      },
    });

Response

non-super channel

{
  "channel": {
    "id": "my_private_channel",
    "name": "my_private_channel",
    "ownerId": "user123",
    "pushNotificationDisabled": false,
    "imageUrl": "image url",
    "data": {
      "someMetaKey1": "someMetaValue1",
      "someMetaKey2": "someMetaValue2"
    },
    "type": "private",
    "invitationCode": "",
    "isFrozen": false,
    "memberCount": 2,
    "maxMemberCount": 10,
    "hideMessagesBeforeJoin": true,
    "category": "test",
    "subcategory": "",
    "privateTag": "",
    "privateData": "",
    "mutedUsers": [],
    "members": [
      {
        "id": "user123",
        "username": "john",
        "profileImageUrl": "http://cnd.test.com/123.jpg",
        "updatedAt": 1603244896634,
        "createdAt": 1603184094285,
        "lastReadAt": 1603244933412,
        "lastSentAt": 1603244933412
      },
      {
        "id": "another_user_id",
        "username": "another_user_id",
        "profileImageUrl": "http://cnd.test.com/another_user.jpg",
        "updatedAt": 1603244410844,
        "createdAt": 1603244410844,
        "lastReadAt": 1603244933412,
        "lastSentAt": 1603244933412
      }
    ],
    "bannedUsers": [],
    "bots": [],
    "updatedAt": 0,
    "pushNotificationDisabled": false,
    "pushNotificationSoundAOS": "",
    "pushNotificationSoundIOS": "",
    "createdAt": 0,
    "unreadCount": 0,
    "lastReadAt": 0,
    "lastMessage": null
  }
}

super channel

{
  "channel": {
    "id": "my_private_channel",
    "name": "my_private_channel",
    "ownerId": "user123",
    "pushNotificationDisabled": false,
    "imageUrl": "image url",
    "data": {
      "someMetaKey1": "someMetaValue1",
      "someMetaKey2": "someMetaValue2"
    },
    "type": "private",
    "invitationCode": "",
    "isFrozen": false,
    "memberCount": 2,
    "maxMemberCount": 10,
    "hideMessagesBeforeJoin": true,
    "category": "test",
    "subcategory": "",
    "privateTag": "",
    "privateData": "",
    "mutedUsers": [], // this field is empty for super channel types
    "members": [], // this field is empty for super channel types
    "bannedUsers": [], // this field is empty for super channel types
    "bots": [],
    "updatedAt": 0,
    "createdAt": 0,
    "unreadCount": 0,
    "lastReadAt": 0,
    "lastMessage": null
  }
}

2. Delete Channel

Only the channel owner can delete channel.

await client.deleteChannel({channelId: 'my_private_channel'});