List Call Sessions

curl --request GET \
  --url https://api.ravan.ai/api/v1/calling/call-sessions \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.ravan.ai/api/v1/calling/call-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_URL => "https://api.ravan.ai/api/v1/calling/call-sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$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 := "https://api.ravan.ai/api/v1/calling/call-sessions"

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

	req.Header.Add("X-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ravan.ai/api/v1/calling/call-sessions")

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

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

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

{
  "success": <boolean>,
  "message": "<string>",
  "data": {
    "callSessions": [
      {
        "id": "<string>",
        "agentId": "<string>",
        "organizationId": "<string>",
        "roomId": "<string>",
        "callerNumber": "<string>",
        "calleeNumber": "<string>",
        "callerName": "<string>",
        "callerEmail": "<string>",
        "channel": "<string>",
        "status": "<string>",
        "summary": "<string>",
        "metadata": {},
        "errorMessage": "<string>",
        "disconnectReason": "<string>",
        "promptDynamicVariables": {},
        "extractDynamicVariables": null,
        "callLatencyMs": <integer>,
        "startedAt": "<string>",
        "endedAt": "<string>",
        "durationSec": <integer>,
        "createdAt": "<string>",
        "recordingUrl": "<string>",
        "costTotal": "<string>",
        "agentName": "<string>",
        "postCallAnalysisResult": {},
        "creditBreakdown": {
          "channel": "<string>",
          "duration_sec": <integer>,
          "model_credits": <number>,
          "provider_credits": <number>,
          "provider_managed": <boolean>,
          "telephony_type": "<string>",
          "total_credits": <number>
        }
      }
    ]
  }
}

GET

api

calling

call-sessions

List Call Sessions

curl --request GET \
  --url https://api.ravan.ai/api/v1/calling/call-sessions \
  --header 'X-Api-Key: <api-key>'

const options = {method: 'GET', headers: {'X-Api-Key': '<api-key>'}};

fetch('https://api.ravan.ai/api/v1/calling/call-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_URL => "https://api.ravan.ai/api/v1/calling/call-sessions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "X-Api-Key: <api-key>"
  ],
]);

$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 := "https://api.ravan.ai/api/v1/calling/call-sessions"

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

	req.Header.Add("X-Api-Key", "<api-key>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.ravan.ai/api/v1/calling/call-sessions")

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

request = Net::HTTP::Get.new(url)
request["X-Api-Key"] = '<api-key>'

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

{
  "success": <boolean>,
  "message": "<string>",
  "data": {
    "callSessions": [
      {
        "id": "<string>",
        "agentId": "<string>",
        "organizationId": "<string>",
        "roomId": "<string>",
        "callerNumber": "<string>",
        "calleeNumber": "<string>",
        "callerName": "<string>",
        "callerEmail": "<string>",
        "channel": "<string>",
        "status": "<string>",
        "summary": "<string>",
        "metadata": {},
        "errorMessage": "<string>",
        "disconnectReason": "<string>",
        "promptDynamicVariables": {},
        "extractDynamicVariables": null,
        "callLatencyMs": <integer>,
        "startedAt": "<string>",
        "endedAt": "<string>",
        "durationSec": <integer>,
        "createdAt": "<string>",
        "recordingUrl": "<string>",
        "costTotal": "<string>",
        "agentName": "<string>",
        "postCallAnalysisResult": {},
        "creditBreakdown": {
          "channel": "<string>",
          "duration_sec": <integer>,
          "model_credits": <number>,
          "provider_credits": <number>,
          "provider_managed": <boolean>,
          "telephony_type": "<string>",
          "total_credits": <number>
        }
      }
    ]
  }
}

Authorizations

string

required

Your Agni API key used to authenticate the request. Pass it in the X-Api-Key header. Find or rotate it from your Ravan AI account settings.

Query Parameters

integer

The page number to return. Page numbering starts at 1.

integer

The number of records to return per page.

string

The unique ID of the agent that should own, handle, or be assigned to this resource. Use the id returned by the Agent API.

string

