Skip to content

List calls

GET
/calls
import { createClient, createResources } from "@morevoice/sdk";
const mv = createResources({
client: createClient({ baseUrl: "https://api.morevoice.ai/v1", auth: process.env.MOREVOICE_API_KEY }),
});
for await (const call of mv.calls.list()) {
console.log(call);
}

The organisation’s calls, newest first. Test-mode keys see only test calls. Filter by status, direction, type, assistant, campaign, agent, number or start time (created[gte], created[lt]…).

Try it in the API playground with a test-mode key.

limit
integer
default: 20 >= 1 <= 100

How many objects to return, 1–100 (default 20).

starting_after
string
>= 1 characters <= 512 characters

A cursor (next_cursor) or object ID: return the objects after it (older).

ending_before
string
>= 1 characters <= 512 characters

A cursor or object ID: return the objects before it (newer).

status
string
Allowed values: in_progress ended

in_progress: calls that have not ended (queued, ringing or answered). ended: finished calls.

direction
string
Allowed values: inbound outbound browser
type
string
Allowed values: ai human ivr conference voicemail
assistant_id
string
<= 200 characters /^asst_[0-9A-Za-z]+$/

A assistant ID (asst_…).

campaign_id
string
<= 200 characters /^cmp_[0-9A-Za-z]+$/

A campaign ID (cmp_…).

agent_id
string
<= 200 characters /^usr_[0-9A-Za-z]+$/

A user ID (usr_…).

from
string
>= 1 characters <= 64 characters

Calls from this number, exactly as recorded on the call.

to
string
>= 1 characters <= 64 characters

Calls to this number, exactly as recorded on the call.

created

Filter on started_at: created[gte], created[gt], created[lte], created[lt] (ISO-8601).

object
gt
string format: date-time
<= 40 characters
gte
string format: date-time
<= 40 characters
lt
string format: date-time
<= 40 characters
lte
string format: date-time
<= 40 characters
expand
Array<string>
<= 10 items

Fields to expand into objects, e.g. expand[]=assistant.

MoreVoice-Version
string
/^\d{4}-\d{2}-\d{2}$/

The API version to use for this request. Defaults to the version the API key is pinned to.

Example
2026-11-01

OK

Media typeapplication/json

A page of calls, newest first.

object
data
required
Array<object>

An inbound, outbound or browser call.

object
agent_id
required
Any of:

A user ID (prefix usr_).

string
/^usr_[0-9A-Za-z]+$/
answered_at
required
Any of:

An ISO-8601 timestamp in UTC.

string format: date-time
answered_by
required
Any of:

The answering-machine detection verdict.

string
Allowed values: human machine unknown
api_key_id
required
Any of:

A api key ID (prefix key_).

string
/^key_[0-9A-Za-z]+$/
assistant

The assistant, with expand[]=assistant.

object
id
required

A assistant ID (prefix asst_).

string
/^asst_[0-9A-Za-z]+$/
name
required
string
object
required
string
Allowed value: assistant
assistant_id
required
Any of:

A assistant ID (prefix asst_).

string
/^asst_[0-9A-Za-z]+$/
campaign_id
required
Any of:

A campaign ID (prefix cmp_).

string
/^cmp_[0-9A-Za-z]+$/
connection_id
required
Any of:

A connection ID (prefix conn_).

string
/^conn_[0-9A-Za-z]+$/
contact_id
required
Any of:

A contact ID (prefix ctc_).

string
/^ctc_[0-9A-Za-z]+$/
cost
required
Any of:

What the call cost (an ended call with no recorded provider usage costs 0).

object
amount
required

The amount in the currency’s minor unit (cents, agorot), rounded.

integer
>= -9007199254740991 <= 9007199254740991
amount_decimal
required

The exact amount in minor units, as a decimal string (sub-cent precision).

string
/^-?\d+(\.\d+)?$/
currency
required

ISO 4217 currency code.

string
/^[A-Z]{3}$/
estimate
required

True: an estimate from provider usage, not a billed amount.

boolean
direction
required
Any of:

browser: a call from a web page (the dashboard, a widget). Same values as the call.* webhook events.

string
Allowed values: inbound outbound browser
disposition
required

The business outcome recorded on the call (set_outcome tool, or the summary).

string | null
duration_ms
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
end_reason
required

Why the call ended, e.g. customer-ended-call, assistant-ended-call, customer-busy, customer-did-not-answer.

string | null
ended_at
required
Any of:

An ISO-8601 timestamp in UTC.

string format: date-time
flow_id
required
Any of:

A flow ID (prefix flow_).

string
/^flow_[0-9A-Za-z]+$/
flow_version
required
Any of:
integer
>= -9007199254740991 <= 9007199254740991
from
required

The calling number (E.164 when it is a phone number) or name.

string | null
has_recording
required
boolean
id
required

A call ID (prefix call_).

string
/^call_[0-9A-Za-z]+$/
livemode
required

true in live mode, false in test mode.

boolean
metadata
required

Up to 50 key/value pairs (keys up to 40 characters, values up to 500) you attach to an object. Returned as sent.

object
<= 50 properties
key
additional properties
string
<= 500 characters
object
required
string
Allowed value: call
purpose
required
Any of:

Why an outbound call is made. marketing adds the §30A consent and national do-not-call registry checks.

