Chilkat Online Tools

Swift3 / Zoom API / Perform batch registration

Back to Collection Items

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

    let http = CkoHttp()!
    var success: Bool

    let req = CkoHttpRequest()!
    req.httpVerb = "POST"
    req.path = "/v2/webinars/:webinarId/batch_registrants"
    req.contentType = "multipart/form-data"
    req.addParam("auto_approve", value: "true")

    req.addParam("registrants", value: "true[{\"first_name\":\"dolore eu aute dolor\",\"email\":\"KEESPCs-T1pF@ljUbrzdNgzMc.xx\",\"last_name\":\"eu reprehenderit ea magna ex\"},{\"first_name\":\"aliquip deserunt\",\"email\":\"okZ9KNk@nZOovoEvyoTCgW.eftt\",\"last_name\":\"nostrud\"}]")

    req.addHeader("Authorization", value: "Bearer <access_token>")

    var resp: CkoHttpResponse? = http.synchronousRequest("api.zoom.us", port: 443, ssl: true, req: req)
    if http.lastMethodSuccess == false {
        print("\(http.lastErrorText!)")
        return
    }

    let sbResponseBody = CkoStringBuilder()!
    resp!.getBodySb(sbResponseBody)

    let jResp = CkoJsonObject()!
    jResp.loadSb(sbResponseBody)
    jResp.emitCompact = false

    print("Response Body:")
    print("\(jResp.emit()!)")

    var respStatusCode: Int = resp!.statusCode.intValue
    print("Response Status Code = \(respStatusCode)")
    if respStatusCode >= 400 {
        print("Response Header:")
        print("\(resp!.header!)")
        print("Failed.")
        resp = nil
        return
    }

    resp = nil

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

    // {
    //   "registrants": [
    //     {
    //       "registrant_id": "conseret14re",
    //       "email": "example@example.com",
    //       "join_url": " https://zoom.us/w/9999999?tk=oZuwHfdgAAAAAAAAAAAAAAAA&uuid=WN_XW4_SdxBBBBxLDQt"
    //     },
    //     {
    //       "registrant_id": "fdgsfh2ey82fuh",
    //       "email": "example-2@example.com",
    //       "join_url": " https://zoom.us/w/9999999?tk=oZu52542356AAAAAA&uuid=WN_XW4_SdxBBBBxLDQt"
    //     },
    //     {
    //       "registrant_id": "hdsfhjf3iwh",
    //       "email": "example-3@example.com",
    //       "join_url": " https://zoom.us/w/9999999?tk=ozghdfdsghf36AAA&uuid=WN_XW4_SdxBBBBxLDQt"
    //     }
    //   ]
    // }

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

    var registrant_id: String?
    var email: String?
    var join_url: String?

    var i: Int = 0
    var count_i: Int = jResp.size(ofArray: "registrants").intValue
    while i < count_i {
        jResp.i = i
        registrant_id = jResp.string(of: "registrants[i].registrant_id")
        email = jResp.string(of: "registrants[i].email")
        join_url = jResp.string(of: "registrants[i].join_url")
        i = i + 1
    }


}

Curl Command

curl -X POST
	-H "Authorization: Bearer <access_token>"
	-H "Content-Type: multipart/form-data"
	--form 'auto_approve=true'
	--form 'registrants=true[{"first_name":"dolore eu aute dolor","email":"KEESPCs-T1pF@ljUbrzdNgzMc.xx","last_name":"eu reprehenderit ea magna ex"},{"first_name":"aliquip deserunt","email":"okZ9KNk@nZOovoEvyoTCgW.eftt","last_name":"nostrud"}]'
https://api.zoom.us/v2/webinars/:webinarId/batch_registrants

Postman Collection Item JSON

