Chilkat Online Tools

Perl / Support API / List Sessions

Back to Collection Items

use chilkat();

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

$http = chilkat::CkHttp->new();

$http->put_BasicAuth(1);
$http->put_Login("login");
$http->put_Password("password");

$http->SetRequestHeader("Accept","application/json");

$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $http->QuickGetSb("https://example.zendesk.com/api/v2/sessions",$sbResponseBody);
if ($success == 0) {
    print $http->lastErrorText() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($sbResponseBody);
$jResp->put_EmitCompact(0);

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

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

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

# {
#   "sessions": [
#     {
#       "id": "<integer>",
#       "authenticated_at": "<string>",
#       "last_seen_at": "<string>",
#       "url": "<string>",
#       "user_id": "<integer>"
#     },
#     {
#       "id": "<integer>",
#       "authenticated_at": "<string>",
#       "last_seen_at": "<string>",
#       "url": "<string>",
#       "user_id": "<integer>"
#     }
#   ]
# }

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

$i = 0;
$count_i = $jResp->SizeOfArray("sessions");
while ($i < $count_i) {
    $jResp->put_I($i);
    $id = $jResp->stringOf("sessions[i].id");
    $authenticated_at = $jResp->stringOf("sessions[i].authenticated_at");
    $last_seen_at = $jResp->stringOf("sessions[i].last_seen_at");
    $url = $jResp->stringOf("sessions[i].url");
    $user_id = $jResp->stringOf("sessions[i].user_id");
    $i = $i + 1;
}

Curl Command

curl  -u login:password -X GET
	-H "Accept: application/json"
https://example.zendesk.com/api/v2/sessions

Postman Collection Item JSON

{
  "name": "List Sessions",
  "request": {
    "method": "GET",
    "header": [
      {
        "key": "Accept",
        "value": "application/json"
      }
    ],
    "url": {
      "raw": "{{baseUrl}}/api/v2/sessions",
      "host": [
        "{{baseUrl}}"
      ],
      "path": [
        "api",
        "v2",
        "sessions"
      ],
      "variable": [
        {
          "key": "user_id",
          "value": "<integer>",
          "description": "(Required) The id of the user"
        }
      ]
    },
    "description": "If authenticated as an admin, returns all the account's sessions. If authenticated as an agent or end user, returns only the sessions of the user making the request.\n\n#### Pagination\n\n- Cursor pagination (recommended)\n- Offset pagination\n\nSee [Pagination](/api-reference/introduction/pagination/).\n\n#### Allowed For\n\n* Admins, Agents, End users\n"
  },
  "response": [
    {
      "name": "Success response",
      "originalRequest": {
        "method": "GET",
        "header": [
          {
            "description": "Added as a part of security scheme: basic",
            "key": "Authorization",
            "value": "Basic <credentials>"
          }
        ],
        "url": {
          "raw": "{{baseUrl}}/api/v2/sessions",
          "host": [
            "{{baseUrl}}"
          ],
          "path": [
            "api",
            "v2",
            "sessions"
          ]
        }
      },
      "status": "OK",
      "code": 200,
      "_postman_previewlanguage": "json",
      "header": [
        {
          "key": "Content-Type",
          "value": "application/json"
        }
      ],
      "cookie": [
      ],
      "body": "{\n  \"sessions\": [\n    {\n      \"id\": \"<integer>\",\n      \"authenticated_at\": \"<string>\",\n      \"last_seen_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_id\": \"<integer>\"\n    },\n    {\n      \"id\": \"<integer>\",\n      \"authenticated_at\": \"<string>\",\n      \"last_seen_at\": \"<string>\",\n      \"url\": \"<string>\",\n      \"user_id\": \"<integer>\"\n    }\n  ]\n}"
    }
  ]
}