Ruby / Zoom API / Update a H.323/SIP device
Back to Collection Items
require 'chilkat'
# This example assumes the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.
http = Chilkat::CkHttp.new()
req = Chilkat::CkHttpRequest.new()
req.put_HttpVerb("PATCH")
req.put_Path("/v2/h323/devices/:deviceId")
req.put_ContentType("multipart/form-data")
req.AddParam("lab","")
req.AddParam("protocol","labH.323")
req.AddParam("ip","labH.323irure ea voluptate eiusmod amet")
req.AddParam("encryption","labH.323irure ea voluptate eiusmod ametyes")
req.AddHeader("Authorization","Bearer <access_token>")
# resp is a CkHttpResponse
resp = http.SynchronousRequest("api.zoom.us",443,true,req)
if (http.get_LastMethodSuccess() == false)
print http.lastErrorText() + "\n";
exit
end
respStatusCode = resp.get_StatusCode()
print "Response Status Code = " + respStatusCode.to_s() + "\n";
if (respStatusCode != 204)
print "Response Header:" + "\n";
print resp.header() + "\n";
print "Response Body:" + "\n";
print resp.bodyStr() + "\n";
print "Failed." + "\n";
exit
end
print "Success." + "\n";
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-H "Content-Type: multipart/form-data"
--form 'name=lab'
--form 'protocol=labH.323'
--form 'ip=labH.323irure ea voluptate eiusmod amet'
--form 'encryption=labH.323irure ea voluptate eiusmod ametyes'
https://api.zoom.us/v2/h323/devices/:deviceId
Postman Collection Item JSON
{
"name": "Update a H.323/SIP device",
"request": {
"method": "PATCH",
"header": [
{
"key": "Content-Type",
"value": "multipart/form-data"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "lab",
"description": "(Required) Device name.",
"type": "text"
},
{
"key": "protocol",
"value": "H.323",
"description": "(Required) Device protocol:<br>`H.323` - H.323.<br>`SIP` - SIP. (This can only be one of H.323,SIP)",
"type": "text"
},
{
"key": "ip",
"value": "irure ea voluptate eiusmod amet",
"description": "(Required) Device IP.",
"type": "text"
},
{
"key": "encryption",
"value": "yes",
"description": "(Required) Device encryption:<br>`auto` - auto.<br>`yes` - yes.<br>`no` - no. (This can only be one of auto,yes,no)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/h323/devices/:deviceId",
"host": [
"{{baseUrl}}"
],
"path": [
"h323",
"devices",
":deviceId"
],
"variable": [
{
"key": "deviceId",
"value": "quis officia in reprehenderit",
"description": "(Required) The device ID."
}
]
},
"description": "A H.323 or SIP device can make a video call to a [Room Connector](https://support.zoom.us/hc/en-us/articles/201363273-Getting-Started-With-H-323-SIP-Room-Connector) to join a Zoom cloud meeting. A Room Connector can also call out to a H.323 or SIP device to join a Zoom cloud meeting. Use this API to edit information of a H.323/SIP device from your Zoom account.<br><br>\n**Scopes:** `h323:write:admin`<br>\n <br>\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light`"
},
"response": [
{
"name": "**HTTP Status Code:** `204`<br>\nH.323/SIP device updated.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "lab",
"description": "(Required) Device name.",
"type": "text"
},
{
"key": "protocol",
"value": "H.323",
"description": "(Required) Device protocol:<br>`H.323` - H.323.<br>`SIP` - SIP. (This can only be one of H.323,SIP)",
"type": "text"
},
{
"key": "ip",
"value": "irure ea voluptate eiusmod amet",
"description": "(Required) Device IP.",
"type": "text"
},
{
"key": "encryption",
"value": "yes",
"description": "(Required) Device encryption:<br>`auto` - auto.<br>`yes` - yes.<br>`no` - no. (This can only be one of auto,yes,no)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/h323/devices/:deviceId",
"host": [
"{{baseUrl}}"
],
"path": [
"h323",
"devices",
":deviceId"
],
"variable": [
{
"key": "deviceId",
"value": "quis officia in reprehenderit",
"description": "(Required) The device ID."
}
]
}
},
"status": "No Content",
"code": 204,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**Error Code:** `300`<br>\nH.323 Device does not exist: {deviceId}.",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "lab",
"description": "(Required) Device name.",
"type": "text"
},
{
"key": "protocol",
"value": "H.323",
"description": "(Required) Device protocol:<br>`H.323` - H.323.<br>`SIP` - SIP. (This can only be one of H.323,SIP)",
"type": "text"
},
{
"key": "ip",
"value": "irure ea voluptate eiusmod amet",
"description": "(Required) Device IP.",
"type": "text"
},
{
"key": "encryption",
"value": "yes",
"description": "(Required) Device encryption:<br>`auto` - auto.<br>`yes` - yes.<br>`no` - no. (This can only be one of auto,yes,no)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/h323/devices/:deviceId",
"host": [
"{{baseUrl}}"
],
"path": [
"h323",
"devices",
":deviceId"
],
"variable": [
{
"key": "deviceId",
"value": "quis officia in reprehenderit",
"description": "(Required) The device ID."
}
]
}
},
"status": "Multiple Choices",
"code": 300,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `404`<br>\n**Error Code:** `2020`<br>\nH.323 device's display name:{displayName} is already in use.\n",
"originalRequest": {
"method": "PATCH",
"header": [
{
"description": "Added as a part of security scheme: oauth2",
"key": "Authorization",
"value": "<token>"
}
],
"body": {
"mode": "formdata",
"formdata": [
{
"key": "name",
"value": "lab",
"description": "(Required) Device name.",
"type": "text"
},
{
"key": "protocol",
"value": "H.323",
"description": "(Required) Device protocol:<br>`H.323` - H.323.<br>`SIP` - SIP. (This can only be one of H.323,SIP)",
"type": "text"
},
{
"key": "ip",
"value": "irure ea voluptate eiusmod amet",
"description": "(Required) Device IP.",
"type": "text"
},
{
"key": "encryption",
"value": "yes",
"description": "(Required) Device encryption:<br>`auto` - auto.<br>`yes` - yes.<br>`no` - no. (This can only be one of auto,yes,no)",
"type": "text"
}
]
},
"url": {
"raw": "{{baseUrl}}/h323/devices/:deviceId",
"host": [
"{{baseUrl}}"
],
"path": [
"h323",
"devices",
":deviceId"
],
"variable": [
{
"key": "deviceId",
"value": "quis officia in reprehenderit",
"description": "(Required) The device ID."
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
