Chilkat Online Tools

phpExt / Zoom API / Create webinar's invite links

Back to Collection Items

<?php

include("chilkat_9_5_0.php");

// This example assumes the Chilkat API to have been previously unlocked.
// See Global Unlock Sample for sample code.

$http = new CkHttp();

$req = new CkHttpRequest();
$req->put_HttpVerb('POST');
$req->put_Path('/v2/webinars/:webinarId/invite_links');
$req->put_ContentType('multipart/form-data');
$req->AddParam('ttl','7200');

$req->AddParam('attendees','7200[{\'name\':\'re\'},{\'name\':\'nisi sunt \'}]');

$req->AddHeader('Authorization','Bearer <access_token>');

// resp is a CkHttpResponse
$resp = $http->SynchronousRequest('api.zoom.us',443,true,$req);
if ($http->get_LastMethodSuccess() == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

$sbResponseBody = new CkStringBuilder();
$resp->GetBodySb($sbResponseBody);

$jResp = new CkJsonObject();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(false);

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $resp->get_StatusCode();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->header() . "\n";
    print 'Failed.' . "\n";

    exit;
}

// 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

$i = 0;
$count_i = $jResp->SizeOfArray('attendees');
while ($i < $count_i) {
    $jResp->put_I($i);
    $name = $jResp->stringOf('attendees[i].name');
    $join_url = $jResp->stringOf('attendees[i].join_url');
    $i = $i + 1;
}


?>

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": ""
    }
  ]
}