List calls

curl --request GET \
  --url https://api.callrounded.com/v1/calls \
  --header 'X-Api-Key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "status": "created",
      "from_number": "<string>",
      "to_number": "<string>",
      "direction": "inbound",
      "organization_id": "123e4567-e89b-12d3-a456-426614174001",
      "type": "phone_call",
      "agent_id": "123e4567-e89b-12d3-a456-426614174002",
      "metadata": {
        "source": "marketing_campaign",
        "utm_medium": "email"
      },
      "start_time": "2023-06-15T14:30:00Z",
      "end_time": "2023-06-15T14:35:00Z",
      "duration_seconds": 300,
      "redirect_duration_seconds": 5,
      "cost": 0.15,
      "transcript_string": "Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status.",
      "transcript": [
        {
          "role": "user",
          "start_time": "2023-11-07T05:31:56Z",
          "content": "<string>"
        }
      ],
      "variable_values": [
        {
          "name": "<string>",
          "type": "string",
          "value": "John Doe",
          "timestamp": "2023-06-15T14:33:12Z"
        }
      ],
      "answer_type": "human",
      "recording_url": "https://rounded-twilio.s3.amazonaws.com/calls/test?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=TEST%2F20250401%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20250401T163838Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=046d4f7da8a7f2343875872593cbaa94a7836c42e1fd669e91fc2af9cf2b43be",
      "secure_recording_url": true
    }
  ],
  "message": "Calls retrieved successfully",
  "status": 200,
  "next_cursor": "<string>",
  "current_page": 123,
  "total_pages": 123,
  "total_items": 123
}

calls

List calls

List calls with filtering options. Results are paginated and can be filtered by various parameters. Pagination Options:

Cursor-based pagination (default):
- Set use_cursor=true.
- Provide limit parameter to control results per page (default: 50, max: 1000).
- Response includes next_cursor for subsequent requests.
- Best for efficiently paging through large datasets.
Page-based pagination:
- Set use_cursor=false.
- Provide page and limit parameters.
- Response includes current_page, total_pages, and total_items.
- Best for UIs that need to jump to specific pages.

GET

calls

List calls

curl --request GET \
  --url https://api.callrounded.com/v1/calls \
  --header 'X-Api-Key: <api-key>'

{
  "data": [
    {
      "id": "<string>",
      "status": "created",
      "from_number": "<string>",
      "to_number": "<string>",
      "direction": "inbound",
      "organization_id": "123e4567-e89b-12d3-a456-426614174001",
      "type": "phone_call",
      "agent_id": "123e4567-e89b-12d3-a456-426614174002",
      "metadata": {
        "source": "marketing_campaign",
        "utm_medium": "email"
      },
      "start_time": "2023-06-15T14:30:00Z",
      "end_time": "2023-06-15T14:35:00Z",
      "duration_seconds": 300,
      "redirect_duration_seconds": 5,
      "cost": 0.15,
      "transcript_string": "Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status.",
      "transcript": [
        {
          "role": "user",
          "start_time": "2023-11-07T05:31:56Z",
          "content": "<string>"
        }
      ],
      "variable_values": [
        {
          "name": "<string>",
          "type": "string",
          "value": "John Doe",
          "timestamp": "2023-06-15T14:33:12Z"
        }
      ],
      "answer_type": "human",
      "recording_url": "https://rounded-twilio.s3.amazonaws.com/calls/test?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=TEST%2F20250401%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20250401T163838Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=046d4f7da8a7f2343875872593cbaa94a7836c42e1fd669e91fc2af9cf2b43be",
      "secure_recording_url": true
    }
  ],
  "message": "Calls retrieved successfully",
  "status": 200,
  "next_cursor": "<string>",
  "current_page": 123,
  "total_pages": 123,
  "total_items": 123
}

Authorizations

X-Api-Key

string

header

required

The API Key created in Rounded Studio.

You can create it by going to the "API Keys" settings of your profile.
Need help? You can email us at [email protected] or join our Discord community.

Query Parameters

agent_id

string | null

Filter calls by the agent ID that handled them.

call_type

enum<string> | null

Filter by call type (e.g., phone_call or web_call).

Available options:

phone_call,

web_call

from_number

string | null

Filter by the phone number that initiated the call (E.164 format with + prefix).

to_number

string | null

Filter by the destination phone number of the call (E.164 format with + prefix).

start_time_gt

string | null

Return only calls with start_time greater than this value (ISO 8601 format).

start_time_lt

string | null

Return only calls with start_time less than this value (ISO 8601 format).

cursor

string | null

Cursor for pagination (ISO 8601 datetime of last seen record).

page

integer | null

Page number for page-based pagination (1-indexed, only used when use_cursor=false).

limit

integer | null

default:50

Maximum number of results to return per page (default: 50, max: 1000).

use_cursor

boolean | null

default:true

Pagination mode selection: true for cursor-based pagination, false for page-based pagination.

include_transcript

boolean | null

default:false

Whether to include transcript data in the response.

include_variable_values

boolean | null

default:false

Whether to include variable values in the response.

Response

Successfully retrieved calls

