API ও ওয়েবহুক
API কী ও স্কোপ, Authorization হেডার, meetings ও recordings রুট, রেট লিমিট, ওয়েবহুক ইভেন্ট, আর সিগনেচার যাচাই।
AIOMeeting has a REST API under /api/v1/ and signed webhooks. Use them to create meetings from your own system, list recordings, or react to events.
1. Who can use it
A member needs a package with API access (Pro and above by default), unless the setting "API access needs a package with API access" is switched off in the admin panel. Each member can hold up to 5 API keys (configurable).
2. Getting a key
- Sign in on the site and open API Keys in the member menu.
- Give it a name, choose the scopes it may use, then press Make the key.
- Optionally set a rate limit, allowed IP addresses and an expiry date.
- Copy the key now. It looks like
am_xxxxxxxx.... It is shown once and only a hash is stored.
Staff see every key (without the secret) under Developers, API Keys and can disable one. Developers, API Monitor shows calls, errors and response times, and the request log.
3. Calling the API
Send the key in the Authorization header (or in X-API-Key):
curl -H "Authorization: Bearer am_YOUR_KEY" https://your-domain/api/v1/meetings
Answers are JSON. A success looks like {"ok": true, "data": ...}. An error has {"ok": false, "error": "..."} and an HTTP status such as 400, 401, 403, 404 or 429. Send POST and PATCH bodies as JSON with Content-Type: application/json.
The root GET /api/v1/ lists every route you can use with your key.
4. Scopes
| Scope | Allows |
|---|---|
meetings | Create, list, update and delete meetings |
recordings | List and delete recordings |
read | The member's package and orders |
webhooks | Add, remove and test webhook endpoints |
5. Meeting routes
| Route | What it does |
|---|---|
GET /meetings | Your meetings. Query: filter (upcoming, previous, pmi, recurring, all), limit (1 to 100), offset. |
POST /meetings | Create a meeting. Fields: title, agenda, kind (instant, scheduled, recurring, pmi, webinar), starts_at, timezone, duration_min, passcode, waiting_room, join_before_host, mute_on_entry, host_video, participant_video, screen_share, chat, recording, auto_record, recurrence, registration. |
GET /meetings/{id} | One meeting and its invitation text. |
PATCH /meetings/{id} | Change a meeting. Send only the fields to change. |
DELETE /meetings/{id} | Delete a meeting. |
POST /meetings/{id}/end | End a live meeting. |
GET /meetings/{id}/sessions | The sessions of a meeting. |
A meeting in an answer has: id, code, title, agenda, kind, status, timezone, starts_at, next_start_at, duration_min, passcode, waiting_room, join_before_host, mute_on_entry, recurrence, join_url, live_count, total_sessions and created_at.
Example, create a scheduled meeting:
curl -X POST https://your-domain/api/v1/meetings \
-H "Authorization: Bearer am_YOUR_KEY" \
-H "Content-Type: application/json" \
-d '{"title":"Weekly sync","kind":"scheduled","starts_at":"2026-12-01T10:00","timezone":"Asia/Dhaka","duration_min":45}'
The same package limits apply as on the site: a Basic host cannot create a 3-hour meeting.
6. Recording routes
| Route | What it does |
|---|---|
GET /recordings | Your cloud recordings with id, title, meeting_id, status, bytes, seconds, public, url and created_at. Query: limit, offset. |
DELETE /recordings/{id} | Delete a recording and its file. |
7. Other routes
GET /membershipreturns the member's package, its features, status and period end.GET /orderslists orders. Querystatusis open, closed or all.GET /eventsis public and lists the webhook event types.GET /webhooks,POST /webhook-create,POST /webhook-delete/{id}andPOST /webhook-ping/{id}manage webhook endpoints.
8. Limits
- With a key: 120 calls per minute by default, or the limit set on the key.
- Without a key (public routes): 30 calls per minute per IP address.
- Over the limit the API answers 429 with "Rate limit reached."
The admin can change both numbers under the API settings.
9. Webhooks
A webhook sends an HTTP POST to your URL when something happens.
| Event | When |
|---|---|
meeting.started | A session of a meeting starts |
meeting.ended | A session ends |
participant.joined | Someone enters the room |
participant.left | Someone leaves |
recording.ready | A cloud recording finished |
Add an endpoint under Webhooks in the member menu, or with POST /webhook-create (fields url, events and description). The secret is shown once.
Verifying a delivery
Each request has two headers:
X-AIOM-Timestamp: a Unix timestamp.X-AIOM-Signature:sha256=followed by the HMAC-SHA256 oftimestamp + "." + body, keyed with your secret.
Compute the same value and compare with a constant-time function. Reject requests whose timestamp is older than a few minutes.
$ts = $_SERVER['HTTP_X_AIOM_TIMESTAMP'] ?? '';
$sig = $_SERVER['HTTP_X_AIOM_SIGNATURE'] ?? '';
$body = file_get_contents('php://input');
$calc = 'sha256=' . hash_hmac('sha256', $ts . '.' . $body, $secret);
if (!hash_equals($calc, $sig)) { http_response_code(401); exit; }
Answer with a 2xx status within a few seconds. Failures are retried by the cron and counted. Too many failures disable the endpoint. Staff can see and re-send deliveries under Developers, Webhooks, and members can press Ping to test.