Back to Collection Items
LOCAL loHttp
LOCAL lnSuccess
LOCAL loJson
LOCAL loResp
LOCAL loSbResponseBody
LOCAL loJResp
LOCAL lnRespStatusCode
LOCAL lcId
LOCAL lcName
LOCAL lcIntegrationId
LOCAL lcIntegrationType
LOCAL lnDeliverStandbyEvents
LOCAL lcNextSwitchboardIntegrationId
LOCAL lnMessageHistoryCount
* 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 CreateObject('Chilkat_9_5_0.Http')
loHttp = CreateObject('Chilkat.Http')
loHttp.BasicAuth = 1
loHttp.Login = "username"
loHttp.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 CreateObject('Chilkat_9_5_0.JsonObject')
loJson = CreateObject('Chilkat.JsonObject')
loJson.UpdateString("name","bot")
loJson.UpdateString("integrationType","zd:agentWorkspace")
loJson.UpdateBool("deliverStandbyEvents",1)
loJson.UpdateString("nextSwitchboardIntegrationId","5ef21b86e933b7355c11c606")
loJson.UpdateInt("messageHistoryCount",5)
loHttp.SetRequestHeader("Content-Type","application/json")
loResp = loHttp.PostJson3("https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations","application/json",loJson)
IF (loHttp.LastMethodSuccess = 0) THEN
? loHttp.LastErrorText
RELEASE loHttp
RELEASE loJson
CANCEL
ENDIF
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.StringBuilder')
loSbResponseBody = CreateObject('Chilkat.StringBuilder')
loResp.GetBodySb(loSbResponseBody)
* For versions of Chilkat < 10.0.0, use CreateObject('Chilkat_9_5_0.JsonObject')
loJResp = CreateObject('Chilkat.JsonObject')
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = 0
? "Response Body:"
? loJResp.Emit()
lnRespStatusCode = loResp.StatusCode
? "Response Status Code = " + STR(lnRespStatusCode)
IF (lnRespStatusCode >= 400) THEN
? "Response Header:"
? loResp.Header
? "Failed."
RELEASE loResp
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
CANCEL
ENDIF
RELEASE loResp
* 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
lcId = loJResp.StringOf("switchboardIntegration.id")
lcName = loJResp.StringOf("switchboardIntegration.name")
lcIntegrationId = loJResp.StringOf("switchboardIntegration.integrationId")
lcIntegrationType = loJResp.StringOf("switchboardIntegration.integrationType")
lnDeliverStandbyEvents = loJResp.BoolOf("switchboardIntegration.deliverStandbyEvents")
lcNextSwitchboardIntegrationId = loJResp.StringOf("switchboardIntegration.nextSwitchboardIntegrationId")
lnMessageHistoryCount = loJResp.IntOf("switchboardIntegration.messageHistoryCount")
RELEASE loHttp
RELEASE loJson
RELEASE loSbResponseBody
RELEASE loJResp
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}"
}
]
}
