@dialstack/sdk-dev / server/src / CallListParams
Interface: CallListParams
Defined in: sdk/server/src/index.ts:1193
Sentiment conditions accepted by GET /v1/calls and GET /v1/calls/summary.
sentiment reads the call's overall verdict, local_* your user's side and
remote_* the other party's. Every condition requires the field it reads, so
a remote_* filter excludes calls with no reading for the other party.
Conditions combine with each other and with the other filters.
Extends
Properties
connected?
connected?: boolean;
Defined in: sdk/server/src/index.ts:1215
Whether a party connected. A call the platform answered only for a menu, a greeting, hold music or a voicemail is completed but not connected.
did?
did?: string;
Defined in: sdk/server/src/index.ts:1198
Filter by the phone number (DID) associated with the call, by its id.
direction?
direction?: CallDirection;
Defined in: sdk/server/src/index.ts:1199
expand?
expand?: CallExpand[];
Defined in: sdk/server/src/index.ts:1230
Related resources to include inline. Supported values: did, remote_number.
from_date?
from_date?: string;
Defined in: sdk/server/src/index.ts:1226
Return calls started on or after this date (ISO 8601).
from_number?
from_number?: string | string[];
Defined in: sdk/server/src/index.ts:1201
Caller's phone number, or any of several, in any spelling.
limit?
limit?: number;
Defined in: sdk/server/src/index.ts:1194
local_sentiment?
local_sentiment?: SentimentLabel;
Defined in: sdk/server/src/index.ts:1185
Inherited from
SentimentFilters.local_sentiment
local_sentiment_magnitude?
local_sentiment_magnitude?: RangeFilter;
Defined in: sdk/server/src/index.ts:1187
Inherited from
SentimentFilters.local_sentiment_magnitude
local_sentiment_score?
local_sentiment_score?: RangeFilter;
Defined in: sdk/server/src/index.ts:1186
Inherited from
SentimentFilters.local_sentiment_score
page?
page?: string;
Defined in: sdk/server/src/index.ts:1195
remote_number?
remote_number?: string;
Defined in: sdk/server/src/index.ts:1210
Only calls with this external party (the caller on an inbound call, the number dialed on an outbound one), in any spelling.
remote_sentiment?
remote_sentiment?: SentimentLabel;
Defined in: sdk/server/src/index.ts:1188
Inherited from
SentimentFilters.remote_sentiment
remote_sentiment_magnitude?
remote_sentiment_magnitude?: RangeFilter;
Defined in: sdk/server/src/index.ts:1190
Inherited from
SentimentFilters.remote_sentiment_magnitude
remote_sentiment_score?
remote_sentiment_score?: RangeFilter;
Defined in: sdk/server/src/index.ts:1189
Inherited from
SentimentFilters.remote_sentiment_score
search?
search?: string;
Defined in: sdk/server/src/index.ts:1224
Free-text search over both parties: the caller's name, the user, dial
plan, voice app or ring group name on either side, and either party's
number, as typed or with punctuation ignored (three digits minimum for
the latter). Combine with
from_date on large accounts: a search matching few calls over all
history is slow.
sentiment?
sentiment?: SentimentLabel;
Defined in: sdk/server/src/index.ts:1180
Inherited from
sentiment_magnitude?
sentiment_magnitude?: RangeFilter;
Defined in: sdk/server/src/index.ts:1184
Overall magnitude, 0.0 to 1.0.
Inherited from
SentimentFilters.sentiment_magnitude
sentiment_score?
sentiment_score?: RangeFilter;
Defined in: sdk/server/src/index.ts:1182
Overall score, -1.0 to +1.0.
Inherited from
SentimentFilters.sentiment_score
status?
status?:
| CallStatus
| CallStatus[];
Defined in: sdk/server/src/index.ts:1205
One status, or any of several.
to_date?
to_date?: string;
Defined in: sdk/server/src/index.ts:1228
Return calls started before this date (ISO 8601).
to_number?
to_number?: string | string[];
Defined in: sdk/server/src/index.ts:1203
The call's destination — as dialed or as routed — or any of several.
user_id?
user_id?: string;
Defined in: sdk/server/src/index.ts:1196