Chilkat Online Tools

phpExt / Zoom API / Get a meeting registrant

Back to Collection Items

<?php

include("chilkat.php");
// Use "chilkat_9_5_0.php" for versions of Chilkat < 10.0.0

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

$http = new CkHttp();

// Adds the "Authorization: Bearer <access_token>" header.
$http->put_AuthToken('<access_token>');

$sbResponseBody = new CkStringBuilder();
$success = $http->QuickGetSb('https://api.zoom.us/v2/meetings/:meetingId/registrants/:registrantId',$sbResponseBody);
if ($success == false) {
    print $http->lastErrorText() . "\n";
    exit;
}

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

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

$respStatusCode = $http->get_LastStatus();
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->lastHeader() . "\n";
    print 'Failed.' . "\n";
    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "id": "24000002122",
//   "email": "example@example.com",
//   "first_name": "Jill",
//   "last_name": "Chill",
//   "address": "1800 Amphibious Blvd.",
//   "city": "Mountain View",
//   "country": "US",
//   "zip": "94045",
//   "state": "CA",
//   "phone": "5550100",
//   "industry": "Food",
//   "org": "Cooking Org",
//   "job_title": "Chef",
//   "purchasing_time_frame": "1-3 months",
//   "role_in_purchase_process": "Influencer",
//   "no_of_employees": "10",
//   "comments": "Looking forward to the Meeting",
//   "custom_questions": [
//     {
//       "title": "What do you hope to learn from this Meeting?",
//       "value": "Look forward to learning how you come up with new recipes and what other services you offer."
//     }
//   ],
//   "status": "approved",
//   "create_time": "2021-07-29T08:06:15Z",
//   "join_url": "https://zoom.us/w/93996867430?tk=xK1MkXXQmkGWEaGvJ5BrbQ4Xc1FhUt90CUH5qI3Ko2E.DQUAAAAV4qZfZhZ5dm1pRVQ0NVRSVzBfSUpyRlpybllBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&pwd=M35SOl_x90Gq8VR10a4BroJCx5OMoK.1"
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

$id = $jResp->stringOf('id');
$email = $jResp->stringOf('email');
$first_name = $jResp->stringOf('first_name');
$last_name = $jResp->stringOf('last_name');
$address = $jResp->stringOf('address');
$city = $jResp->stringOf('city');
$country = $jResp->stringOf('country');
$zip = $jResp->stringOf('zip');
$state = $jResp->stringOf('state');
$phone = $jResp->stringOf('phone');
$industry = $jResp->stringOf('industry');
$org = $jResp->stringOf('org');
$job_title = $jResp->stringOf('job_title');
$purchasing_time_frame = $jResp->stringOf('purchasing_time_frame');
$role_in_purchase_process = $jResp->stringOf('role_in_purchase_process');
$no_of_employees = $jResp->stringOf('no_of_employees');
$comments = $jResp->stringOf('comments');
$status = $jResp->stringOf('status');
$create_time = $jResp->stringOf('create_time');
$join_url = $jResp->stringOf('join_url');
$i = 0;
$count_i = $jResp->SizeOfArray('custom_questions');
while ($i < $count_i) {
    $jResp->put_I($i);
    $title = $jResp->stringOf('custom_questions[i].title');
    $value = $jResp->stringOf('custom_questions[i].value');
    $i = $i + 1;
}


?>

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/meetings/:meetingId/registrants/:registrantId

Postman Collection Item JSON

{
  "name": "Get a meeting registrant",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/meetings/:meetingId/registrants/:registrantId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "meetings",
        ":meetingId",
        "registrants",
        ":registrantId"
      ],
      "variable": [
        {
          "key": "meetingId",
          "value": "68423085",
          "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
        },
        {
          "key": "registrantId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The registrant ID."
        }
      ]
    },
    "description": "Use this API to get details on a specific user who has registered for the meeting. A host or a user with administrative permissions can require [registration for Zoom meetings](https://support.zoom.us/hc/en-us/articles/211579443-Registration-for-Meetings).\n\n**Scopes:** `meeting:read:admin`, `meeting:read`<br>**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`\n\n**Prerequisites:** \n* The account must have a Meeting plan"
  },
  "response": [
    {
      "name": "Success.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/registrants/:registrantId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "registrants",
            ":registrantId"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
            },
            {
              "key": "registrantId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The registrant ID."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"id\": \"24000002122\",\n \"email\": \"example@example.com\",\n \"first_name\": \"Jill\",\n \"last_name\": \"Chill\",\n \"address\": \"1800 Amphibious Blvd.\",\n \"city\": \"Mountain View\",\n \"country\": \"US\",\n \"zip\": \"94045\",\n \"state\": \"CA\",\n \"phone\": \"5550100\",\n \"industry\": \"Food\",\n \"org\": \"Cooking Org\",\n \"job_title\": \"Chef\",\n \"purchasing_time_frame\": \"1-3 months\",\n \"role_in_purchase_process\": \"Influencer\",\n \"no_of_employees\": \"10\",\n \"comments\": \"Looking forward to the Meeting\",\n \"custom_questions\": [\n  {\n   \"title\": \"What do you hope to learn from this Meeting?\",\n   \"value\": \"Look forward to learning how you come up with new recipes and what other services you offer.\"\n  }\n ],\n \"status\": \"approved\",\n \"create_time\": \"2021-07-29T08:06:15Z\",\n \"join_url\": \"https://zoom.us/w/93996867430?tk=xK1MkXXQmkGWEaGvJ5BrbQ4Xc1FhUt90CUH5qI3Ko2E.DQUAAAAV4qZfZhZ5dm1pRVQ0NVRSVzBfSUpyRlpybllBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA&pwd=M35SOl_x90Gq8VR10a4BroJCx5OMoK.1\"\n}"
    },
    {
      "name": "**Error Code:** `300`<br>Meeting \"{meetingId}\" is not valid or has expired.\nThis meeting has not set required registration: \"{meetingId}\"",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/registrants/:registrantId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "registrants",
            ":registrantId"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
            },
            {
              "key": "registrantId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The registrant ID."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400`<br>**Error Code:** `1010`\nUser does not belong to this account: \"{accountId}\"<br>**Error Code:** `3003`\nYou are not the meeting host.<br>**Error Code:** `3000`>\nCannot access meeting info.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/registrants/:registrantId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "registrants",
            ":registrantId"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
            },
            {
              "key": "registrantId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The registrant ID."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`\nMeeting not found.<br>**Error Code:** `1001`<br>\nMeeting host does not exist: \"{userId}\"",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/meetings/:meetingId/registrants/:registrantId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "meetings",
            ":meetingId",
            "registrants",
            ":registrantId"
          ],
          "variable": [
            {
              "key": "meetingId",
              "value": "68423085",
              "description": "(Required) The meeting's ID. \n\n When storing this value in your database, you must store it as a **long** format integer and **not** an integer. Meeting IDs can exceed 10 digits."
            },
            {
              "key": "registrantId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The registrant ID."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}