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.
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 and after accept a single value or an array of values.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Search Calls Request

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.

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.

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.

Responses

Callback

200List Calls Response

401Not Authenticated

422Unprocessable Entity