List Sessions

List all active sessions (admin endpoint)

GET /api/messaging/sessions

List all active sessions

cURL

curl --request GET \
  --url http://localhost:3000/api/messaging/sessions

import requests

url = "http://localhost:3000/api/messaging/sessions"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('http://localhost:3000/api/messaging/sessions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/api/messaging/sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/api/messaging/sessions"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("http://localhost:3000/api/messaging/sessions")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/api/messaging/sessions")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "sessions": [
    {
      "sessionId": "<string>",
      "agentId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "createdAt": "2023-11-07T05:31:56Z",
      "lastActivity": "2023-11-07T05:31:56Z",
      "metadata": {},
      "expiresAt": "2023-11-07T05:31:56Z",
      "timeoutConfig": {
        "timeoutMinutes": 123,
        "autoRenew": true,
        "maxDurationMinutes": 123,
        "warningThresholdMinutes": 123
      },
      "renewalCount": 123,
      "timeRemaining": 123,
      "isNearExpiration": true
    }
  ],
  "total": 123,
  "stats": {
    "totalSessions": 123,
    "activeSessions": 123,
    "expiredSessions": 123
  }
}

Response

200 - application/json

Sessions list retrieved successfully

sessions · object[]

Show child attributes

total · integer

Total number of active sessions

stats · object

Show child attributes