MImiitel
phone_call_legs

Search phone call legs

Searchable list of call-detail records, one row per call leg.

Use POST /phone_calls/list for the grouped parent-call view. Filter and paginate with first, offset, and after; continue with the previous page_info.end_cursor. count is a top-level response field and is populated only when include_count=true.

post/public-api/v1/phone_call_legs/list

Request

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

Request body

firstinteger required

Maximum call legs to return.

offsetinteger required

Number of matching call legs to skip before this page.

include_archivedboolean

When true, include archived call legs. Default false.

include_countboolean

When true, populate the top-level count field. Default false.

starts_atstring date-time nullable

Filter call legs by start time.

ends_atstring date-time nullable

Filter call legs by end time.

afterstring nullable

Cursor from the previous response's page_info.end_cursor.

qstring nullable

Free-text filter for call legs.

user_idsstring[]

Restrict results to these numeric platform user IDs.

call_typesAppSchemasCallDetailsCallType[]

Restrict results to these call types.

numbersstring[]

Restrict results to call legs involving any of these phone numbers.

keyword_values__include_andstring[]

Require call legs to contain every supplied keyword value.

tag_values__include_andstring[]

Require call legs to have every supplied tag value.

tag_values__excludestring[]

Exclude call legs with any supplied tag value.

Example request

{
  "first": 5,
  "include_count": true,
  "offset": 0
}

Response

A page of matching phone call legs, an optional matched count, and pagination cursors.

countinteger nullable required

Total matching call legs when include_count=true; otherwise null.

Changes

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