What one record holds
GET /api/call-history returns one row per call. The row is the same shape the
dashboard’s Calls page reads.
The full record
The two detail endpoints return everything above plus the conversation itself:transcript: the full text of the call. An empty string means nobody spoke.nullmeans no transcript could be sourced.segments: the same conversation cut into turns, each markedagentorleadwith the seconds it starts and ends at, so you can follow the text against the recording.nullwhen timings were not available.fields: the AI-generated fields the agent recorded on this call, askeyandvaluepairs. An empty array means the agent captured none.nullmeans they could not be sourced.transcriptSource: where the transcript came from.storedis our own record.livemeans it was fetched from the voice platform for this request.unavailablemeans neither had it, andtranscriptandfieldsare bothnull.
fields: null is a valid partial answer: we held the text,
and the voice platform could not be reached for the rest.
Finding the calls you want
Every filter onGET /api/call-history is a query parameter. Combine as many
as you need.
Sort with
sort as field.direction, for example dateTime.desc or
duration.asc. Page with page and limit. The response carries
pagination with page, limit, total and totalPages.
GET /api/call-history/filters returns the values you can filter on for your
account: the projects, statuses, agents and directions that actually appear in
your calls.
For one contact’s history, GET /api/contacts/{phoneNumber}/calls returns
their calls with an outcome summary. See Contacts.
Test calls in the record
A call to a contact you have marked as your own test lead still appears here. The mark removes it from the performance figures on the dashboard and in Analytics, not from the record. See Test your agent.Boundaries
- Two ids, two lookups.
idgoes toGET /api/call-history/{callId},callIdgoes toGET /api/call-history/by-call-id/{callId}. costis viewer-safe: an agency sees the agency price, a project user sees the project price.- Records answer with canonical names.
idandagentTypeare the fields. The storage spellings_idandcampaignSystemare not part of the response. - The list does not carry the transcript. Fetch the detail for that.
In the API
- List calls
- List call filters
- Get call and Get call by call id
- List contact calls
- Every field above is defined in the Glossary
Related
- What your agent records explains the outcome and the AI-generated fields.
- Metrics and how they are calculated rolls these records up.
