Chilkat Online Tools

Node.js / Sunshine Conversations API / List Switchboard Integrations

Back to Collection Items

var os = require('os');
if (os.platform() == 'win32') {  
    if (os.arch() == 'ia32') {
        var chilkat = require('@chilkat/ck-node21-win-ia32');
    } else {
        var chilkat = require('@chilkat/ck-node21-win64'); 
    }
} else if (os.platform() == 'linux') {
    if (os.arch() == 'arm') {
        var chilkat = require('@chilkat/ck-node21-arm');
    } else if (os.arch() == 'x86') {
        var chilkat = require('@chilkat/ck-node21-linux32');
    } else {
        var chilkat = require('@chilkat/ck-node21-linux64');
    }
} else if (os.platform() == 'darwin') {
    if (os.arch() == 'arm64') {
        var chilkat = require('@chilkat/ck-node21-mac-m1');
    } else {
        var chilkat = require('@chilkat/ck-node21-macosx');
    }
}


function chilkatExample() {

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

    var http = new chilkat.Http();
    var success;

    http.BasicAuth = true;
    http.Login = "username";
    http.Password = "password";

    var sbResponseBody = new chilkat.StringBuilder();
    success = http.QuickGetSb("https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations",sbResponseBody);
    if (success == false) {
        console.log(http.LastErrorText);
        return;
    }

    var jResp = new chilkat.JsonObject();
    jResp.LoadSb(sbResponseBody);
    jResp.EmitCompact = false;

    console.log("Response Body:");
    console.log(jResp.Emit());

    var respStatusCode = http.LastStatus;
    console.log("Response Status Code = " + respStatusCode);
    if (respStatusCode >= 400) {
        console.log("Response Header:");
        console.log(http.LastHeader);
        console.log("Failed.");
        return;
    }

    // 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

    var id;
    var name;
    var integrationId;
    var integrationType;
    var deliverStandbyEvents;
    var nextSwitchboardIntegrationId;
    var messageHistoryCount;

    var i = 0;
    var count_i = 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;
    }


}

chilkatExample();

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