SQL Server / Zoom API / Create a H.323/SIP device
Back to Collection Items
-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
-- Important: Do not use nvarchar(max). See the warning about using nvarchar(max).
DECLARE @sTmp0 nvarchar(4000)
-- This example assumes the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @http int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @req int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.HttpRequest', @req OUT
EXEC sp_OASetProperty @req, 'HttpVerb', 'POST'
EXEC sp_OASetProperty @req, 'Path', '/v2/h323/devices'
EXEC sp_OASetProperty @req, 'ContentType', 'multipart/form-data'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'lab', ''
EXEC sp_OAMethod @req, 'AddParam', NULL, 'protocol', 'labH.323'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'ip', 'labH.323irure ea voluptate eiusmod amet'
EXEC sp_OAMethod @req, 'AddParam', NULL, 'encryption', 'labH.323irure ea voluptate eiusmod ametyes'
EXEC sp_OAMethod @req, 'AddHeader', NULL, 'Authorization', 'Bearer <access_token>'
DECLARE @resp int
EXEC sp_OAMethod @http, 'SynchronousRequest', @resp OUT, 'api.zoom.us', 443, 1, @req
EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
IF @iTmp0 = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
RETURN
END
EXEC sp_OAGetProperty @resp, 'StatusCode', @iTmp0 OUT
PRINT @iTmp0
EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @resp
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @req
END
GO
Curl Command
curl -X POST
-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
Postman Collection Item JSON
{
"name": "Create a H.323/SIP device",
"request": {
"auth": {
"type": "oauth2"
},
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"h323",
"devices"
]
},
"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 add a H.323/SIP device to your Zoom account<br><br>\n**Scopes:** `h323:write:admin`<br>\n\n **[Rate Limit Label](https://marketplace.zoom.us/docs/api-reference/rate-limits#rate-limits):** `Light` <br>"
},
"response": [
{
"name": "**Error Code:** `200`<br>\nNo permission.",
"originalRequest": {
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"h323",
"devices"
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
},
{
"name": "**HTTP Status Code:** `201`<br>\nH.323/SIP device created.",
"originalRequest": {
"method": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"h323",
"devices"
]
}
},
"status": "Created",
"code": 201,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Location",
"value": "quis officia in reprehenderit",
"description": "Location of created device"
},
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"id\": \"string\",\n \"name\": \"string\",\n \"protocol\": \"string\",\n \"ip\": \"string\",\n \"encryption\": \"string\"\n}"
},
{
"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": "POST",
"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",
"host": [
"{{baseUrl}}"
],
"path": [
"h323",
"devices"
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
