Search Calls

post

https://api.whippy.co/v1/calls/search

Search calls for an organization based on filters.

Optionally, the call records can be filtered by a set of filters:

before - will return call records created before the given date.
after - will return call records created after the given date.
from - will return call records from the given caller phone number.
to - will return call records to the given callee phone number.
direction - will return call records in the given direction.
delivery_status - will return call records with the given delivery status.
mode - will return call records with the given mode.
language - will return call records in the given language.
call_completion_rating - will return call records with the given call completion rating.
voicemail - will return call records with the given voicemail flag.
min_duration - will return call records with given minimum duration in milliseconds.
max_duration - will return call records with given maximum duration in milliseconds.
agent_id - will return call records from the given agent ID.
agent_version_id - will return call records from the given agent version ID.
contact_id - will return call records from/to the given contact ID.
conversation_id - will return call records from the given conversation ID.
channel_id - will return call records from/to the given channel ID.

All fields, with the exception of before, after, min_duration, max_duration, and voicemail, accept a single value or an array of values.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

limit

integer

Defaults to 50

limit

offset

integer

Defaults to 0

offset

timeout

integer

15000 to 120000

Defaults to 30000

Timeout for the search query in milliseconds

Body Params

Search Calls Request

Request schema for searching calls with extended filters.

after

date-time

The date and time after which the call records were created, in the ISO 8601 format.

agent_id

uuid

Agent ID(s) to filter by.

Accepts a single value or an array.

agent_version_id

uuid

Agent version ID(s) to filter by.

Accepts a single value or an array.

before

date-time

The date and time before which the call records were created, in the ISO 8601 format.

call_completion_rating

string

enum

Call completion rating.

Accepts a single value or an array.

Allowed:

channel_id

uuid

Channel ID(s) to filter by.

Accepts a single value or an array.

contact_id

uuid

Contact ID(s) to filter by.

Accepts a single value or an array.

conversation_id

uuid

Conversation ID(s) to filter by.

Accepts a single value or an array.

delivery_status

string

Call delivery status to filter by.

Accepts a single value or an array.

direction

string

enum

Call direction.

Accepts a single value or an array.

Allowed:

from

string

Caller phone number(s).

Accepts a single value or an array.

language

string

Language code(s) to filter by.

Accepts a single value or an array.

max_duration

integer

≥ 0

Maximum call duration in milliseconds

min_duration

integer

≥ 0

Minimum call duration in milliseconds

mode

string

enum

Call mode.

Accepts a single value or an array.

Allowed:

string

Callee phone number(s).

Accepts a single value or an array.

voicemail

boolean

Whether the call is a voicemail.

Responses

Callback

200List Calls Response

401Not Authenticated

422Unprocessable Entity