Chilkat Online Tools

phpAx / Sunshine Conversations API / Get Conversation

Back to Collection Items

<?php

// 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 new COM('Chilkat_9_5_0.Chilkat.Http')
$http = new COM("Chilkat.Http");

$http->BasicAuth = 1;
$http->Login = 'username';
$http->Password = 'password';

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.StringBuilder')
$sbResponseBody = new COM("Chilkat.StringBuilder");
$success = $http->QuickGetSb('https://domain.com/',$sbResponseBody);
if ($success == 0) {
    print $http->LastErrorText . "\n";
    exit;
}

// For versions of Chilkat < 10.0.0, use new COM('Chilkat_9_5_0.Chilkat.JsonObject')
$jResp = new COM("Chilkat.JsonObject");
$jResp->LoadSb($sbResponseBody);
$jResp->EmitCompact = 0;

print 'Response Body:' . "\n";
print $jResp->emit() . "\n";

$respStatusCode = $http->LastStatus;
print 'Response Status Code = ' . $respStatusCode . "\n";
if ($respStatusCode >= 400) {
    print 'Response Header:' . "\n";
    print $http->LastHeader . "\n";
    print 'Failed.' . "\n";
    exit;
}

// 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

$Id = $jResp->stringOf('conversation.id');
$v_Type = $jResp->stringOf('conversation.type');
$ActiveSwitchboardIntegrationId = $jResp->stringOf('conversation.activeSwitchboardIntegration.id');
$Name = $jResp->stringOf('conversation.activeSwitchboardIntegration.name');
$IntegrationId = $jResp->stringOf('conversation.activeSwitchboardIntegration.integrationId');
$IntegrationType = $jResp->stringOf('conversation.activeSwitchboardIntegration.integrationType');
$PendingSwitchboardIntegrationId = $jResp->stringOf('conversation.pendingSwitchboardIntegration.id');
$PendingSwitchboardIntegrationName = $jResp->stringOf('conversation.pendingSwitchboardIntegration.name');
$PendingSwitchboardIntegrationIntegrationId = $jResp->stringOf('conversation.pendingSwitchboardIntegration.integrationId');
$PendingSwitchboardIntegrationIntegrationType = $jResp->stringOf('conversation.pendingSwitchboardIntegration.integrationType');
$IsDefault = $jResp->BoolOf('conversation.isDefault');
$DisplayName = $jResp->stringOf('conversation.displayName');
$Description = $jResp->stringOf('conversation.description');
$IconUrl = $jResp->stringOf('conversation.iconUrl');
$Lang = $jResp->stringOf('conversation.metadata.lang');
$BusinessLastRead = $jResp->stringOf('conversation.businessLastRead');
$LastUpdatedAt = $jResp->stringOf('conversation.lastUpdatedAt');

?>

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": ""
    }
  ]
}