Filters or sets the current status of the resource. Use one of the status values supported by the endpoint.

string

Filters calls by channel. Common values include voice, web, and sip.

string

Filters results by the caller phone number in E.164 format. Example: +14157774444.

string

A search string used to filter matching records by supported text fields.

string

The field to sort results by. Use one of the fields supported by the endpoint.

string

The sort direction. Use asc for ascending order or desc for descending order.

string

Filters calls that started after this ISO 8601 timestamp.

string

Filters calls that started before this ISO 8601 timestamp.

Response

boolean

Whether the request succeeded.

string

Human-readable status message.

object

Returned data.

Show data

array

Array of call session objects.

{
  "success": <boolean>,
  "message": "<string>",
  "data": {
    "callSessions": [
      {
        "id": "<string>",
        "agentId": "<string>",
        "organizationId": "<string>",
        "roomId": "<string>",
        "callerNumber": "<string>",
        "calleeNumber": "<string>",
        "callerName": "<string>",
        "callerEmail": "<string>",
        "channel": "<string>",
        "status": "<string>",
        "summary": "<string>",
        "metadata": {},
        "errorMessage": "<string>",
        "disconnectReason": "<string>",
        "promptDynamicVariables": {},
        "extractDynamicVariables": null,
        "callLatencyMs": <integer>,
        "startedAt": "<string>",
        "endedAt": "<string>",
        "durationSec": <integer>,
        "createdAt": "<string>",
        "recordingUrl": "<string>",
        "costTotal": "<string>",
        "agentName": "<string>",
        "postCallAnalysisResult": {},
        "creditBreakdown": {
          "channel": "<string>",
          "duration_sec": <integer>,
          "model_credits": <number>,
          "provider_credits": <number>,
          "provider_managed": <boolean>,
          "telephony_type": "<string>",
          "total_credits": <number>
        }
      }
    ]
  }
}

Authorizations

X-Api-Key

string

header

required

Query Parameters

page

integer

default:1

Page number

page_size

integer

default:20

Results per page

agent_id

string

Filter by agent ID

status

string

Filter by status

channel

string

Filter by channel

caller_number

string

Filter by caller number

string

Search term

sort_by

string

Sort field

sort_order

string

Sort order (asc/desc)

started_after

string

Filter after (ISO 8601)

started_before

string

Filter before (ISO 8601)

Response

200 - application/json

Successful response

success

boolean

message

string

data

object

Show child attributes

Example:

{
  "callSessions": [
    {
      "id": "<string>",
      "agentId": "<string>",
      "organizationId": "<string>",
      "roomId": "<string>",
      "callerNumber": "<string>",
      "calleeNumber": "<string>",
      "callerName": "<string>",
      "callerEmail": "<string>",
      "channel": "<string>",
      "status": "<string>",
      "summary": "<string>",
      "metadata": {},
      "errorMessage": "<string>",
      "disconnectReason": "<string>",
      "promptDynamicVariables": {},
      "extractDynamicVariables": null,
      "callLatencyMs": 0,
      "startedAt": "<string>",
      "endedAt": "<string>",
      "durationSec": 0,
      "createdAt": "<string>",
      "recordingUrl": "<string>",
      "costTotal": "<string>",
      "agentName": "<string>",
      "postCallAnalysisResult": {},
      "creditBreakdown": {
        "channel": "<string>",
        "duration_sec": 0,
        "model_credits": 0,
        "provider_credits": 0,
        "provider_managed": true,
        "telephony_type": "<string>",
        "total_credits": 0
      }
    }
  ]
}

Introduction

Agent API

Organization API

Agent Tool API

Phone Number & Telephony API

Campaign API

Contact API

Calling API

Appointment API

GHL Integration API

Cal.com Integration API

RAG Knowledge Base API

Webhooks

Health API

List Call Sessions

Authorizations

Query Parameters

Response

Authorizations

Query Parameters

Response

​Authorizations

​Query Parameters

​Response

Authorizations

Query Parameters

Response

Authorizations

Query Parameters

Response