TCL / Zoom API / Create webinar's invite links
Back to Collection Items
load ./chilkat.dll
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
set http [new_CkHttp]
set req [new_CkHttpRequest]
CkHttpRequest_put_HttpVerb $req "POST"
CkHttpRequest_put_Path $req "/v2/webinars/:webinarId/invite_links"
CkHttpRequest_put_ContentType $req "multipart/form-data"
CkHttpRequest_AddParam $req "ttl" "7200"
CkHttpRequest_AddParam $req "attendees" "7200[{\"name\":\"re\"},{\"name\":\"nisi sunt \"}]"
CkHttpRequest_AddHeader $req "Authorization" "Bearer <access_token>"
# resp is a CkHttpResponse
set resp [CkHttp_SynchronousRequest $http "api.zoom.us" 443 1 $req]
if {[CkHttp_get_LastMethodSuccess $http] == 0} then {
puts [CkHttp_lastErrorText $http]
delete_CkHttp $http
delete_CkHttpRequest $req
exit
}
set sbResponseBody [new_CkStringBuilder]
CkHttpResponse_GetBodySb $resp $sbResponseBody
set jResp [new_CkJsonObject]
CkJsonObject_LoadSb $jResp $sbResponseBody
CkJsonObject_put_EmitCompact $jResp 0
puts "Response Body:"
puts [CkJsonObject_emit $jResp]
set respStatusCode [CkHttpResponse_get_StatusCode $resp]
puts "Response Status Code = $respStatusCode"
if {$respStatusCode >= 400} then {
puts "Response Header:"
puts [CkHttpResponse_header $resp]
puts "Failed."
delete_CkHttpResponse $resp
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
exit
}
delete_CkHttpResponse $resp
# Sample JSON response:
# (Sample code for parsing the JSON response is shown below)
# {
# "attendees": [
# {
# "name": "Mike Brown",
# "join_url": "https://zoom.us/j/935364234?wp=9a84R6-YFwCCP04ss8PwwImO-3Rm9HSM0RwPn3Ll05WGBEJJDI21846QS-nJuNs7JKcwHTG2VoILGWJkljPTKw.tRxEV0sF4mEBkAaE"
# }
# ]
# }
# Sample code for parsing the JSON response...
# Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
set i 0
set count_i [CkJsonObject_SizeOfArray $jResp "attendees"]
while {$i < $count_i} {
CkJsonObject_put_I $jResp $i
set name [CkJsonObject_stringOf $jResp "attendees[i].name"]
set join_url [CkJsonObject_stringOf $jResp "attendees[i].join_url"]
set i [expr $i + 1]
}
delete_CkHttp $http
delete_CkHttpRequest $req
delete_CkStringBuilder $sbResponseBody
delete_CkJsonObject $jResp
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'ttl=7200'
--form 'attendees=7200[{"name":"re"},{"name":"nisi sunt "}]'
https://api.zoom.us/v2/webinars/:webinarId/invite_links
Postman Collection Item JSON
{
"name": "Create webinar's invite links",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "ttl",
"value": "7200",
"description": "undefined",
"type": "text"
},
{
"key": "attendees",
"value": "[{\"name\":\"re\"},{\"name\":\"nisi sunt \"}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/invite_links",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"invite_links"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
},
"description": "Use this API to create a batch of invitation links for a webinar.\n\n**Scopes**: `webinar:write:admin`, `webinar:write`</br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n\n**Prerequisites:**\n\n* Business, Education or API Plan with Webinar add-on."
},
"response": [
{
"name": "**HTTP Status Code:** `201` <br>\nWebinar Invite Links Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "ttl",
"value": "7200",
"description": "undefined",
"type": "text"
},
{
"key": "attendees",
"value": "[{\"name\":\"velit incididunt non Lorem\"},{\"name\":\"i\"}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/invite_links",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"invite_links"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Location",
"value": "quis officia in reprehenderit",
"description": "The location of the created webinar invite links."
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"attendees\": [\n {\n \"name\": \"Mike Brown\",\n \"join_url\": \"https://zoom.us/j/935364234?wp=9a84R6-YFwCCP04ss8PwwImO-3Rm9HSM0RwPn3Ll05WGBEJJDI21846QS-nJuNs7JKcwHTG2VoILGWJkljPTKw.tRxEV0sF4mEBkAaE\"\n }\n ]\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br>\n**Error Code:** `300`<br>\n* Webinar Id does not exist.<br>\n* Invalid Webinar Id.<br>\n**Error Code:** `3001` Webinar does not exist: {webinarId}.<br>\n**Error Code:** `1001` User does not exist: {userId}.<br>\n",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "ttl",
"value": "7200",
"description": "undefined",
"type": "text"
},
{
"key": "attendees",
"value": "[{\"name\":\"velit incididunt non Lorem\"},{\"name\":\"i\"}]",
"description": "undefined",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/webinars/:webinarId/invite_links",
"host": [
"{{baseUrl}}"
],
"path": [
"webinars",
":webinarId",
"invite_links"
],
"variable": [
{
"key": "webinarId",
"value": "68423085",
"description": "(Required) The webinar's ID."
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}