{
  "name": "Perform batch registration",
  "request": {
    "auth": {
      "type": "oauth2"
    },
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "multipart/form-data"
      }
    ],
    "body": {
      "mode": "formdata",
      "formdata": [
        {
          "key": "auto_approve",
          "value": "true",
          "description": "If a meeting was scheduled with approval_type `1` (manual approval), but you would like to automatically approve the registrants that are added via this API, you can set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting  that was originally scheduled with approval_type `0` (automatic approval).",
          "type": "text"
        },
        {
          "key": "registrants",
          "value": "[{\"first_name\":\"dolore eu aute dolor\",\"email\":\"KEESPCs-T1pF@ljUbrzdNgzMc.xx\",\"last_name\":\"eu reprehenderit ea magna ex\"},{\"first_name\":\"aliquip deserunt\",\"email\":\"okZ9KNk@nZOovoEvyoTCgW.eftt\",\"last_name\":\"nostrud\"}]",
          "type": "text"
        }
      ]
    },
    "url": {
      "raw": "{{baseUrl}}/webinars/:webinarId/batch_registrants",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "webinars",
        ":webinarId",
        "batch_registrants"
      ],
      "variable": [
        {
          "key": "webinarId",
          "value": "quis officia in reprehenderit",
          "description": "(Required) Unique identifier of the webinar."
        }
      ]
    },
    "description": "Use this API to register up to 30 registrants at once for a scheduled webinar that requires [registration](https://support.zoom.us/hc/en-us/articles/204619915-Scheduling-a-webinar-with-registration). <br>\n\n**Prerequisites:**<br>\n* The webinar host must be a Licensed user.\n* The webinar should be of type `5`, i.e., it should be a scheduled webinar. Other types of webinars are not supported by this API.<br><br>\n**Scope:** `webinar:write`, `webinar:write:admin`<br>\n**[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Heavy`<br>\n\n\n\n\n\n\n\n"
  },
  "response": [
    {
      "name": "**HTTP Status Code:** `200` **OK** <br>\nRegistrants added.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "auto_approve",
              "value": "false",
              "description": "If a meeting was scheduled with approval_type `1` (manual approval), but you would like to automatically approve the registrants that are added via this API, you can set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting  that was originally scheduled with approval_type `0` (automatic approval).",
              "type": "text"
            },
            {
              "key": "registrants",
              "value": "[{\"first_name\":\"dolore est dolore ex\",\"email\":\"QlxiFO3fdQ@rzgNRxcC.ijep\",\"last_name\":\"enim consequat veniam commodo\"},{\"first_name\":\"in ut proident adipisicing\",\"email\":\"Fk39rzyimgL2P@MAuNNuZMsxZfijeyYnVHAVxkQ.ipd\",\"last_name\":\"incididunt esse mollit ullamco est\"}]",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/batch_registrants",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "batch_registrants"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the webinar."
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"registrants\": [\n  {\n   \"registrant_id\": \"conseret14re\",\n   \"email\": \"example@example.com\",\n   \"join_url\": \" https://zoom.us/w/9999999?tk=oZuwHfdgAAAAAAAAAAAAAAAA&uuid=WN_XW4_SdxBBBBxLDQt\"\n  },\n  {\n   \"registrant_id\": \"fdgsfh2ey82fuh\",\n   \"email\": \"example-2@example.com\",\n   \"join_url\": \" https://zoom.us/w/9999999?tk=oZu52542356AAAAAA&uuid=WN_XW4_SdxBBBBxLDQt\"\n  },\n  {\n   \"registrant_id\": \"hdsfhjf3iwh\",\n   \"email\": \"example-3@example.com\",\n   \"join_url\": \" https://zoom.us/w/9999999?tk=ozghdfdsghf36AAA&uuid=WN_XW4_SdxBBBBxLDQt\"\n  }\n ]\n}"
    },
    {
      "name": "**HTTP Status Code:** `400` **Bad Request** <br>\n**Error Code:** `200`<br> Webinar plan is missing. You must subscribe to the webinar plan and enable webinar for this user: {0} in order to perform this action.<br><br>\n**Error Code:** `300`<br> \nThis API c",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "auto_approve",
              "value": "false",
              "description": "If a meeting was scheduled with approval_type `1` (manual approval), but you would like to automatically approve the registrants that are added via this API, you can set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting  that was originally scheduled with approval_type `0` (automatic approval).",
              "type": "text"
            },
            {
              "key": "registrants",
              "value": "[{\"first_name\":\"dolore est dolore ex\",\"email\":\"QlxiFO3fdQ@rzgNRxcC.ijep\",\"last_name\":\"enim consequat veniam commodo\"},{\"first_name\":\"in ut proident adipisicing\",\"email\":\"Fk39rzyimgL2P@MAuNNuZMsxZfijeyYnVHAVxkQ.ipd\",\"last_name\":\"incididunt esse mollit ullamco est\"}]",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/batch_registrants",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "batch_registrants"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the webinar."
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `404` **Not Found** <br>\n**Error Code:** `3001`<br>\nWebinar does not exist: {0}.<br><br>\n**Error Code:** `3043`<br>\nWebinar has reached maximum attendee capacity.<br><br>\n**Error Code:** `404`<br>\nRegistration has not been enabled fo",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "auto_approve",
              "value": "false",
              "description": "If a meeting was scheduled with approval_type `1` (manual approval), but you would like to automatically approve the registrants that are added via this API, you can set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting  that was originally scheduled with approval_type `0` (automatic approval).",
              "type": "text"
            },
            {
              "key": "registrants",
              "value": "[{\"first_name\":\"dolore est dolore ex\",\"email\":\"QlxiFO3fdQ@rzgNRxcC.ijep\",\"last_name\":\"enim consequat veniam commodo\"},{\"first_name\":\"in ut proident adipisicing\",\"email\":\"Fk39rzyimgL2P@MAuNNuZMsxZfijeyYnVHAVxkQ.ipd\",\"last_name\":\"incididunt esse mollit ullamco est\"}]",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/batch_registrants",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "batch_registrants"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the webinar."
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "name": "**HTTP Status Code:** `429` <br> You have exceeded the daily rate limit of \"{0}\" for webinar **Perform batch registration** API requests for the registrant \"{1}\". You can resume these API requests at GMT 00:00:00.",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": "Added as a part of security scheme: oauth2",
            "key": "Authorization",
            "value": "<token>"
          }
        ],
        "body": {
          "mode": "formdata",
          "formdata": [
            {
              "key": "auto_approve",
              "value": "false",
              "description": "If a meeting was scheduled with approval_type `1` (manual approval), but you would like to automatically approve the registrants that are added via this API, you can set the value of this field to `true`. \n\nYou **cannot** use this field to change approval setting for a meeting  that was originally scheduled with approval_type `0` (automatic approval).",
              "type": "text"
            },
            {
              "key": "registrants",
              "value": "[{\"first_name\":\"dolore est dolore ex\",\"email\":\"QlxiFO3fdQ@rzgNRxcC.ijep\",\"last_name\":\"enim consequat veniam commodo\"},{\"first_name\":\"in ut proident adipisicing\",\"email\":\"Fk39rzyimgL2P@MAuNNuZMsxZfijeyYnVHAVxkQ.ipd\",\"last_name\":\"incididunt esse mollit ullamco est\"}]",
              "type": "text"
            }
          ]
        },
        "url": {
          "raw": "{{baseUrl}}/webinars/:webinarId/batch_registrants",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "webinars",
            ":webinarId",
            "batch_registrants"
          ],
          "variable": [
            {
              "key": "webinarId",
              "value": "quis officia in reprehenderit",
              "description": "(Required) Unique identifier of the webinar."
            }
          ]
        }
      },
      "status": "Too Many Requests",
      "code": 429,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}