Chilkat Online Tools

lianja / Sunshine Conversations API / Get Conversation

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)

// {
//   "conversation": {
//     "id": "c93bb9c14dde8ffb94564eae",
//     "type": "personal",
//     "activeSwitchboardIntegration": {
//       "id": "5ef21b86e933b7355c11c604",
//       "name": "bot",
//       "integrationId": "5ef21b86e933b7355c11c605",
//       "integrationType": "zd:agentWorkspace"
//     },
//     "pendingSwitchboardIntegration": {
//       "id": "5ef21b86e933b7355c11c604",
//       "name": "bot",
//       "integrationId": "5ef21b86e933b7355c11c605",
//       "integrationType": "zd:agentWorkspace"
//     },
//     "isDefault": false,
//     "displayName": "pari",
//     "description": "Conversation between Rogers and Carl.",
//     "iconUrl": "https://www.gravatar.com/image.jpg",
//     "metadata": {
//       "lang": "en-ca"
//     },
//     "businessLastRead": "2020-06-23T14:33:47.492Z",
//     "lastUpdatedAt": "2020-06-26T14:33:47.120Z"
//   }
// }

// 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("conversation.id")
lcV_Type = loJResp.StringOf("conversation.type")
lcActiveSwitchboardIntegrationId = loJResp.StringOf("conversation.activeSwitchboardIntegration.id")
lcName = loJResp.StringOf("conversation.activeSwitchboardIntegration.name")
lcIntegrationId = loJResp.StringOf("conversation.activeSwitchboardIntegration.integrationId")
lcIntegrationType = loJResp.StringOf("conversation.activeSwitchboardIntegration.integrationType")
lcPendingSwitchboardIntegrationId = loJResp.StringOf("conversation.pendingSwitchboardIntegration.id")
lcPendingSwitchboardIntegrationName = loJResp.StringOf("conversation.pendingSwitchboardIntegration.name")
lcPendingSwitchboardIntegrationIntegrationId = loJResp.StringOf("conversation.pendingSwitchboardIntegration.integrationId")
lcPendingSwitchboardIntegrationIntegrationType = loJResp.StringOf("conversation.pendingSwitchboardIntegration.integrationType")
llIsDefault = loJResp.BoolOf("conversation.isDefault")
lcDisplayName = loJResp.StringOf("conversation.displayName")
lcDescription = loJResp.StringOf("conversation.description")
lcIconUrl = loJResp.StringOf("conversation.iconUrl")
lcLang = loJResp.StringOf("conversation.metadata.lang")
lcBusinessLastRead = loJResp.StringOf("conversation.businessLastRead")
lcLastUpdatedAt = loJResp.StringOf("conversation.lastUpdatedAt")


release loHttp
release loSbResponseBody
release loJResp

Curl Command

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

Postman Collection Item JSON

{
  "name": "Get Conversation",
  "_postman_id": "ffbb4dbd-fbf6-43f4-9e0c-6be5c4e2829c",
  "request": {
    "method": "GET",
    "header": [
    ],
    "url": "{{url}}/v2/apps/{{appId}}/conversations/{{conversationId}}",
    "description": "Fetches an individual conversation."
  },
  "response": [
    {
      "id": "90c0f930-c5be-456b-93fd-2d14edac480c",
      "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/conversations/:conversationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations",
            ":conversationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "conversationId"
            }
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n \"conversation\": {\n  \"id\": \"c93bb9c14dde8ffb94564eae\",\n  \"type\": \"personal\",\n  \"activeSwitchboardIntegration\": {\n   \"id\": \"5ef21b86e933b7355c11c604\",\n   \"name\": \"bot\",\n   \"integrationId\": \"5ef21b86e933b7355c11c605\",\n   \"integrationType\": \"zd:agentWorkspace\"\n  },\n  \"pendingSwitchboardIntegration\": {\n   \"id\": \"5ef21b86e933b7355c11c604\",\n   \"name\": \"bot\",\n   \"integrationId\": \"5ef21b86e933b7355c11c605\",\n   \"integrationType\": \"zd:agentWorkspace\"\n  },\n  \"isDefault\": false,\n  \"displayName\": \"pari\",\n  \"description\": \"Conversation between Rogers and Carl.\",\n  \"iconUrl\": \"https://www.gravatar.com/image.jpg\",\n  \"metadata\": {\n   \"lang\": \"en-ca\"\n  },\n  \"businessLastRead\": \"2020-06-23T14:33:47.492Z\",\n  \"lastUpdatedAt\": \"2020-06-26T14:33:47.120Z\"\n }\n}"
    },
    {
      "id": "d66e4f40-123a-4f32-8858-445be2b989d3",
      "name": "Conversation 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/conversations/:conversationId",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "v2",
            "apps",
            ":appId",
            "conversations",
            ":conversationId"
          ],
          "variable": [
            {
              "key": "appId"
            },
            {
              "key": "conversationId"
            }
          ]
        }
      },
      "status": "Not Found",
      "code": 404,
      "_postman_previewlanguage": "text",
      "header": [
        {
          "key": "Content-Type",
          "value": "text/plain"
        }
      ],
      "cookie": [
      ],
      "body": ""
    }
  ]
}