Chilkat Online Tools

phpAx / Sunshine Conversations API / Create Switchboard Integration

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';

// Use this online tool to generate code from sample JSON: Generate Code to Create JSON

// The following JSON is sent in the request body.

// {
//   "name": "bot",
//   "integrationType": "zd:agentWorkspace",
//   "deliverStandbyEvents": true,
//   "nextSwitchboardIntegrationId": "5ef21b86e933b7355c11c606",
//   "messageHistoryCount": 5
// }

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$json = new COM("Chilkat.JsonObject");
$json->UpdateString('name','bot');
$json->UpdateString('integrationType','zd:agentWorkspace');
$json->UpdateBool('deliverStandbyEvents',1);
$json->UpdateString('nextSwitchboardIntegrationId','5ef21b86e933b7355c11c606');
$json->UpdateInt('messageHistoryCount',5);

$http->SetRequestHeader('Content-Type','application/json');

// resp is a Chilkat.HttpResponse
$resp = $http->PostJson3('https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations','application/json',$json);
if ($http->LastMethodSuccess == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$resp->GetBodySb($sbResponseBody);

// 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 = $resp->StatusCode;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $resp->Header . "\n";
    print 'Failed.' . "\n";

    exit;
}

// Sample JSON response:
// (Sample code for parsing the JSON response is shown below)

// {
//   "switchboardIntegration": {
//     "id": "5ef21b86e933b7355c11c604",
//     "name": "bot",
//     "integrationId": "5ef21b86e933b7355c11c605",
//     "integrationType": "zd:agentWorkspace",
//     "deliverStandbyEvents": true,
//     "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

$Id = $jResp->stringOf('switchboardIntegration.id');
$Name = $jResp->stringOf('switchboardIntegration.name');
$IntegrationId = $jResp->stringOf('switchboardIntegration.integrationId');
$IntegrationType = $jResp->stringOf('switchboardIntegration.integrationType');
$DeliverStandbyEvents = $jResp->BoolOf('switchboardIntegration.deliverStandbyEvents');
$NextSwitchboardIntegrationId = $jResp->stringOf('switchboardIntegration.nextSwitchboardIntegrationId');
$MessageHistoryCount = $jResp->IntOf('switchboardIntegration.messageHistoryCount');

?>

Curl Command

curl -X POST
	-u 'username:password'
	-H "Content-Type: application/json"
	-d '{
    "name": "bot",
    "integrationType": "zd:agentWorkspace",
    "deliverStandbyEvents": true,
    "nextSwitchboardIntegrationId": "5ef21b86e933b7355c11c606",
    "messageHistoryCount": 5
}'
https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations

Postman Collection Item JSON

{
  "name": "Create Switchboard Integration",
  "_postman_id": "9dc9c6be-a814-4995-8787-f493a5aa11d2",
  "request": {
    "method": "POST",
    "header": [
      {
        "key": "Content-Type",
        "value": "application/json"
      }
    ],
    "body": {
      "mode": "raw",
      "raw": "{\n    \"name\": \"bot\",\n    \"integrationType\": \"zd:agentWorkspace\",\n    \"deliverStandbyEvents\": true,\n    \"nextSwitchboardIntegrationId\": \"5ef21b86e933b7355c11c606\",\n    \"messageHistoryCount\": 5\n}"
    },
    "url": {
      "raw": "{{url}}/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "switchboards",
        ":switchboardId",
        "switchboardIntegrations"
      ],
      "variable": [
        {
          "key": "switchboardId"
        }
      ]
    },
    "description": "Create a switchboard integration."
  },
  "response": [
    {
      "id": "39839588-4599-4f5d-93a9-03ca6b518509",
      "name": "Only one switchboard per app can be created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"bot\",\n    \"integrationType\": \"zd:agentWorkspace\",\n    \"deliverStandbyEvents\": true,\n    \"nextSwitchboardIntegrationId\": \"5ef21b86e933b7355c11c606\",\n    \"messageHistoryCount\": 5\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/switchboards/:switchboardId/switchboardIntegrations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards",
            ":switchboardId",
            "switchboardIntegrations"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "switchboardId"
            }
          ]
        }
      },
      "status": "Bad Request",
      "code": 400,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "8d11acac-f676-4126-9ead-4c6524fb9f64",
      "name": "Switchboard not found",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"bot\",\n    \"integrationType\": \"zd:agentWorkspace\",\n    \"deliverStandbyEvents\": true,\n    \"nextSwitchboardIntegrationId\": \"5ef21b86e933b7355c11c606\",\n    \"messageHistoryCount\": 5\n}"
        },
        "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": ""
    },
    {
      "id": "e3926a73-1ec1-4910-b9b4-0ea1500954eb",
      "name": "Created",
      "originalRequest": {
        "method": "POST",
        "header": [
          {
            "description": {
              "content": "Added as a part of security scheme: bearer",
              "type": "text/plain"
            },
            "key": "Authorization",
            "value": "Bearer <token>"
          }
        ],
        "body": {
          "mode": "raw",
          "raw": "{\n    \"name\": \"bot\",\n    \"integrationType\": \"zd:agentWorkspace\",\n    \"deliverStandbyEvents\": true,\n    \"nextSwitchboardIntegrationId\": \"5ef21b86e933b7355c11c606\",\n    \"messageHistoryCount\": 5\n}"
        },
        "url": {
          "raw": "{{baseUrl}}/v2/apps/:appId/switchboards/:switchboardId/switchboardIntegrations",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards",
            ":switchboardId",
            "switchboardIntegrations"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "switchboardId"
            }
          ]
        }
      },
      "status": "Created",
      "code": 201,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"switchboardIntegration\": {\n  \"id\": \"5ef21b86e933b7355c11c604\",\n  \"name\": \"bot\",\n  \"integrationId\": \"5ef21b86e933b7355c11c605\",\n  \"integrationType\": \"zd:agentWorkspace\",\n  \"deliverStandbyEvents\": true,\n  \"nextSwitchboardIntegrationId\": \"5ef21b86e933b7355c11c606\",\n  \"messageHistoryCount\": 5\n }\n}"
    }
  ]
}