Calls - Multiple

Query accessible phone calls

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
integer

One Callcap top level "Corporate" account ID.

string

Any amount of Callcap 2nd level "Division" account IDs (separate each by a "," (comma)).

string

Any amount of Callcap 3rd level "Location" account IDs (separate each by a "," (comma)).

string

Any amount of "Campaign" IDs (separate each by a "," (comma)).

string
Defaults to yesterday and today

One/none of the following:
- custom (If this is set to custom, search_startdate and search_enddate should be set as well.)
- today
- yesterday
- week (The current week, starting on Sunday)
- last7days
- monthtodate
- lastmonth
- last30days
- last3months
- last6months
- yeartodate
- last1minutes
- last5minutes
- last10minutes
- last30minutes
- last60minutes

date
Defaults to Yesterday's Date

The earliest date in a date range for which you'd like to search calls.
Note: search_startdate must be less than search_enddate

date
Defaults to Today's Date

The latest date in a date range for which you'd like to search calls.

date-time

The earliest date in a date range for which you'd like to search last modified. Note: Date and time string in the format yyyy-mm-dd HH:nn

date-time

The latest date in a date range for which you'd like to search last modified. Note: Date and time string in the format yyyy-mm-dd HH:nn

string

Limit the returned calls to only specific days of the week.
1 = Sunday
2 = Monday
3 = Tuesday
4 = Wednesday
5 = Thursday
6 = Friday
7 = Saturday
Note: You can do more than one day by placing a "," (comma) between each number (e.g., 2,4,6)

string
Defaults to Time zone set for your login

One/none of the following:
- US/Hawaii
- US/Alaska
- US/Pacific
- US/Mountain
- US/Arizona
- US/Central
- US/Eastern
- Canada/Atlantic
- UTC

integer
Defaults to 0

The lowest value in a duration range for which you'd like to limit calls. Note: search_duration_min must be less than search_duration_max

integer

The highest value in a duration range for which you'd like to limit calls. Note: search_duration_max must be less than search_duration_min. A value greater than or equal to 600 seconds (10 minutes) will return all calls with no maximum duration.

string

Comma delimited list of any/all/none of the following:
- ans (Call answered)
- missed (Call was not answered due to hangup or busy signal)
- blocked (Call was from a number on the Blacklist)
- inprogress (Calls currently on the line that have not yet ended).

string

Limit the calls returned to only those with certain features.
Comma delimited list of any/all/none of the following:
- outbound (An outbound call)
- callsaver (A Negative call that has been worked through Callsaver)
- webmatch (A call that has been matched to a website visitor)
- callconnect (A call originating from a Click-to-Call event)
- callsurance (A call that has been worked by Callsurance call analysts)

string
Defaults to all

Choose which types of conversations to get in the request.
- all (Return all conversations)
- call (Only return calls)
- text (Only return text conversations)

string

A comma-delimited list of mediatype IDs corresponding to account specific Campaign mediums for which you'd like to limit calls.

string

Comma-delimited list of numeric Callsurance major IDs; Comma delimited list of any/all/none of the following:
- 1 (Positive calls)
- 2 (Negative calls)
- 3 (Neutral calls)
- 4 (Filtered calls. Not worked because the Caller is on the Callsurance filter)
- 0 (Unworked calls. These calls haven't been worked by an Analyst yet or are from campaigns with Callsurance turned off)

string

A comma-delimited list of CSR (Agent) IDs for which you'd like to limit calls.

string
Defaults to all

Comma-delimited list of numeric Callsaver status IDs; Comma delimited list of any/all/none of the following:
- 1 (Call was Saved)
- 2 (Call was NOT saved)

string

Returns only the calls that match the following evaluation change status:
- approved
- denied
- pending

boolean

Limits calls based on whether Revenue data has been entered or not.
- 1 (Revenue data was entered)
- 0 (Revenue data was NOT entered)

string

Freeform query parameter. search_term is checked against Campaign name, phone numbers, notes, etc. Fields checked are subject to change.

string

Caller phone number (Caller ID) to check against calls. If a formatted phone number is used, we will strip out the formatting for searching. Can also search for parts of the phone number such as "316-832-555", "316-832", or "316"

string

The destination number, or ring-to number, that the call connected to. If a formatted phone number is used, we will strip out the formatting for searching. Can also search for parts of the phone number such as "316-832-555", "316-832", or "316".

string

An external reference id to search calls for -- this typically applies to imported calls.

string
Defaults to all

Call direction filtering for ne of the following:
- inbound
- outbound
- internal

string

Alphanumeric ID from the Location.

string

Alphanumeric ID from the Division.

integer

he lowest value in Customer Satisfaction (CSAT) which you would like to search (Requires Sentiment Suite). Note: Must be lower than search_sentiment_csat_max.

integer

The largest value in Customer Satisfaction (CSAT) which you would like to search (Requires Sentiment Suite). Must be higher than search_sentiment_csat_min.

string
Defaults to newest

One/none of the following:
- newest
- oldest
- account (Orders alphabetically by Corporate name, then Division name, then Location name, then Campaign name)
- callerid (Orders numerically by the Caller's phone number)
- callername (Orders alphabetically by the Caller's name)
- callsurance (Orders numerically by Callsurance major, then by Callsurance minor)

integer
Defaults to 1

Specify the page of data to view. Paging is based on the total number of records from your request and the amount of records shown per page.

integer
Defaults to 50

Specify how many records to show per page. Greater than 0, less than or equal to 1000.

string
Defaults to all

Control the level of detail for each Call result.

Comma delimited list of any/all/none of the following:
- all: Shows the following:
   - callsurance (Shows Callsurance data; Major, Minor and CSR)
   - webmatch (Shows Webmatch data)
   - caller (Shows captured Caller information)
   - accounts (Shows Callcap Account information; Corporate, Division, Location and Campaign [including campaign phone number and destination])
   - sentiment (Shows Sentiment Suite signals.)

The following have to be explicitly set (e.g., details=all,notes):
   - notes (Shows Call Notes)
   - demographics (Shows Advanced Demographics Data)
   - scorecards (Shows scorecard questions and results)
   - import (Shows the imported reference_id)
   - summaries (Shows the call summaries)

Response

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json