POST
Input Header Parameters
application-keyRequired
Input JSON Parameters
{}Object {}RequiredROOTaccountIdStringOptionalFilter records by accountId
accountIdsArray []OptionalFilter records included in accountIds
lineIdStringOptionalFilter records by lineId
lineIdsArray []OptionalFilter records included in lineIds
agentIdStringOptionalFilter records by agentId
agentIdsArray []OptionalFilter records included in agentIds
startStampNumberOptionalDateStamp of where to start search.
endStampNumberOptionalDateStamp of where to end search. Including value.
startDateStringOptionalDate string formatted as 'YYYY-MM-DD' of where to start search.
endDateStringOptionalDate string formatted as 'YYYY-MM-DD' of where to end search. Will search through end of this date.
timeZoneStringOptionalJavaScript time zone. 'America/Toronto' (EST) used if omitted. Reference: Time Zones statusStringOptional'ACTIVE' call is ongoing, 'COMPLETED' call is completed.
On Success
Output JSON Parameters
{}Object {}ROOTcallsArray []Calls returned by search.{}Object {}Example returned record.applicationIdStringApplication ID.
accountIdStringAccount's ID.
lineIdStringLine's ID.
agentIdStringAgent's ID.
callIdStringCall's ID.
toStringPhone number of to. Ex +12225554444
fromStringPhone number of from. Ex +12225554444
directionStringCall direction of [INBOUND, OUTBOUND].
statusstringCall status.
stampStartedNumberDateStamp of call started.
stampCompletedNumberDateStamp of call completed.
recordingIdStringID of recordings record. 'null' if not available.
voicemailIdStringID of voicemails record. 'null' if not available.
billableMinutesNumberNumber of billable minutes.
durationSecondsNumberNumber of seconds of call activity.
On Failed
Output JSON Parameters
{}Object {}Root parameter type.errorObject {}codeStringError short code string.
messageStringGreater description of error.
Codes: METHOD_NOT_ALLOWED, BAD_REQUEST, INTERNAL_ERROR, ACCESS_DENIED, BANNED, INVALID_FILTER