data

(PhoneCallGetApiResponseData · object | WebCallGetApiResponseData · object)[]

required

List of call objects matching the query criteria.

PhoneCallGetApiResponseData
WebCallGetApiResponseData

Show child attributes

data.id

string

required

Unique identifier for the call.

data.status

enum<string>

required

Current status of the call.

Possible values:

created - Call has been created but not yet queued.
queued - Call is waiting to be processed.
dequeued - Call has been dequeued and is waiting to be initiated.
initiated - Call has been initiated but not yet connected.
ringing - Phone is ringing at the destination.
connected - Call has been answered and is connected.
in_progress - Call is actively in progress with conversation.
completed - Call has ended successfully.
redirection_completed - Call was redirected and completed.
busy - Destination was busy when called.
no_answer - Call was not answered by the destination (no human answer).
canceled - Call was canceled before connection.
failed - Call failed due to technical issues.

Available options:

created,

queued,

dequeued,

initiated,

ringing,

connected,

in_progress,

completed,

redirection_completed,

busy,

no_answer,

canceled,

failed

data.from_number

string

required

Phone number that initiated the call.

data.to_number

string

required

Phone number that received the call.

data.direction

enum<string>

required

Direction of the call (inbound or outbound)

Available options:

inbound,

outbound

data.organization_id

string | null

ID of the organization the call belongs to.

Example:

"123e4567-e89b-12d3-a456-426614174001"

data.type

enum<string>

default:phone_call

Indicates this is a phone call.

Available options:

phone_call,

web_call

data.agent_id

string | null

ID of the agent handling the call.

Example:

"123e4567-e89b-12d3-a456-426614174002"

data.metadata

Metadata · object

Additional metadata associated with the call. If an error occurs while processing the call, the metadata will contain the error message.

Example:

{
  "source": "marketing_campaign",
  "utm_medium": "email"
}

data.start_time

string<date-time> | null

Timestamp when the call started.

Example:

"2023-06-15T14:30:00Z"

data.end_time

string<date-time> | null

Timestamp when the call ended.

Example:

"2023-06-15T14:35:00Z"

data.duration_seconds

integer | null

Duration of the call in seconds.

Example:

300

data.redirect_duration_seconds

integer | null

Duration of call redirection in seconds.

Example:

5

data.cost

number | null

Estimation of the cost of the call in EUR.

Example:

0.15

data.transcript_string

string | null

Plain text representation of the call transcript.

Example:

"Agent: Hello, how can I help you today?\nUser: I'd like to check on my order status."

data.transcript

(Message Content · object | Tool Call · object | Tool Response · object | Task Switch · object)[] | null

Structured representation of the call transcript with messages and tool calls.

Response schema for regular message content.

Message Content
Tool Call
Tool Response
Task Switch

Show child attributes

data.transcript.role

enum<string>

required

Role of the entity sending the message (user, agent, tool, etc.).

Available options:

user,

agent,

tool,

task_switch

data.transcript.start_time

string<date-time>

required

Timestamp when the message was created.

data.transcript.content

string

required

The actual text content of the message.

data.variable_values

VariableValueApiResponseData · object[] | null

Values of variables collected during the call.

Show child attributes

data.variable_values.name

string

required

Name of the variable.

data.variable_values.type

enum<string>

required

Data type of the variable.

Available options:

string,

boolean,

number,

datetime,

json

data.variable_values.value

string | null

The actual value of the variable as a string.

Example:

"John Doe"

data.variable_values.timestamp

string<date-time> | null

When the variable was last updated.

Example:

"2023-06-15T14:33:12Z"

data.answer_type

Type of answer received from the destination.

Possible values:

human - Call was answered by a human.
machine - Call was answered by a machine.
unknown - Answer type could not be determined.

Available options:

human,

machine,

unknown

Example:

"human"

data.recording_url

string | null

If agent has enabled securing recording urls, this will be a signed URL of the call recording with 1 hour expiration time, otherwise it will be a non-expiring URL.

Example:

"https://rounded-twilio.s3.amazonaws.com/calls/test?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=TEST%2F20250401%2Feu-west-3%2Fs3%2Faws4_request&X-Amz-Date=20250401T163838Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host&X-Amz-Signature=046d4f7da8a7f2343875872593cbaa94a7836c42e1fd669e91fc2af9cf2b43be"

data.secure_recording_url

boolean

default:true

Whether the recording URL should expire or not, the value is determined by the agent's settings when the call was created.

message

string

default:Calls retrieved successfully

Response message indicating the status of the request.

status

integer

default:200

HTTP status code (200 for successful requests).

next_cursor

string | null

Next cursor value for cursor-based pagination (ISO 8601 datetime string, only present when use_cursor=true).

current_page

integer | null

Current page number (only present when use_cursor=false).

total_pages

integer | null

Total number of pages available (only present when use_cursor=false).

total_items

integer | null

Total count of items matching the query criteria (only present when use_cursor=false).

Update call Terminate call

⌘I

calls

knowledge bases

agents

phone-numbers

List calls

Authorizations

Query Parameters

Response