LTI Pro supports creating and associating a meeting via API. A course meeting can be created programmatically via LTI Pro API and then auto-associated with an LMS course. This API is a combination of Zoom's REST API (Create meeting) and LTI Pro API (BulkImport).
This article covers:
When using this API to create and associate a meeting with a course, a calendar event will be added to the LMS if the calendar is integrated with LTI Pro.
--header 'X-Lti-Signature: H-nOALLKJOT5i56RRKE5ehCZk9A'
Note: The signature will be valid for 60 minutes.
|timestamp||String||Current timestamp when the request is created. The value is in milliseconds.|
Identifier of the LTI application that is making the request. The LTI Key value can be found on the LTI configuration page.
Note: This is a required field.
|userId*||String||User ID of the host.|
|contextId*||String||The Context ID for the course that the meeting is associated with.|
|domain*||String||The Domain used to access the LMS.|
|courseId||String||The courseId is only required to support Canvas Calendar and Conversations.|
Parameters needed to create a meeting in the Zoom web portal.
Note: For more parameters and more details, please refer to Zoom's REST API (Create meeting) request body.
|topic||String||The Meeting topic (maximum of 200 characters)|
The type of meeting:
1: An instant meeting.
2: A scheduled meeting.
3: A recurring meeting with no fixed time.
8: A recurring meeting with fixed time
The meeting's start time. This field is only used for scheduled and/or recurring meetings with a fixed time. This supports local time and GMT formats.
|duration||Integer||The meeting's scheduled duration in minutes. This field is only used for scheduled meetings.|
he timezone to assign to the start_time value. This field is only used for scheduled meetings.
For a list of supported timezones and their format, refer to our timezone list documentation.
*Note: These fields are required.
|result||Object||API response result body.|
|id||String||When a meeting is created successfully but the association fails, will return the created meeting id.|
API response error code when the status is false.
|errorMessage||String||API response error message|
The meeting was created successfully and associated successfully (HTTP Status Code - 200):
The meeting was created successfully but the association failed (HTTP Status Code - 200):
"errorMessage": "create meeting success but associate failed:The Meeting ID, Context ID or Domain is invalid(2255).",
Note: The error code 406 indicates that the meeting was successfully created in Zoom web but failed to be associated with LTI Pro.
The meeting creation failed (HTTP Status Code - 200):
"errorMessage": "User does not exist: email@example.com"
Note: In this scenario, the error code is not 406.