Bulk disassociating meetings via LTI Pro API

LTI Pro supports bulk disassociating meetings via API. These imported meetings can be disassociated(removed) from the LTI Pro courses via API if needed.

Note:

Prerequisites for bulk disassociating meetings via API

Endpoint

PUT /meeting/bulkDisassociate

Request parameters

Request header

Example header signature

--header 'X-Lti-Signature: H-nOALLKJOT5i56RRKE5ehCZk9A'
  1. The signature base string is created using query parameters:
    key=KLAIJC9OTI2Hm-vxn3UVHK&timestamp=1634769623355
  2. LTI Secret - LTI secret can be found in LTI config page. It is very important to keep these values private for your application
  3. The signature is calculated by passing the base string and secret to the HMAC-SHA1 hashing algorithm. The calculated signature is then converted to  aencodeBase64URLSafeString.
  4. Pass the value obtained from step 3 in the X-Lti-Signatureheader.

Note: The signature will be valid for 60 minutes.

Query parameters

Note: The below fields are required.

ParameterTypeDescription
timestampStringCurrent timestamp when the request is created. The value is in milliseconds.
keyStringIdentifier of the LTI application that is making the request. LTI Key value can be found in LTI config page.

Request body

LTI meeting info

Content-Type: application/json

[
{
"meetingId":"String",
"contextId":"String",
"courseId":"String",
"domain":"String"
},
{
"meetingId ":"String",
"contextId":"String",
"courseId":"String",
"domain":"String"
}
]

Request body if using the account admin userId

Content-Type: application/json

{ 
"userId": "String",
"meetingList":
[
{

"meetingId":"String"
"contextId":"String"
"courseId":"String"
"domain":"String"
},
{
"meetingId ":"String"
"contextId":"String"
"courseId":"String"
"domain":"String"
}
]

}

Example

[
{
"meetingId": "0123456789",
"contextId": "sjaldjfjdkdlsj",
"courseId": "Sample CourseID",
"domain": "https://somelmsdomain.com"
}
]

Schema

ParameterTypeDescription
meetingId*StringThe meeting ID of the meeting you are disassociating from a course.
contextId*StringThe Context ID for the course that the meeting is associated with.
domain*StringThe Domain used to access the LMS.
courseId**StringThe courseId is only required to support Canvas Calendar and Conversations.
userId***StringUser Id of the Zoom user. This user needs to be an Admin role in order to run the API.
meetingList***StringList of LTI Meeting Info

*Note: This field is required.

**Note: This is only required in order to support Canvas Calendar and Conversations.

**Note: If a specific user is needed to create the calendar event within the LMS, the userId should be added to the request body. In addition,  meetingList should be utilized as seen in the second request example above.

{
"type": "object",
"properties": {
"meetingId": {
"type": "string",
"description": "The meeting ID of the meeting you are disassociating from a course."
},
"contextId": {
"type": "string",
"description": "The Context ID for the course that the meeting is associated with."
},
"domain": {
"type": "string",
"description": "The Domain used to access the LMS."
},
"courseId": {
"type": "string",
"description": "The courseId is only required to support Canvas Calendar and Conversations."
}
},
"required": [
"meetingId",
"contextId",
"domain"
]
}

Responses

200

{
"status": true,
"result": "Processing Bulk Disassociate"
}

401

{
"status": false,
"errorCode": "401"
}

How to retrieve the userID from LTI Pro

  1. Login LMS and launch LTI pro with Developer Tool.
    Note: The user must be a Zoom user.
  2. Click on the Network tab.
  3. In the search bar for the developer tools, search for user/settings/all.
  4. Click the only API under the Name.
  5. Click Preview.
    The UserId will be in the result.