SEsendbird
Open channel

Create an open channel

Changed on

Create an open channel

You can create an open channel that facilitates conversations for millions of users. Open channels allow a seamless chat experience possible for all participants by using dynamic partitioning which creates subchannels that each handle up to tens of thousands of participants.

Because users don't need invitations to join open channels, short-lived live events like concerts or live streams that don't require a sustained membership are good use cases for open channels.

https://sendbird.com/docs/chat/v3/platform-api/guides/open-channel#2-create-a-channel

post/v3/open_channels

Request

  • Base URL
    https://api-APP_ID.sendbird.com
  • Auth
    none declared

Headers

api-tokenstring
Example:{{API_TOKEN}}

Request body

is_dynamic_partitionedboolean
channel_urlstring
cover_filestring binary
cover_urlstring
custom_typestring
datastring
is_ephemeralboolean
namestring
operator_idsstring[]

Response

Successful response

channel_urlstring required
cover_urlstring
created_atinteger
custom_typestring
datastring
freezeboolean
is_dynamic_partitionedboolean
is_ephemeralboolean
max_length_messageinteger
namestring
participant_countinteger
metadataobject nullable

Example response

{
  "cover_url": "cover_url",
  "metadata": "{}",
  "data": "data",
  "custom_type": "custom_type",
  "is_ephemeral": true,
  "created_at": 0,
  "is_dynamic_partitioned": true,
  "channel_url": "channel_url",
  "freeze": true,
  "participant_count": 1,
  "operators": [
    {
      "metadata": "{}",
      "require_auth_for_profile_image": true,
      "is_active": true,
      "role": "",
      "user_id": "user_id",
      "profile_url": "profile_url",
      "nickname": "nickname",
      "is_blocked_by_me": true
    },
    {
      "metadata": "{}",
      "require_auth_for_profile_image": true,
      "is_active": true,
      "role": "",
      "user_id": "user_id",
      "profile_url": "profile_url",
      "nickname": "nickname",
      "is_blocked_by_me": true
    }
  ],
  "max_length_message": 6,
  "name": "name"
}

Changes

  • 7a85bad03e90Revision changes
    • warning

      deleted the header request parameter Api-Token

    • warning

      removed the request property

    • warning

      removed the request property

    • info

      api operation id ocCreateChannel removed and replaced with createAnOpenChannel

    • info

      added the new optional header request parameter api-token

    • info

      added the new optional request property

  • 135d8b0705d4Revision changes
    • info

      the header request parameter Api-Token became optional