Skip to main content
GET
List calls

Authorizations

Authorization
string
header
required

An org API key: Authorization: Bearer phk_…

Headers

Phonely-Organization
string | null

Optional. Must be the key's org.

Query Parameters

agent_id
string
required

The agent whose calls to list.

Minimum string length: 1
status
string[] | null

Only calls in these statuses; repeat for several. Defaults to completed, ended, in_progress and in_warm_transfer.

Where a call is in its lifecycle, including the outcomes of pay-per-call transfers. Known values: completed, ended, in_progress, in_warm_transfer, queued, queueing, redial_scheduled, cancelled, dnc, failed, transferred_sold, transferred_not_sold, transferred_pending_sale, rev_share_pending_qualification, transferred_busy, transferred_no_answer, transferred_failed. More can be added, so handle values you don't recognize.

type
string[] | null

Only calls of these types, as a call's type reports them; repeat for several.

started_from
string<date-time> | null

Only calls that started at or after this time (ISO 8601 with a timezone).

started_before
string<date-time> | null

Only calls that started before this time (ISO 8601 with a timezone).

ended_reason
string[] | null

Only calls that ended for these reasons, as a call's ended_reason reports them; repeat for several.

sentiment
string[] | null

Only calls with these sentiments, as a call's sentiment reports them; repeat for several.

outcome
string[] | null

Only calls with these outcomes, exactly as a call's outcome reports them; repeat for several.

customer_phone_number
string | null

Only calls with this customer, exactly as a call's customer_phone_number reports it, such as +14155550123. Encode the + as %2B in the URL, or it arrives as a space.

Minimum string length: 1
campaign_id
string | null

Only calls placed by this campaign.

Minimum string length: 1
min_duration_seconds
number | null

Only calls that lasted at least this long. Like max_duration_seconds, it matches only calls with a duration (duration_seconds not null).

Required range: x >= 0
max_duration_seconds
number | null

Only calls that lasted at most this long. Like min_duration_seconds, it matches only calls with a duration (duration_seconds not null).

Required range: x >= 0
limit
integer
default:50

Calls per page, 1 to 100.

Required range: 1 <= x <= 100
cursor
string | null

next_cursor from the previous page.

Response

Successful Response

data
CallSummary · object[]
required

The items on this page.

next_cursor
string | null
required

Pass as cursor to get the next page. null on the last page.