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";
// 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
// }
var json = new chilkat.JsonObject();
json.UpdateString("name","bot");
json.UpdateString("integrationType","zd:agentWorkspace");
json.UpdateBool("deliverStandbyEvents",true);
json.UpdateString("nextSwitchboardIntegrationId","5ef21b86e933b7355c11c606");
json.UpdateInt("messageHistoryCount",5);
http.SetRequestHeader("Content-Type","application/json");
// resp: HttpResponse
var resp = http.PostJson3("https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations","application/json",json);
if (http.LastMethodSuccess == false) {
console.log(http.LastErrorText);
return;
}
var sbResponseBody = new chilkat.StringBuilder();
resp.GetBodySb(sbResponseBody);
var jResp = new chilkat.JsonObject();
jResp.LoadSb(sbResponseBody);
jResp.EmitCompact = false;
console.log("Response Body:");
console.log(jResp.Emit());
var respStatusCode = resp.StatusCode;
console.log("Response Status Code = " + respStatusCode);
if (respStatusCode >= 400) {
console.log("Response Header:");
console.log(resp.Header);
console.log("Failed.");
return;
}
// 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
var Id = jResp.StringOf("switchboardIntegration.id");
var Name = jResp.StringOf("switchboardIntegration.name");
var IntegrationId = jResp.StringOf("switchboardIntegration.integrationId");
var IntegrationType = jResp.StringOf("switchboardIntegration.integrationType");
var DeliverStandbyEvents = jResp.BoolOf("switchboardIntegration.deliverStandbyEvents");
var NextSwitchboardIntegrationId = jResp.StringOf("switchboardIntegration.nextSwitchboardIntegrationId");
var MessageHistoryCount = jResp.IntOf("switchboardIntegration.messageHistoryCount");
}
chilkatExample();
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}"
}
]
}
