Chilkat Online Tools

autoit / Sunshine Conversations API / List Switchboard Integrations

Back to Collection Items

; This example assumes the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "username"
$oHttp.Password = "password"

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$bSuccess = $oHttp.QuickGetSb("https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations",$oSbResponseBody)
If ($bSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oHttp.LastStatus
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oHttp.LastHeader & @CRLF)
    ConsoleWrite("Failed." & @CRLF)
    Exit
EndIf

; 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

Local $sId
Local $sName
Local $sIntegrationId
Local $sIntegrationType
Local $bDeliverStandbyEvents
Local $sNextSwitchboardIntegrationId
Local $iMessageHistoryCount

Local $i = 0
Local $iCount_i = $oJResp.SizeOfArray("switchboardIntegrations")
While $i < $iCount_i
    $oJResp.I = $i
    $sId = $oJResp.StringOf("switchboardIntegrations[i].id")
    $sName = $oJResp.StringOf("switchboardIntegrations[i].name")
    $sIntegrationId = $oJResp.StringOf("switchboardIntegrations[i].integrationId")
    $sIntegrationType = $oJResp.StringOf("switchboardIntegrations[i].integrationType")
    $bDeliverStandbyEvents = $oJResp.BoolOf("switchboardIntegrations[i].deliverStandbyEvents")
    $sNextSwitchboardIntegrationId = $oJResp.StringOf("switchboardIntegrations[i].nextSwitchboardIntegrationId")
    $iMessageHistoryCount = $oJResp.IntOf("switchboardIntegrations[i].messageHistoryCount")
    $i = $i + 1
Wend

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": ""
    }
  ]
}