Chilkat Online Tools

lianja / Sunshine Conversations API / List Switchboards

Back to Collection Items

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

loHttp = createobject("CkHttp")

loHttp.BasicAuth = .T.
loHttp.Login = "username"
loHttp.Password = "password"

loSbResponseBody = createobject("CkStringBuilder")
llSuccess = loHttp.QuickGetSb("https://domain.com/",loSbResponseBody)
if (llSuccess = .F.) then
    ? loHttp.LastErrorText
    release loHttp
    release loSbResponseBody
    return
endif

loJResp = createobject("CkJsonObject")
loJResp.LoadSb(loSbResponseBody)
loJResp.EmitCompact = .F.

? "Response Body:"
? loJResp.Emit()

lnRespStatusCode = loHttp.LastStatus
? "Response Status Code = " + str(lnRespStatusCode)
if (lnRespStatusCode >= 400) then
    ? "Response Header:"
    ? loHttp.LastHeader
    ? "Failed."
    release loHttp
    release loSbResponseBody
    release loJResp
    return
endif

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

// {
//   "switchboards": [
//     {
//       "id": "5ef21b132f21af34f088530d",
//       "enabled": true,
//       "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
//     },
//     {
//       "id": "5ef21b132f21af34f088530d",
//       "enabled": false,
//       "defaultSwitchboardIntegrationId": "5ef21b132f21af34f088530e"
//     }
//   ]
// }

// Sample code for parsing the JSON response...
// Use this online tool to generate parsing code from sample JSON: Generate JSON Parsing Code

i = 0
lnCount_i = loJResp.SizeOfArray("switchboards")
do while i < lnCount_i
    loJResp.I = i
    lcId = loJResp.StringOf("switchboards[i].id")
    llEnabled = loJResp.BoolOf("switchboards[i].enabled")
    lcDefaultSwitchboardIntegrationId = loJResp.StringOf("switchboards[i].defaultSwitchboardIntegrationId")
    i = i + 1
enddo


release loHttp
release loSbResponseBody
release loJResp

Curl Command

curl -X GET
	-u 'username:password'
https://domain.com/

Postman Collection Item JSON

{
  "name": "List Switchboards",
  "_postman_id": "fb83e8cc-bc12-40d6-bebc-9904b141967b",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": "{{url}}/v2/apps/{{appId}}/switchboards",
    "description": "Lists all switchboards belonging to the app.\n"
  },
  "response": [
    {
      "id": "2d07e434-7c51-4692-baa3-ce3bf447bdf9",
      "name": "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    },
    {
      "id": "53fe8d49-44d9-47b3-b664-b4022e371f56",
      "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",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "switchboards"
          ],
          "variable": [
            {
              "key": "appId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"switchboards\": [\n  {\n   \"id\": \"5ef21b132f21af34f088530d\",\n   \"enabled\": true,\n   \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n  },\n  {\n   \"id\": \"5ef21b132f21af34f088530d\",\n   \"enabled\": false,\n   \"defaultSwitchboardIntegrationId\": \"5ef21b132f21af34f088530e\"\n  }\n ]\n}"
    }
  ]
}