Swift / Zoom API / Add a Zoom Room
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/rooms"
req.ContentType = "multipart/form-data"
req.AddParam("veniam enim ut", value: "")
req.AddStringForUpload2("", filename: "", strData: "", charset: "", contentType: "veniam enim utZoomRoom")
req.AddParam("location_id", value: "veniam enim utZoomRoomdo laborum in")
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)
// {
// "id": "abcdefgg",
// "name": "Cool ZoomRoom",
// "type": "SchedulingDisplayOnly",
// "location_id": "434gfg0is",
// "room_id": "dhsfd8287rgf"
// }
// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
var id: String? = jResp.StringOf("id")
var name: String? = jResp.StringOf("name")
var v_type: String? = jResp.StringOf("type")
var location_id: String? = jResp.StringOf("location_id")
var room_id: String? = jResp.StringOf("room_id")
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'name=veniam enim ut'
--form 'type=veniam enim utZoomRoom'
--form 'location_id=veniam enim utZoomRoomdo laborum in'
https://api.zoom.us/v2/rooms
Postman Collection Item JSON
{
"name": "Add a Zoom Room",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "veniam enim ut",
"description": "(Required) Name of the Zoom Room.",
"type": "text"
},
{
"key": "type",
"value": "ZoomRoom",
"description": "(Required) Type of the Zoom Room. (This can only be one of ZoomRoom,SchedulingDisplayOnly,DigitalSignageOnly)",
"type": "text"
},
{
"key": "location_id",
"value": "do laborum in",
"description": "**Optional**<br>Location ID of the lowest level location in the [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) where the Zoom Room is to be added. For instance if the structure of the location hierarchy is set up as “country, states, city, campus, building, floor”, a room can only be added under the floor level location. \n\nThis ID can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms"
]
},
"description": "Use this API to [add a Zoom Room](https://support.zoom.us/hc/en-us/articles/202822279-Add-Zoom-Rooms-on-Web-Portal) to a Zoom account.<br><br>\n**Prerequisites:**<br>\n* Pro or a higher plan with [Zoom Room](https://zoom.us/zoomrooms) license.<br>\n**Scopes**: `room:write:admin`<br> \n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium`"
},
"response": [
{
"name": "**HTTP Status Code:** `201` **Created**<br>\nZoom Room added successfully.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "veniam enim ut",
"description": "(Required) Name of the Zoom Room.",
"type": "text"
},
{
"key": "type",
"value": "ZoomRoom",
"description": "(Required) Type of the Zoom Room. (This can only be one of ZoomRoom,SchedulingDisplayOnly,DigitalSignageOnly)",
"type": "text"
},
{
"key": "location_id",
"value": "do laborum in",
"description": "**Optional**<br>Location ID of the lowest level location in the [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) where the Zoom Room is to be added. For instance if the structure of the location hierarchy is set up as “country, states, city, campus, building, floor”, a room can only be added under the floor level location. \n\nThis ID can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"abcdefgg\",\n \"name\": \"Cool ZoomRoom\",\n \"type\": \"SchedulingDisplayOnly\",\n \"location_id\": \"434gfg0is\",\n \"room_id\": \"dhsfd8287rgf\"\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request**<br><br>\n**Error Code:** `200`<br> Zoom Room subscription not found. Try again after purchasing a Zoom Room subscription.<br>\nAt least one normal Zoom Rooms required.<br><br>\n**Error Code:** `300`<br>\nInvalid par",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "veniam enim ut",
"description": "(Required) Name of the Zoom Room.",
"type": "text"
},
{
"key": "type",
"value": "ZoomRoom",
"description": "(Required) Type of the Zoom Room. (This can only be one of ZoomRoom,SchedulingDisplayOnly,DigitalSignageOnly)",
"type": "text"
},
{
"key": "location_id",
"value": "do laborum in",
"description": "**Optional**<br>Location ID of the lowest level location in the [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) where the Zoom Room is to be added. For instance if the structure of the location hierarchy is set up as “country, states, city, campus, building, floor”, a room can only be added under the floor level location. \n\nThis ID can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms"
]
}
},
"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><br>\n\n**Error Code:** `4801`<br>\nLocation not found:{location_id}",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "veniam enim ut",
"description": "(Required) Name of the Zoom Room.",
"type": "text"
},
{
"key": "type",
"value": "ZoomRoom",
"description": "(Required) Type of the Zoom Room. (This can only be one of ZoomRoom,SchedulingDisplayOnly,DigitalSignageOnly)",
"type": "text"
},
{
"key": "location_id",
"value": "do laborum in",
"description": "**Optional**<br>Location ID of the lowest level location in the [location hierarchy](https://support.zoom.us/hc/en-us/articles/115000342983-Zoom-Rooms-Location-Hierarchy) where the Zoom Room is to be added. For instance if the structure of the location hierarchy is set up as “country, states, city, campus, building, floor”, a room can only be added under the floor level location. \n\nThis ID can be retrieved from the [List Zoom Room Locations](https://marketplace.zoom.us/docs/api-reference/zoom-api/rooms-location/listzrlocations) API.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/rooms",
"host": [
"{{baseUrl}}"
],
"path": [
"rooms"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
