API
The API add-on opens the room WebSocket Client API. Your software joins like a presenter with a clicker: it changes slides, runs the presenter timer, moves the laser dot and sends messages to the host.
What you get
Slide control
Next and previous, plus first, last, go to a slide and blackout where the presentation app supports them.
Timer control
Start, stop, reset, add or take away 1, 2 or 5 minutes, presets of 5 to 20 minutes, or set any time up to 999 minutes.
Laser dot
Move the laser dot on the host's shared screen.
Messages to the host
Send a note of up to 1000 characters.
Plans
| Plan | API |
|---|---|
| Pro, Ultra | Buy the add-on |
| Studio, Enterprise | Included |
There is no app screen for it. You use it from your own code.
Buy it
Open the add-on page
Sign in, then open https://cliqer.io/addons/api.
Pick a term
Week, month, year or one time. Year is selected by default.
Check out
Every seat on the licence gets the API. See Billing per seat.
Use it
Check the licence
The host's licence needs the API add-on, or Studio or Enterprise.
Connect
Connect to the room as described in WebSocket.
Send commands
Send slide, timer, pointer and message commands. For timer commands, the host must allow clicks from your connection.
api_not_in_plan.Limits
| What | Limit |
|---|---|
| Slide and timer commands | 10 per second |
| Messages | 5 per 10 seconds |
| Pointer moves | 30 per second |
| Message length | 1000 characters |
Over a limit, the socket replies rate_limited.
FAQ
The host's licence. Your software only needs a session token for that room.
No. Team API keys work on the REST endpoints only.
The host must allow clicks from your connection, and the host's licence must include the API.