Chilkat Online Tools

unicodeC / Zoom API / Get webinar detail reports

Back to Collection Items

#include <C_CkHttpW.h>
#include <C_CkStringBuilderW.h>
#include <C_CkJsonObjectW.h>

void ChilkatSample(void)
    {
    HCkHttpW http;
    BOOL success;
    HCkStringBuilderW sbResponseBody;
    HCkJsonObjectW jResp;
    int respStatusCode;
    const wchar_t *field;
    const wchar_t *value;
    const wchar_t *uuid;
    int id;
    int v_type;
    const wchar_t *topic;
    const wchar_t *user_name;
    const wchar_t *user_email;
    const wchar_t *start_time;
    const wchar_t *end_time;
    int duration;
    int total_minutes;
    int participants_count;
    int i;
    int count_i;

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

    http = CkHttpW_Create();

    // Adds the "Authorization: Bearer <access_token>" header.
    CkHttpW_putAuthToken(http,L"<access_token>");

    sbResponseBody = CkStringBuilderW_Create();
    success = CkHttpW_QuickGetSb(http,L"https://api.zoom.us/v2/report/webinars/:webinarId",sbResponseBody);
    if (success == FALSE) {
        wprintf(L"%s\n",CkHttpW_lastErrorText(http));
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        return;
    }

    jResp = CkJsonObjectW_Create();
    CkJsonObjectW_LoadSb(jResp,sbResponseBody);
    CkJsonObjectW_putEmitCompact(jResp,FALSE);

    wprintf(L"Response Body:\n");
    wprintf(L"%s\n",CkJsonObjectW_emit(jResp));

    respStatusCode = CkHttpW_getLastStatus(http);
    wprintf(L"Response Status Code = %d\n",respStatusCode);
    if (respStatusCode >= 400) {
        wprintf(L"Response Header:\n");
        wprintf(L"%s\n",CkHttpW_lastHeader(http));
        wprintf(L"Failed.\n");
        CkHttpW_Dispose(http);
        CkStringBuilderW_Dispose(sbResponseBody);
        CkJsonObjectW_Dispose(jResp);
        return;
    }

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

    // {
    //   "uuid": "urn4fe6caeb98",
    //   "id": 51788617,
    //   "type": 5,
    //   "topic": "My Health Webinar",
    //   "user_name": "Utfdfdget",
    //   "user_email": "example@example.com",
    //   "start_time": "2019-11-18T03:15:00.056Z",
    //   "end_time": "2019-11-18T03:15:20.056Z",
    //   "duration": 20,
    //   "total_minutes": 10,
    //   "participants_count": 13,
    //   "tracking_fields": [
    //     {
    //       "field": "Webinar Purpose",
    //       "value": "Health awareness"
    //     }
    //   ]
    // }

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

    // Chilkat functions returning "const char *" return a pointer to temporary internal memory owned and managed by Chilkat.

    uuid = CkJsonObjectW_stringOf(jResp,L"uuid");
    id = CkJsonObjectW_IntOf(jResp,L"id");
    v_type = CkJsonObjectW_IntOf(jResp,L"type");
    topic = CkJsonObjectW_stringOf(jResp,L"topic");
    user_name = CkJsonObjectW_stringOf(jResp,L"user_name");
    user_email = CkJsonObjectW_stringOf(jResp,L"user_email");
    start_time = CkJsonObjectW_stringOf(jResp,L"start_time");
    end_time = CkJsonObjectW_stringOf(jResp,L"end_time");
    duration = CkJsonObjectW_IntOf(jResp,L"duration");
    total_minutes = CkJsonObjectW_IntOf(jResp,L"total_minutes");
    participants_count = CkJsonObjectW_IntOf(jResp,L"participants_count");
    i = 0;
    count_i = CkJsonObjectW_SizeOfArray(jResp,L"tracking_fields");
    while (i < count_i) {
        CkJsonObjectW_putI(jResp,i);
        field = CkJsonObjectW_stringOf(jResp,L"tracking_fields[i].field");
        value = CkJsonObjectW_stringOf(jResp,L"tracking_fields[i].value");
        i = i + 1;
    }



    CkHttpW_Dispose(http);
    CkStringBuilderW_Dispose(sbResponseBody);
    CkJsonObjectW_Dispose(jResp);

    }

Curl Command

curl -X GET
	-H "Authorization: Bearer <access_token>"
https://api.zoom.us/v2/report/webinars/:webinarId

Postman Collection Item JSON

{
  "name": "Get webinar detail reports",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "GET",
    "header": [
    ],
    "url": {
      "raw": "{{baseUrl}}/report/webinars/:webinarId",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "report",
        "webinars",
        ":webinarId"
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
        }
      ]
    },
    "description": "Retrieve a [report](https://support.zoom.us/hc/en-us/articles/201393719-Webinar-Reporting) containing past webinar details.  <br><br>\n**Scopes:** `report:read:admin`<br>\n \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n**Prerequisites:**<br>\n* Pro or higher plan with Webinar add-on."
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200`<br>\nWebinar details returned.<br>\nThis is only available for paid account:{accountId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"uuid\": \"urn4fe6caeb98\",\n \"id\": 51788617,\n \"type\": 5,\n \"topic\": \"My Health Webinar\",\n \"user_name\": \"Utfdfdget\",\n \"user_email\": \"example@example.com\",\n \"start_time\": \"2019-11-18T03:15:00.056Z\",\n \"end_time\": \"2019-11-18T03:15:20.056Z\",\n \"duration\": 20,\n \"total_minutes\": 10,\n \"participants_count\": 13,\n \"tracking_fields\": [\n  {\n   \"field\": \"Webinar Purpose\",\n   \"value\": \"Health awareness\"\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `300`<br>\nCan not access webinar information:{webinarId}.",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Multiple Choices",
      "code": 300,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `400`<br>\nBad request<br>\n**Error Code:** `1010`<br>\nUser does not belong to this account:{accountId}.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404`<br>\nWebinar ID not found.<br>\n**Error Code:** `3001`<br>\nMeeting  {meetingId} not found or has expired.<br>",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/report/webinars/:webinarId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "report",
            "webinars",
            ":webinarId"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) The webinar's ID or universally unique ID (UUID). \n* If you provide a webinar ID, the API will return a response for the latest webinar instance. \n* If you provide a webinar UUID that begins with a `/` character or contains the `//` characters, you **must** double-encode the webinar UUID before making an API request."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}