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
-- 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
-- Use "Chilkat_9_5_0.Http" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.Http', @http OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
EXEC sp_OASetProperty @http, 'BasicAuth', 1
EXEC sp_OASetProperty @http, 'Login', 'username'
EXEC sp_OASetProperty @http, 'Password', 'password'
DECLARE @sbResponseBody int
-- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @http, 'QuickGetSb', @success OUT, 'https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations', @sbResponseBody
IF @success = 0
BEGIN
EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
-- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
EXEC sp_OASetProperty @jResp, 'EmitCompact', 0
PRINT 'Response Body:'
EXEC sp_OAMethod @jResp, 'Emit', @sTmp0 OUT
PRINT @sTmp0
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @http, 'LastStatus', @respStatusCode OUT
PRINT 'Response Status Code = ' + @respStatusCode
IF @respStatusCode >= 400
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @http, 'LastHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Failed.'
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
RETURN
END
-- Sample JSON response:
-- (Sample code for parsing the JSON response is shown below)
-- {
-- "switchboardIntegrations": [
-- {
-- "id": "5ef21b86e933b7355c11c604",
-- "name": "bot",
-- "integrationId": "5ef21b86e933b7355c11c605",
-- "integrationType": "zd:agentWorkspace",
-- "deliverStandbyEvents": true,
-- "nextSwitchboardIntegrationId": "5ef21b86e933b7355c11c606",
-- "messageHistoryCount": 5
-- },
-- {
-- "id": "5ef21b86e933b7355c11c604",
-- "name": "bot",
-- "integrationId": "5ef21b86e933b7355c11c605",
-- "integrationType": "zd:agentWorkspace",
-- "deliverStandbyEvents": false,
-- "nextSwitchboardIntegrationId": "5ef21b86e933b7355c11c606",
-- "messageHistoryCount": 5
-- }
-- ]
-- }
-- Sample code for parsing the JSON response...
-- Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code
DECLARE @id nvarchar(4000)
DECLARE @name nvarchar(4000)
DECLARE @integrationId nvarchar(4000)
DECLARE @integrationType nvarchar(4000)
DECLARE @deliverStandbyEvents int
DECLARE @nextSwitchboardIntegrationId nvarchar(4000)
DECLARE @messageHistoryCount int
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'switchboardIntegrations'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @id OUT, 'switchboardIntegrations[i].id'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'switchboardIntegrations[i].name'
EXEC sp_OAMethod @jResp, 'StringOf', @integrationId OUT, 'switchboardIntegrations[i].integrationId'
EXEC sp_OAMethod @jResp, 'StringOf', @integrationType OUT, 'switchboardIntegrations[i].integrationType'
EXEC sp_OAMethod @jResp, 'BoolOf', @deliverStandbyEvents OUT, 'switchboardIntegrations[i].deliverStandbyEvents'
EXEC sp_OAMethod @jResp, 'StringOf', @nextSwitchboardIntegrationId OUT, 'switchboardIntegrations[i].nextSwitchboardIntegrationId'
EXEC sp_OAMethod @jResp, 'IntOf', @messageHistoryCount OUT, 'switchboardIntegrations[i].messageHistoryCount'
SELECT @i = @i + 1
END
EXEC @hr = sp_OADestroy @http
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
Curl Command
curl -X GET
-u 'username:password'
https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations
Postman Collection Item JSON
{
"name": "List Switchboard Integrations",
"_postman_id": "21955de9-b9e9-49b5-ac24-7329e6adc085",
"request": {
"method": "GET",
"header": [
],
"url": {
"raw": "{{url}}/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations",
"host": [
"{{url}}"
],
"path": [
"v2",
"apps",
"{{appId}}",
"switchboards",
":switchboardId",
"switchboardIntegrations"
],
"variable": [
{
"key": "switchboardId"
}
]
},
"description": "Lists all switchboard integrations linked to the switchboard.\n"
},
"response": [
{
"id": "5a125be4-37d6-4eca-915f-529d3fc6b08a",
"name": "Ok",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/switchboards/:switchboardId/switchboardIntegrations",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"switchboards",
":switchboardId",
"switchboardIntegrations"
],
"variable": [
{
"key": "appId"
},
{
"key": "switchboardId"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json"
}
],
"cookie": [
],
"body": "{\n \"switchboardIntegrations\": [\n {\n \"id\": \"5ef21b86e933b7355c11c604\",\n \"name\": \"bot\",\n \"integrationId\": \"5ef21b86e933b7355c11c605\",\n \"integrationType\": \"zd:agentWorkspace\",\n \"deliverStandbyEvents\": true,\n \"nextSwitchboardIntegrationId\": \"5ef21b86e933b7355c11c606\",\n \"messageHistoryCount\": 5\n },\n {\n \"id\": \"5ef21b86e933b7355c11c604\",\n \"name\": \"bot\",\n \"integrationId\": \"5ef21b86e933b7355c11c605\",\n \"integrationType\": \"zd:agentWorkspace\",\n \"deliverStandbyEvents\": false,\n \"nextSwitchboardIntegrationId\": \"5ef21b86e933b7355c11c606\",\n \"messageHistoryCount\": 5\n }\n ]\n}"
},
{
"id": "feb621bd-7ff6-43cc-8238-947dd169c626",
"name": "Switchboard not found",
"originalRequest": {
"method": "GET",
"header": [
{
"description": {
"content": "Added as a part of security scheme: bearer",
"type": "text/plain"
},
"key": "Authorization",
"value": "Bearer <token>"
}
],
"url": {
"raw": "{{baseUrl}}/v2/apps/:appId/switchboards/:switchboardId/switchboardIntegrations",
"host": [
"{{baseUrl}}"
],
"path": [
"v2",
"apps",
":appId",
"switchboards",
":switchboardId",
"switchboardIntegrations"
],
"variable": [
{
"key": "appId"
},
{
"key": "switchboardId"
}
]
}
},
"status": "Not Found",
"code": 404,
"_postman_previewlanguage": "text",
"header": [
{
"key": "Content-Type",
"value": "text/plain"
}
],
"cookie": [
],
"body": ""
}
]
}
