MImiitel
phone_calls

Search phone calls

Search parent phone-call records visible to the caller.

One parent call can contain multiple call legs. Use POST /phone_call_legs/list when each result must be an individual leg. Filter by time, user, number, type, keyword, tag, or free text; paginate with first, offset, and after. count is populated only when include_count=true. Nested details are populated only when include_call_details=true.

post/public-api/v1/phone_calls/list

Request

  • Base URL
    / (relative, and the document’s source URL is not known)
  • URL
    /public-api/v1/phone_calls/list
  • Auth
    HTTP bearer and API key in header x-tenant-code

Request body

firstinteger

Forward page size. 1 to 200.

offsetinteger

Number of matching calls to skip before this page. 0 to 5000.

afterstring nullable

Cursor from the previous response's page_info.end_cursor.

starts_atstring date-time nullable

Filter calls by start time.

ends_atstring date-time nullable

Filter calls by end time.

call_typesAppSchemasCallsCallType[]

Restrict results to these call types.

numbersstring[]

Restrict results to calls involving any of these phone numbers.

user_idsstring[]

Restrict results to these numeric platform user IDs.

keyword_values__include_andstring[]

Require calls to contain every supplied keyword value.

tag_values__include_andstring[]

Require calls to have every supplied tag value.

tag_values__excludestring[]

Exclude calls with any supplied tag value.

qstring nullable

Free-text filter for call records.

include_archivedboolean

When true, include archived calls. Default false.

include_countboolean

When true, populate count (costs an extra lookup). Default false.

include_call_detailsboolean

When true, populate each call's nested per-leg details array (participants, keywords, tags, audio analysis) — the same shape as GET /phone_calls/{id}. Default false, so list responses stay lightweight.

Example request

{
  "first": 5,
  "include_call_details": false,
  "include_count": true
}

Response

A page of matching parent phone calls, an optional matched count, and pagination cursors.

countinteger nullable required

Total matching calls when include_count=true; otherwise null.

Changes

No recorded changes to this operation across all 1 revision of this API.