Chilkat Online Tools

autoit / Sunshine Conversations API / Update Switchboard Integration

Back to Collection Items

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

$oHttp = ObjCreate("Chilkat.Http")
Local $bSuccess

$oHttp.BasicAuth = True
$oHttp.Login = "username"
$oHttp.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
; }

$oJson = ObjCreate("Chilkat.JsonObject")
$oJson.UpdateString("name","bot")
$oJson.UpdateString("integrationType","zd:agentWorkspace")
$oJson.UpdateBool("deliverStandbyEvents",True)
$oJson.UpdateString("nextSwitchboardIntegrationId","5ef21b86e933b7355c11c606")
$oJson.UpdateInt("messageHistoryCount",5)

$oHttp.SetRequestHeader "Content-Type","application/json"

$oSbRequestBody = ObjCreate("Chilkat.StringBuilder")
$oJson.EmitSb($oSbRequestBody)

Local $oResp = $oHttp.PTextSb("PATCH","https://domain.com/v2/apps/{{appId}}/switchboards/:switchboardId/switchboardIntegrations/:switchboardIntegrationId",$oSbRequestBody,"utf-8","application/json",False,False)
If ($oHttp.LastMethodSuccess = False) Then
    ConsoleWrite($oHttp.LastErrorText & @CRLF)
    Exit
EndIf

$oSbResponseBody = ObjCreate("Chilkat.StringBuilder")
$oResp.GetBodySb($oSbResponseBody)

$oJResp = ObjCreate("Chilkat.JsonObject")
$oJResp.LoadSb($oSbResponseBody)
$oJResp.EmitCompact = False

ConsoleWrite("Response Body:" & @CRLF)
ConsoleWrite($oJResp.Emit() & @CRLF)

Local $iRespStatusCode = $oResp.StatusCode
ConsoleWrite("Response Status Code = " & $iRespStatusCode & @CRLF)
If ($iRespStatusCode >= 400) Then
    ConsoleWrite("Response Header:" & @CRLF)
    ConsoleWrite($oResp.Header & @CRLF)
    ConsoleWrite("Failed." & @CRLF)

    Exit
EndIf

; 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

Local $sId = $oJResp.StringOf("switchboardIntegration.id")
Local $sName = $oJResp.StringOf("switchboardIntegration.name")
Local $sIntegrationId = $oJResp.StringOf("switchboardIntegration.integrationId")
Local $sIntegrationType = $oJResp.StringOf("switchboardIntegration.integrationType")
Local $bDeliverStandbyEvents = $oJResp.BoolOf("switchboardIntegration.deliverStandbyEvents")
Local $sNextSwitchboardIntegrationId = $oJResp.StringOf("switchboardIntegration.nextSwitchboardIntegrationId")
Local $iMessageHistoryCount = $oJResp.IntOf("switchboardIntegration.messageHistoryCount")

Curl Command

curl -X PATCH
	-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/:switchboardIntegrationId

Postman Collection Item JSON

{
  "name": "Update Switchboard Integration",
  "_postman_id": "8bdfa234-93ff-4910-8436-4b820fcaeb45",
  "request": {
    "method": "PATCH",
    "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/:switchboardIntegrationId",
      "host": [
        "{{url}}"
      ],
      "path": [
        "v2",
        "apps",
        "{{appId}}",
        "switchboards",
        ":switchboardId",
        "switchboardIntegrations",
        ":switchboardIntegrationId"
      ],
      "variable": [
        {
          "key": "switchboardId"
        },
        {
          "key": "switchboardIntegrationId"
        }
      ]
    },
    "description": "Updates a switchboard integration record."
  },
  "response": [
    {
      "id": "779da036-39be-4849-853b-49a9485ea4fe",
      "name": "Ok",
      "originalRequest": {
        "method": "PATCH",
        "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/:switchboardIntegrationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards",
            ":switchboardId",
            "switchboardIntegrations",
            ":switchboardIntegrationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "switchboardId"
            },
            {
              "key": "switchboardIntegrationId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_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}"
    },
    {
      "id": "d52dad4e-71a0-4ab5-a58f-3568a48f608e",
      "name": "Enabled switchboard must have an associated default switchboardIntegration",
      "originalRequest": {
        "method": "PATCH",
        "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/:switchboardIntegrationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards",
            ":switchboardId",
            "switchboardIntegrations",
            ":switchboardIntegrationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "switchboardId"
            },
            {
              "key": "switchboardIntegrationId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}