Category
Open API
Open API
What is Open API
The Channel Open API allows third party developers to build applications that interact with Channel in more complex ways than the integrations we currently provide. By using the API, developers can freely build sophisticated interactions and seamless pipelines with Channel, for example, a chatbot that automatically responds to a customer when a condition has met. The official documentation can be found at https://api-doc.channel.io/. Feel free to contact the developers about the documents.
Upcoming changes to Open API (23/12/15 ~)
We would like to inform you of changes to the Open API model schema as the BM reorganization is in progress as of December 15, 2023. As of December 15th, the following fields will no longer be supported or will be replaced. Channel - trialSystemUsed (to be deleted) - servicePlan (to be deleted) - features (to be deleted) - billingPeriod (to be deleted) - billingDay (to be deleted) - stopRenewal (to be deleted) - trialCouponId (to be deleted) - trialReservation (to be deleted) - mau (to be delete
Authentication
All Open APIs require authentication. Getting credentials On Channel Desk, go to Settings and API Key management, and then click on Create new credential. Give a name to your API credential and press okay. That's it, you just created your first API credentials which contains a set of Access Key and Access Secret. Test your API credentials You can test the newly created credentials here. Simply insert two keys into the fields on top of the navigation bar and click Explore. You are now ready to ex
Rate Limiting
All Open APIs are subject to the rate limiting policy. API requests from a Channel are throttled if too many requests were received in a short time window, and will result in HTTP status 429 Too Many Requests. Different APIs may have different rate limiting constraints. Checking a request’s rate limit status The response HTTP headers of an Open API request describe the (expected) result of your requests. curl -i https://api.channel.io/open/v5/... > HTTP/2 200 > x-ratelimit-limit: 1000 > x-rateli
Bot
Bot3 articles
UserChat
UserChat9 articles
Channel
Channel1 articles
Group
Group7 articles
Manager
Manager2 articles
Marketing
Marketing8 articles
Plugin
Plugin3 articles
User
User9 articles
Webhook
Webhook5 articles
Event
Event3 articles
Redirection
Redirection1 articles