LMS Integration API
XML + checksum at /lms/v1/api/*. Primary path for Moodle and Canvas plugins.
API reference
Two integrator surfaces — pick the one your LMS or backend already speaks.
JSON API (LMS v1)
HMAC-signed REST at /lms/v1/meetings. Optional for custom backends.
Comparison
| LMS wire | JSON API | |
|---|---|---|
| Format | XML query + checksum | JSON + HMAC headers |
| Best for | Moodle, Canvas, virtual-classroom LMS modules | Your SaaS backend |
| Join result | Redirect URL | moderator_join_url / attendee_join_url |
| Spec | HTML reference | OpenAPI YAML |
Session cover & branding (optional)
On create, pass image URLs: cover_url (stage) and org.logo_url (header logo). Wire: meta_cover_url / meta_org_logo_url. See JSON create.
Attendance report
HMAC pull: GET /lms/v1/meetings/{external_id}/report — aggregates all occurrences for that LMS id. Details: Attendance report.
Core services
- Create meeting —
create - Join meeting —
join(passuserIDfor attendance) - End meeting —
end - Recordings —
getRecordings,deleteRecordings - Attendance report — JSON
GET /meetings/{id}/report
Shared concepts
- Hostname includes your reseller slug:
{slug}.2meet.ir - Integration Secret from partner portal signs all requests
- Server URL for LMS plugins:
https://{slug}.2meet.ir/lms/v1/
Before you integrate
Complete Getting started and keep portal credentials handy.