Chilkat Online Tools

VB.NET / 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.

Dim http As New Chilkat.Http
Dim success As Boolean

http.BasicAuth = True
http.Login = "username"
http.Password = "password"


Dim sbResponseBody As New Chilkat.StringBuilder
success = http.QuickGetSb("https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations",sbResponseBody)
If (success = False) Then
    Debug.WriteLine(http.LastErrorText)
    Exit Sub
End If


Dim jResp As New Chilkat.JsonObject
jResp.LoadSb(sbResponseBody)
jResp.EmitCompact = False

Debug.WriteLine("Response Body:")
Debug.WriteLine(jResp.Emit())

Dim respStatusCode As Integer = http.LastStatus
Debug.WriteLine("Response Status Code = " & respStatusCode)
If (respStatusCode >= 400) Then
    Debug.WriteLine("Response Header:")
    Debug.WriteLine(http.LastHeader)
    Debug.WriteLine("Failed.")
    Exit Sub
End If


' 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



Dim id As String
Dim name As String
Dim integrationId As String
Dim integrationType As String
Dim deliverStandbyEvents As Boolean
Dim nextSwitchboardIntegrationId As String
Dim messageHistoryCount As Integer

Dim i As Integer = 0
Dim count_i As Integer = jResp.SizeOfArray("switchboardIntegrations")
While i < count_i
    jResp.I = i
    id = jResp.StringOf("switchboardIntegrations[i].id")
    name = jResp.StringOf("switchboardIntegrations[i].name")
    integrationId = jResp.StringOf("switchboardIntegrations[i].integrationId")
    integrationType = jResp.StringOf("switchboardIntegrations[i].integrationType")
    deliverStandbyEvents = jResp.BoolOf("switchboardIntegrations[i].deliverStandbyEvents")
    nextSwitchboardIntegrationId = jResp.StringOf("switchboardIntegrations[i].nextSwitchboardIntegrationId")
    messageHistoryCount = jResp.IntOf("switchboardIntegrations[i].messageHistoryCount")
    i = i + 1
End While

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