Swift3 / Zoom API / Upload Virtual Background files
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/groups/:groupId/settings/virtual_backgrounds"
req.contentType = "multipart/form-data"
req.addParam("file", value: "consequat est pariatur")
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": "_Tcj7354w6eHw",
// "name": "u=mdbhhfg3y7&fm=2fdjs0.jpg",
// "type": "image",
// "is_default": false,
// "size": 53434
// }
// 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.string(of: "id")
var name: String? = jResp.string(of: "name")
var v_type: String? = jResp.string(of: "type")
var is_default: Bool = jResp.bool(of: "is_default")
var size: Int = jResp.int(of: "size").intValue
}
Curl Command
curl -X POST
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'file=consequat est pariatur'
https://api.zoom.us/v2/groups/:groupId/settings/virtual_backgrounds
Postman Collection Item JSON
{
"name": "Upload Virtual Background files",
"request": {
"method": "POST",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"value": "consequat est pariatur",
"description": "The Virtual Background file's path.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings/virtual_backgrounds",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings",
"virtual_backgrounds"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID. To get a group's ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API."
}
]
},
"description": "Use this API to [upload Virtual Background files](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_01EJF3YFEWGT8YA0ZJ079JEDQE) for all users in a group to use. \n\n **Scopes:** `group:write:admin` <br> **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Medium` \n\n**Prerequisites:** \n* The [Virtual Background feature](https://support.zoom.us/hc/en-us/articles/210707503-Virtual-Background#h_2ef28080-fce9-4ac2-b567-dc958afab1b7) must be enabled on the account."
},
"response": [
{
"name": "**HTTP Status Code:** `201` <br>\n Created",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"value": "consequat est pariatur",
"description": "The Virtual Background file's path.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings/virtual_backgrounds",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings",
"virtual_backgrounds"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID. To get a group's ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API."
}
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"_Tcj7354w6eHw\",\n \"name\": \"u=mdbhhfg3y7&fm=2fdjs0.jpg\",\n \"type\": \"image\",\n \"is_default\": false,\n \"size\": 53434\n}"
},
{
"name": "**HTTP Status Code:** `400` **Bad Request** <br>\n**Error Code:** `120`<br>\nNo file uploaded, verify that a file has been uploaded.<br>\nFile size cannot exceed 15M.<br>\nA maximum of 10 files are allowed for a user.<br>\nOnly jpg/jpeg or png image file can b",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"value": "consequat est pariatur",
"description": "The Virtual Background file's path.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings/virtual_backgrounds",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings",
"virtual_backgrounds"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID. To get a group's ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API."
}
]
}
},
"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:** `1001`<br>\nUser not exist.<br>\nUser {email} not exist or not belong to this account.",
"originalRequest": {
"method": "POST",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "file",
"value": "consequat est pariatur",
"description": "The Virtual Background file's path.",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/groups/:groupId/settings/virtual_backgrounds",
"host": [
"{{baseUrl}}"
],
"path": [
"groups",
":groupId",
"settings",
"virtual_backgrounds"
],
"variable": [
{
"key": "groupId",
"value": "quis officia in reprehenderit",
"description": "(Required) The group ID. To get a group's ID, use the [**List groups**](https://marketplace.zoom.us/docs/api-reference/zoom-api/groups/groups) API."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
