Jump to Content
Channel Developers
Guides
Channel Developers

Introduction

  • Welcome to Channel
  • What is a Channel Plugin (Button)
  • What is an Event
  • What is Member Hash
  • What is a page
  • What is a canonical URL

Plugin - JavaScript

  • Installation
  • Installation Guide for Builders(English)
    • Shopify
    • Wordpress
  • Installation Guide for Builders(한국어)
    • 카페24 (Cafe24)
    • 아임웹 (Imweb)
    • 식스샵 (sixshop)
    • 고도몰 (godomall)
    • 가비아 퍼스트몰 (firstmall)
    • 워드프레스 (WordPress)
    • 쇼피파이 (shopify)
    • 메이크샵 (MakeShop)
  • Installation Guide for Builders(日本語)
    • Shopify(ショッピファイ)
    • BASE
    • カラーミーショップ
    • Wordpress
    • STUDIO
    • Goope(グーペ)
    • ペライチ
  • Installation for web view
  • Configuration
    • Content Security Policy
  • Customization
  • SDK Reference
    • ChannelIO
    • Boot Option
    • User Object
  • Browser Support

Plugin - iOS

  • Installation
  • Customization
  • Push Notification
    • Notification Extension
  • SDK Reference
  • Change logs
  • Migration

Plugin - Android

  • Installation
  • Customization
  • Push Notification
  • SDK Reference
  • Change logs
  • Migration

Plugin - React Native

  • Installation
  • Customization
  • Push Notification
  • SDK Reference
  • SDK Reference (Legacy)
    • ChannelIO
    • ChannelPluginSettings
    • ChannelEventEmitter
    • Models
  • Migration

Open API

  • What is Open API
  • Authentication
  • Bot
    • List of Bots
    • Create a Bot
    • Delete a Bot
  • UserChat
    • Get a UserChat
    • List of UserChats
    • Get a UserChat's sessions
    • Get a UserChat's messages
    • Send a message to a UserChat
    • Get a file url in a UserChat
    • Invite to a UserChat
    • Close a UserChat
    • Trash a UserChat
    • Delete a UserChat
  • Channel
    • Get a Channel
  • Group
    • Get a single Group
    • List of Groups
    • Get sessions in a Group
    • Get messages in a Group
    • Send a message to a Group
    • Get a file url in a Group
    • Update a Group
  • Manager
    • Get a single Manager
    • List of Managers
  • Marketing
    • List of Campaigns
    • Get a single Campaign
    • List of Campaign Users
    • Get a single Campaign User
    • List of OneTimeMsg
    • Get a single OneTimeMsg
    • List of OneTimeMsg Users
    • Get a single OneTimeMsg User
  • Plugin
    • Get a single Plugin
    • List of Plugins
    • Update a Plugin
  • User
    • Update a User
    • Upsert a User (By memberId)
    • Get a single User
    • Delete a User
    • Block a User
    • Unblock a User
    • Get a list of User's events
    • Create a User's UserChat
    • Get a list of User's UserChats
  • Webhook
    • Get a single Webhook
    • List of Webhooks
    • Create a Webhook
    • Update a Webhook
    • Delete a Webhook
  • Event
    • List of Events
    • Create an Event
    • Delete an Event

Webhook

  • What is Webhook
  • Getting started
  • Webhook events
  • Quick-reply for a Webhook

Snippet

  • What is Snippet
  • Snippet Flow
  • Snippet Components
    • Image
    • Text
    • Spacer
    • Button
    • KeyValue
    • List
    • Input
    • Dropdown
    • Divider
    • Timeline
  • Snippet Builder

Open API (LEGACY)

  • What is Open API
  • Authentication
  • Bots (LEGACY)
    • List of Bots
    • Create a Bot
    • Delete a Bot
  • Channel (LEGACY)
    • Get a Channel
  • Groups (LEGACY)
    • Get a single Group
    • List of Groups
    • Get sessions in a Group
    • Get messages in a Group
    • Send a message to a Group
    • Send a file to a Group
    • Get a file url in a Group
    • Update a Group
  • Managers (LEGACY)
    • Get a single Manager
    • List of Managers
  • Marketing (LEGACY)
    • List of Campaigns
    • Get a single Campaign
    • List of Campaign Users
    • Get a single Campaign User
    • List of OneTimeMsg
    • Get a single OneTimeMsg
    • List of OneTimeMsg Users
    • Get a single OneTimeMsg User
  • Plugins (LEGACY)
    • Get a single Plugin
    • List of Plugins
    • Create a Plugin
    • Update a Plugin
    • Delete a Plugin
  • UserChats (LEGACY)
    • Get a single UserChat
    • List of UserChats
    • Get a UserChat's sessions
    • Get a UserChat's messages
    • Send a message to a UserChat
    • Send a file to a UserChat
    • Get a file url in a UserChat
    • Invite to a UserChat
    • Solve a UserChat
    • Close a UserChat
    • Trash a UserChat
  • Users (LEGACY)
    • Update a User
    • Upsert a User (By memberId)
    • Upsert Bulk Users (deprecated)
    • Get a single User
    • Delete a User
    • Block a User
    • Unblock a User
    • Get a list of User's events
    • Create a User's UserChat
    • Get a list of User's UserChats
  • Webhooks (LEGACY)
    • Get a single Webhook
    • List of Webhooks
    • Create a Webhook
    • Update a Webhook
    • Delete a Webhook
  • Events (LEGACY)
    • List of Events
    • Create an Event
    • Delete an Event

Webhook (LEGACY)

  • What is Webhook
  • Getting started
  • Quick-reply for a Webhook

Add-on

  • Channel Bots

Bots (LEGACY)

Suggest Edits

❗️

This documentation is deprecated

Legacy Open API is deprecated since June 25th, 2021.
Support of these APIs will end in June 24th, 2022.
The new Open API documentation can be seen at https://api-doc.channel.io/

Open API for Bots

  • List of Bots
  • Create a Bot
  • Delete a Bot

Updated 11 months ago