Chilkat Online Tools

phpAx / Sunshine Conversations API / List Switchboard Integrations

Back to Collection Items

<?php

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

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$http->Login = 'username';
$http->Password = 'password';

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

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

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


?>

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