SQL Server / Zoom API / Get a meeting registrant
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
-- Adds the "Authorization: Bearer <access_token>" header.
EXEC sp_OASetProperty @http, 'AuthToken', '<access_token>'
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://api.zoom.us/v2/meetings/:meetingId/registrants/:registrantId', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- 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
DECLARE @title nvarchar(4000)
DECLARE @value nvarchar(4000)
DECLARE @id nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'id'
DECLARE @email nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @email OUT, 'email'
DECLARE @first_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @first_name OUT, 'first_name'
DECLARE @last_name nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @last_name OUT, 'last_name'
DECLARE @address nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @address OUT, 'address'
DECLARE @city nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @city OUT, 'city'
DECLARE @country nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @country OUT, 'country'
DECLARE @zip nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @zip OUT, 'zip'
DECLARE @state nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @state OUT, 'state'
DECLARE @phone nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @phone OUT, 'phone'
DECLARE @industry nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @industry OUT, 'industry'
DECLARE @org nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @org OUT, 'org'
DECLARE @job_title nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @job_title OUT, 'job_title'
DECLARE @purchasing_time_frame nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @purchasing_time_frame OUT, 'purchasing_time_frame'
DECLARE @role_in_purchase_process nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @role_in_purchase_process OUT, 'role_in_purchase_process'
DECLARE @no_of_employees nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @no_of_employees OUT, 'no_of_employees'
DECLARE @comments nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @comments OUT, 'comments'
DECLARE @status nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @status OUT, 'status'
DECLARE @create_time nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @create_time OUT, 'create_time'
DECLARE @join_url nvarchar(4000)
EXEC sp_OAMethod @jResp, 'StringOf', @join_url OUT, 'join_url'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'custom_questions'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @title OUT, 'custom_questions[i].title'
EXEC sp_OAMethod @jResp, 'StringOf', @value OUT, 'custom_questions[i].value'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
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": ""
}
]
}
