Campaigns - Multiple

get

https://api.callcap.com/v2/get/campaigns/

Query accessible campaigns (phone numbers)

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

corporate_id

integer

One Callcap top level "Corporate" account ID

division_id

string

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

location_id

string

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

campaign_id

string

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

search_term

string

Freeform query parameter. search_term is checked against campaign name, line memo fields, campaign notes, tracking number and destination number. Fields checked are subject to change.

medium_id

string

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

is_activated

boolean

Boolean flag for campaign activation. for campaigns that have been activated, 0 for campaigns that are unactivated.

is_running

boolean

Boolean flag for campaign status. 1 for campaigns that are still able to take calls, 0 for expired numbers.

has_recording

boolean

Boolean flag for Recording status. 1 for campaigns with recording on, 0 for off.

has_callsurance

boolean

Boolean flag for Callsurance status. 1 for campaigns with Callsurance on, 0 for off.

has_webmatch

boolean

Boolean flag for Webmatch status. 1 for campaigns with Webmatch on, 0 for off.

has_clicktocall

boolean

Boolean flag for Click-to-Call status. 1 for campaigns with Click-to-Call (CallConnect) on, 0 for off.

campaign_direction

boolean

Only return campaigns that are of this type/direction. 0 for inbound campaigns only. 1 for outbound campaigns only.

order

string

Defaults to name

One/none of the following:
- name
- medium
- location (Orders alphabetically by Location name, then Campaign name)
- expiration (Order by expiration date of number ascending)
- destination (Order by destination number numerically)
- callcap_number (Orders numerically by Callcap phone numbers numerically)

detail

string

Defaults to all

Comma delimited list of any/all/none of the following:
- all (Shows everything)
- notes (Shows line memos and campaign notes)
- accounts (Shows Callcap Account information; Corporate, Division, and Location)

Response

200