string
Allowed values: service marketing survey
queue_id
required
Any of:

A queue ID (prefix q_).

string
/^q_[0-9A-Za-z]+$/
started_at
required

When the call started: dialled out, or rang in.

string format: date-time
status
required

queued (placed, not ringing yet), ringing, in_progress (answered, or an inbound call being handled) or ended.

string
Allowed values: queued ringing in_progress ended
summary
required
Any of:

The AI summary of a call.

object
action_items
required

Follow-ups for your business; empty when there are none.

Array<string>
call_id
required

A call ID (prefix call_).

string
/^call_[0-9A-Za-z]+$/
generated_at
required
Any of:

An ISO-8601 timestamp in UTC.

string format: date-time
intent
required

What the caller wanted.

string
key_points
required
Array<string>
object
required
string
Allowed value: call_summary
outcome
required

How the call ended, or what was agreed.

string
sentiment
required
string
Allowed values: positive neutral negative mixed
text
required

A two-to-four sentence summary, in the language of the call.

string
to
required

The called number (E.164 when it is a phone number) or destination.

string | null
transport
required

sip for phone calls, webrtc for browser calls and conference rooms.

string
Allowed values: sip webrtc
type
required

Who handles the call: an AI assistant, a human agent, an IVR flow, a conference room, or a voicemail box.

string
Allowed values: ai human ivr conference voicemail
variables
required

The variables the call was created with.

object
key
additional properties
string
has_more
required

Whether more objects follow in the requested direction.

boolean
next_cursor
required

Pass as starting_after (or ending_before, when paging backwards) to continue; null on the last page.

string | null
object
required
string
Allowed value: list
url
required

The list’s path.

string
Example
{
"data": [
{
"agent_id": null,
"answered_at": "2026-11-03T09:14:29.410Z",
"answered_by": "human",
"api_key_id": "key_9i2E2pKO6g3z4nXl57Qb4g",
"assistant_id": "asst_4Gk2LmN9pQ4rS6tV8wX0yZ",
"campaign_id": null,
"connection_id": "conn_2bF8kQ1nR7sT3vW5xY9zA0",
"contact_id": null,
"cost": {
"amount": 4,
"amount_decimal": "4.2310",
"currency": "USD",
"estimate": true
},
"direction": "outbound",
"disposition": null,
"duration_ms": 99710,
"end_reason": "customer-ended-call",
"ended_at": "2026-11-03T09:16:02.120Z",
"flow_id": null,
"flow_version": null,
"from": "+97237654321",
"has_recording": true,
"id": "call_8tRPaZp5hLMbrGqdJ9AmNa",
"livemode": true,
"metadata": {
"crm_contact_id": "0031x00000AbCdE"
},
"object": "call",
"purpose": "service",
"queue_id": null,
"started_at": "2026-11-03T09:14:22.000Z",
"status": "ended",
"summary": null,
"to": "+972501234567",
"transport": "sip",
"type": "ai",
"variables": {
"customer_name": "Dana"
}
}
],
"has_more": false,
"next_cursor": null,
"object": "list",
"url": "/v1/calls"
}

The request is invalid: a parameter is missing, malformed or unknown, or the version header is unknown.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "parameter_missing",
"doc_url": "https://docs.morevoice.ai/api/errors#parameter-missing",
"message": "Missing required parameter: to.",
"param": "to",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "invalid_request_error"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

No valid API key was sent.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "invalid_api_key",
"doc_url": "https://docs.morevoice.ai/api/errors#invalid-api-key",
"message": "Invalid API key.",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "authentication_error"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

The key may not do this (a missing scope, a plan limit, or a compliance block).

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "missing_scope",
"doc_url": "https://docs.morevoice.ai/api/errors#missing-scope",
"message": "This API key lacks the calls:write scope.",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "permission_error"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

Too many requests, or no call capacity right now. Retry after the Retry-After delay.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "rate_limited",
"doc_url": "https://docs.morevoice.ai/api/errors#rate-limited",
"message": "Too many requests. Retry after 1 second.",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "rate_limit_error"
}
}
Retry-After
integer

Seconds to wait before retrying.

X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.

Something went wrong on MoreVoice’s side. Retry with the same Idempotency-Key.

Media typeapplication/json

Every /v1 error.

object
error
required
object
code
required

A stable, machine-readable code from the error-code catalogue.

string
details

Structured context, e.g. required_scope or the compliance verdict.

object
key
additional properties
doc_url
required

A link to the documentation of this code.

string
message
required

A human-readable explanation. Do not parse it.

string
param

The request parameter the error relates to, e.g. to or metadata[order_id].

string
request_id
required

The X-Request-Id of this request. Quote it when you contact support.

string
type
required

The category of the error.

string
Allowed values: invalid_request_error authentication_error permission_error not_found conflict rate_limit_error compliance_error idempotency_error api_error
Example
{
"error": {
"code": "internal_error",
"doc_url": "https://docs.morevoice.ai/api/errors#internal-error",
"message": "Something went wrong on MoreVoice's side.",
"request_id": "req_7Hk2LmN9pQ4rS6tV8wX0yZ",
"type": "api_error"
}
}
X-Request-Id
string

The request’s ID (req_…). Quote it when you contact support.