Welcome to the Convoso Help Center

Browse our Knowledge Base of step-by-step tutorials and FAQs

Create a help ticket with our award winning Support Team Submit

Articles in this section

This article lists every API Argument listed within each menu option in the API Main Menu.

Each menu option may contain more than one Tab, the Arguments listed on every tab can also be found here.

apimenu.png

For Example: The Agent Monitor menu option contains two (2) tabs, the Arguments for each are listed here below the names of the tabs.

apitabs.png

Contents

Agent Monitor

Agent Monitor Search

Globally search through all logged-in users.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
campaign_id integer Filter by Campaign ID (for multiple comma separated. Example: 102,104 Optional
queue_id integer Filter by Queue ID (for multiple comma separated. Example: 203,204 Optional
user_id integer Filter by User ID (for multiple comma separated. Example: 1002034,1030483 Optional
filter_by_skill_options string Filter by Skill Options (for multiple comma separated. Example by state value: CA,TX,NY Optional

HTTP Method

  • POST

Agent Monitor Logout

Logout active users.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
user_id string User's ID Required

HTTP Method

  • POST

Errors

6006 No such User
6012 User not logged-in

Agent Performance

Retrieving agent performance records

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API Authentication Token Required
date_start date Start Date (2017-09-01 00:00:00) (default = today) Optional
date_end date End Date (2017-09-01 23:59:59) (default = today) Optional
campaign_ids integer (comma separated) Campaign IDs Optional
list_ids integer (comma separated) List IDs Optional
queue_ids integer (comma separated) Queue IDs Optional
user_ids integer (comma separated) User IDs Optional
status_ids string (comma separated) Status IDs Optional

HTTP Method

  • POST

Errors

6031 Missing Agents

Agent Productivity

Agent productivity records.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API Authentication Token Required
date_start date Start Date (2017-09-01 00:00:00) (default = today) Optional
date_end date End Date (2017-09-01 23:59:59) (default = today) Optional
agent_emails string (comma separated) Can be a single agent email, or a comma-separated list of agent emails. If left blank, it will return all agents Optional
campaign_id integer Campaign ID Optional
offset string Default 0/Max 50000 Optional
limit string Max number of requested rows (default 1000/max 1000) Optional

HTTP Method

  • POST

Errors

6031 Missing Agents
7231 Invalid offset value

Call Logs

Search Call Log

Retrieving call log records

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
id string Call Log ID Optional
lead_id string Lead`s ID Optional
campaign_id string Campaign`s ID Optional
queue_id string Queue`s ID Optional
list_id string List`s ID Optional
user_id string User ID Optional
call_type string Call Type (OUTBOUND, INBOUND, MANUAL, 3WAY) Optional
called_count string Lead's Call Count Optional
status string Status (SALE,DROP,AM, etc..) Optional
phone_number string Phone Number Optional
number_dialed string Number Dialed Optional
first_name string First Name Optional
last_name string Last Name Optional
start_time string Start Time (2015-09-01 00:00:00) (default = today) Optional
end_time string End Time (2015-09-01 23:59:59) (default = today) Optional
limit string Limit (1-500) Optional
offset string Offset (start from: 0,500,1000,...max of 40000) - To access data sets larger than 40000 items, please use the Start Time and End Time filters Optional
order string Order (ASC, DESC) "default = DESC (newest call)" Optional
include_recordings boolean Include Recordings (1, 0) "default = 0" Optional

HTTP Method

  • POST

Errors

6002 Unknown List Id
6006 Unknown User Id
6004 Unknown Campaign ID
6030 Unknown Queue ID
7231 Invalid offset value

Update Call Logs

Retrieving call log records

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
id string Call Log ID Optional
lead_id string Lead`s ID Optional
campaign_id string Campaign`s ID Optional
queue_id string Queue`s ID Optional
list_id string List`s ID Optional
user_id string User ID Optional
call_type string Call Type (OUTBOUND, INBOUND, MANUAL, 3WAY) Optional
called_count string Lead's Call Count Optional
status string Status (SALE,DROP,AM, etc..) Optional
phone_number string Phone Number Optional
number_dialed string Number Dialed Optional
first_name string First Name Optional
last_name string Last Name Optional
start_time string Start Time (2015-09-01 00:00:00) (default = today) Optional
end_time string End Time (2015-09-01 23:59:59) (default = today) Optional
limit string Limit (1-500) Optional
offset string Offset (start from: 0,500,1000,...max of 40000) - To access data sets larger than 40000 items, please use the Start Time and End Time filters Optional
order string Order (ASC, DESC) "default = DESC (newest call)" Optional
include_recordings boolean Include Recordings (1, 0) "default = 0" Optional

HTTP Method

  • POST

Errors

6002 Unknown List Id
6006 Unknown User Id
6004 Unknown Campaign ID
6030 Unknown Queue ID
7231 Invalid offset value

 

Insert Callbacks

Insert Callback

Retrieving callback records

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API Authentication Token Required
lead_id string Lead ID Required
user_id string User ID Optional
recipient string Recipient (System, Personal) Required
comments string Comments Optional
callback_time_zone string Callback Time Zone Required
callback_time string Callback Time Required

HTTP Method

  • POST

Errors

6038 No such Callback
6001 No such Lead
6006 No such User
6023 Required fields are missed
7237 Invalid callback_time

Update Callback

Retrieving callback records

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API Authentication Token Required
callback_id string Callback ID Required
user_id string User ID Optional
recipient string Recipient (System, Personal) Optional
comments string Comments Optional
callback_time_zone string Callback Time Zone Optional
callback_time string Callback Time Optional
status string Status (Dismissed) Optional

HTTP Method

  • POST

Errors

6006 No such User
6023 Required fields are missed
6038 No such Callback
7237 Invalid callback_time

Delete Callbacks

Retrieving callback records

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API Authentication Token Required
callback_id string Callback ID Required

HTTP Method

  • POST

Errors

6038 No such Callback

Search Callbacks

Retrieving callback records

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API Authentication Token Required
campaign_id string Campaign's ID Optional
comments string Comments Optional
id integer Callback ID Optional
lead_id integer Leads ID Optional
list_id integer Lists ID Optional
recipient string Recipient (System, Personal) Optional
user_id string Users ID Optional
stage string Stage (COMPLETED, PAST_DUE, PENDING, DISMISSED) Optional
offset integer Pagination offset (Default: 0, Max: 50000) Optional
limit integer Maximum number of results to retrieve (Default: 20, Max: 5000) Optional
start_date string Start Date Optional
end_date string End Date Optional

HTTP Method

  • POST

Errors

6000 Missing callbacks
7231 Invalid offset value

Campaigns

Campaign Status

Toggle campaign status for authenticated users.

To activate or deactivate the campaign set the status parameter to true or false.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
campaign_id string Campaign's ID Required
status boolean Campaign's status Required

HTTP Method

  • POST

Errors

6004 Unknown Campaign ID
6010 Missing status

Search Campaign

Get the list of all Campaigns.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required

HTTP Method

  • POST

DNC

Insert DNC

Insert DNC.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
phone_number string DNC Phone Number Required
phone_code string DNC phone_code Required
campaign_id string DNC Campaign ID (0 For Global) Required

HTTP Method

  • POST

Errors

6006 Invalid Campaign ID
6007 Invalid Phone Number
6008 The phone number already exists

Delete DNC

Delete a DNC for authenticated user.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
phone_number string Phone Number Required
phone_code string Phone Code Required
campaign_id string Campaign ID (0 For Global) Required
update_lead_status string Update Lead Status Optional
lead_status string Lead Status Optional

HTTP Method

  • POST

Errors

6000 Missing Phone Code
6001 Missing Campaign ID
6002 Missing Phone Number
6003 Phone Number Not Found
6004 Invalid Lead status
6005 Missing Lead status

Search DNC

Search Do Not Call List

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
id integer DNC id Optional
campaign_id integer DID Campaign Id (0 For Global) Optional
phone_number string DID Phone Number Optional
phone_code string DID phone_code Optional
insert_date string DNC Insert Date Optional
offset string Row offset into DNC table (default 0/Max 100000) Optional
limit string Max number of requested rows (default 1000/max 1000) Optional

HTTP Method

  • POST

Errors

7231 Invalid offset value

Lead Validation

Lead Validation

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
criteria_key string The unique identifier for the criteria to be applied to the request Required
phone_number phone The phone number of the lead Required
State string The two character state code of the prospective lead (e.g. CA) Optional
postal_code string The five digit postal code for the prospective lead Optional

HTTP Method

  • POST

Leads

Insert Lead

Insert Lead.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
list_id integer List`s ID Required
phone_code string Lead`s phone code. Default is 1 Optional
status string Lead`s status Optional
created_by lookup Created By Optional
email email Email Optional
last_modified_by lookup Last Modified By Optional
owner_id lookup Lead Owner Optional
first_name text First Name Optional
last_name text Last Name Optional
phone_number phone Primary Phone Required
alt_phone_1 phone Cell Phone Optional
alt_phone_2 phone Work Phone Optional
address1 text Address 1 Optional
address2 text Address 2 Optional
city text City Optional
state select State Optional
province text Province Optional
postal_code text Postal Code Optional
country select Country Optional
gender select Gender Optional
date_of_birth date Date Of Birth Optional
need_pet_insurance checkbox Training - Do you need Pet Insurance? Optional
monthly_cost text Training - Monthly Cost Optional
do_you_currently_have_insurance checkbox Training - Do you currently have insurance Optional
ka_sge_2_select select Training - Insurance Provider Optional
training_select_long long_select Training Select Long Optional
geico__ch___sge_2_select long_select Geico :CH - SGE 2 Select Optional
allstate__ch___sge_2_text text Allstate :CH - SGE 2 Text Optional
ch_insurance_provider select CH Insurance provider Optional
ch_insurance_cost text CH Insurance Cost Optional
jr___sge2_select select JR - SGE2 Select Optional
jr___sge_2_checkbox checkbox JR - SGE 2 Checkbox Optional
jc_05302024_sge_2_select select JC 05302024: SGE 2 Select Optional
jc_05302024_sge_text text JC 05302024:SGE Text Optional
jc052024___sge4_insuranceprovider select Insurance Provider Optional
jc052024_sge4_insurance_cost text Insurance Cost Optional
dp___sge_2_select select Current Insurance Optional
dp___sge_2_checkbox checkbox Current Insurance expired? Optional
url text url Optional
amselect select AM- SGE2 Select Optional
yes checkbox AM - SGE2 Checkbox Optional
insurance_provider select AM Insurance provider Optional
insurance_cost text AM Insurance cost Optional
ek___sge_2_select select Insurance Providers Optional
ek___sge_checkbox checkbox Insurance Information Optional
re___sge_2_select select RE - SGE 2 Select Optional
re___sge_2_text text RE - SGE 2 Text Optional
ek_sg_ex4_field_name select Insurance Provider Optional
insurance_cost_ek text EK Insurance Cost Field Optional
ak_inr number AK INR Optional
vb_inr number INR Optional
re_insurance_provider select RE Insurance Provider Optional
re_insurance_cost text RE Insurance Cost Optional
sge_2_select long_select AK Insurance Providers Optional
sge_2_checkbox checkbox AK SGE 2 Checkbox Optional
aksge41 checkbox AK Self Guided 4 Field 1 Optional
aksge42 text AK Self Guided 4 Field 2 Optional
be___sge_2_select checkbox BE - SGE 2 Select Optional
be___sge_2_text text BE - SGE 2 Text Optional
lm_sge_2_select select LM-SGE 2 SELECT Optional
lm_sge_2_text checkbox LM SGE 2 Text Optional
cm_sge_2_text text CM SGE 2 Text Optional
cm____sge_2_select text CM - SGE 2 Select Optional
lm_insurance_cost text LM Insurance Cost Optional
lm__insurance_provider select LM Insurance Provider Optional
indian_currency number INR Optional
sge_2_yh_select select insurance providers Optional
sge_2_yh_checkbox checkbox SGE 2 YH Checkbox Optional
insured checkbox Insured Optional
yh___insurance_provider___exercise_4 select YH - Insurance Provider - Exercise 4 Optional
yh___insurance_cost___exercise_4 text YH - Insurance Cost - Exercise 4 Optional
co_sge_2_select select CO - SGE 2 Select Optional
co_sge_2_text text CO - SGE 2 Text Optional
os___insurance_providers select OS - Insurance Providers Optional
os___sge_2_checkbox checkbox OS - SGE 2 Checkbox) Optional
co_insurance_provider select CO Insurance Provider Optional
co_insurance_cost text CO Insurance Cost Optional
test_ph_no_field phone Test Phone number Field Optional
bz_sge_2_select select BZ SGE 2 Select Optional
jc_sge_2_select select JC SGE 2 Select Optional
bz_seg_2_check checkbox BZ SEG 2 Check Optional
jc_sge_2_check checkbox JC SGE 2 Check Optional
ns___sge_2_select select Insurance Provider Optional
ns___sge_2_checkbox checkbox Do you need Insured? Optional
ns_sg_ex4 text Insurance Cost Optional
dh___sge_2_select select DH - SGE 2 Select Optional
dh___sge_2_checkbox checkbox DH - SGE 2 Checkbox Optional
dh_sge4_insurance_provider select Insurance Provider Optional
dh_sge4_insurance_cost text Insurance Cost Optional
le2stdatepickerfield date LE2STDatePickerfield Optional
skt_insurance_provider text SKT Insurance Provider Optional
skt_insurance_cost integer SKT Insurance Cost Optional
skt_insurance_provider_drop_down multiselect SKT Insurance Provider Drop Down Optional
skt___sge_2_select select SKT - SGE 2 Select Optional
skt___sge_2_checkbox checkbox SKT - SGE 2 Checkbox Optional
select_vb select select vb Optional
managerphonenumber phone ManagerPhoneNumber Optional
adminphonenumber phone AdminPhoneNumber Optional
indian_rupees number INR Optional
sk_date date SK Date Optional
insuranceprovider select Insurance Provider Optional
insurancecost number Insurance Cost Optional
Non asset options
check_dup integer If this parameter is included, we check for duplicates. If you pass ‘1’ or ‘true’ as a value, we check for duplicates against the entire account. If you pass the value ‘2’ we check for duplicates in the list where you are entering the lead. If you pass the value ‘3’ we check for duplicates across the Campaign that the lead is being assigned to. Optional
check_dup_archive boolean Whether or not to check for duplicate lead phone number in Archived Leads ('check_dup' should be enabled and this filter is applied across the entire account) Optional
check_dnc boolean Whether or not to check the lead phone number for Do Not Call (DNC) list (Only if campaign set to "Ignore rules/filters and insert into hopper to dial immediately") Optional
check_wireless boolean Whether or not to check the lead phone number for Wireless list Optional
hopper boolean Whether or not to insert the lead into the Hopper Optional
hopper_priority integer Hopper priority level.Value range is from 0 to 99.Default is 99. Optional
hopper_expires_in integer In how many minutes hopper will be expired (max value is 300) Optional
blueinkdigital_token string This token is used to fetch the leads Phone Number from Blue Ink Digital (Requirement: to store this token, a dedicated form field is needed before using this integration. To set this go under Apps -> Blue Ink Digital and define a form field which is of data type 'text') Optional
reject_by_carrier_type enum (MOBILE, VOIP, LANDLINE) This field is used to reject leads based on one or more carrier types. The optional values are the following and can be joined in conjunction, separated by a comma. (Example: MOBILE,VOIP or LANDLINE or VOIP,LANDLINE etc.) Optional
filter_phone_code boolean This allows you to strip the country code out of the primary phone number and place it into the phone_code field. It's commonly used incase the phone number passed to the api contains the country code Optional
Insert Update (Non asset options)
update_if_found boolean Whether insert as new contact or update if 'Lead ID' or 'Phone Number' found Optional
search_campaign_id integer The Campaign ID to search within when "update_if_found" is true Optional
search_list_id integer The List ID to search within when "update_if_found" is true (takes priority over search_campaign_id if both are passed in) Optional
update_order_by_last_called_time string In case duplicate is found, find the 'Phone Number' by the order of Last Called Time 'ASC' or 'DESC' Optional
lead_id integer Lead ID Optional

HTTP Method

  • POST

Errors

6002 No such List
6006 No such User
6007 The Lead requires a phone number and list id
6008 The phone number is invalid
6009 The phone number already exists
6023 Required fields are missed
6079 Invalid Email(s)

Update Lead

Update a lead for authenticated user.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
lead_id integer Lead`s ID Required
list_id integer List`s ID Optional
phone_code string Lead`s phone code. Default is 1 Optional
status string Lead`s status Optional
created_by lookup Created By Optional
email email Email Optional
last_modified_by lookup Last Modified By Optional
owner_id lookup Lead Owner Optional
first_name text First Name Optional
last_name text Last Name Optional
phone_number phone Primary Phone Optional
alt_phone_1 phone Cell Phone Optional
alt_phone_2 phone Work Phone Optional
address1 text Address 1 Optional
address2 text Address 2 Optional
city text City Optional
state select State Optional
province text Province Optional
postal_code text Postal Code Optional
country select Country Optional
gender select Gender Optional
date_of_birth date Date Of Birth Optional
need_pet_insurance checkbox Training - Do you need Pet Insurance? Optional
monthly_cost text Training - Monthly Cost Optional
do_you_currently_have_insurance checkbox Training - Do you currently have insurance Optional
ka_sge_2_select select Training - Insurance Provider Optional
training_select_long long_select Training Select Long Optional
geico__ch___sge_2_select long_select Geico :CH - SGE 2 Select Optional
allstate__ch___sge_2_text text Allstate :CH - SGE 2 Text Optional
ch_insurance_provider select CH Insurance provider Optional
ch_insurance_cost text CH Insurance Cost Optional
jr___sge2_select select JR - SGE2 Select Optional
jr___sge_2_checkbox checkbox JR - SGE 2 Checkbox Optional
jc_05302024_sge_2_select select JC 05302024: SGE 2 Select Optional
jc_05302024_sge_text text JC 05302024:SGE Text Optional
jc052024___sge4_insuranceprovider select Insurance Provider Optional
jc052024_sge4_insurance_cost text Insurance Cost Optional
dp___sge_2_select select Current Insurance Optional
dp___sge_2_checkbox checkbox Current Insurance expired? Optional
url text url Optional
amselect select AM- SGE2 Select Optional
yes checkbox AM - SGE2 Checkbox Optional
insurance_provider select AM Insurance provider Optional
insurance_cost text AM Insurance cost Optional
ek___sge_2_select select Insurance Providers Optional
ek___sge_checkbox checkbox Insurance Information Optional
re___sge_2_select select RE - SGE 2 Select Optional
re___sge_2_text text RE - SGE 2 Text Optional
ek_sg_ex4_field_name select Insurance Provider Optional
insurance_cost_ek text EK Insurance Cost Field Optional
ak_inr number AK INR Optional
vb_inr number INR Optional
re_insurance_provider select RE Insurance Provider Optional
re_insurance_cost text RE Insurance Cost Optional
sge_2_select long_select AK Insurance Providers Optional
sge_2_checkbox checkbox AK SGE 2 Checkbox Optional
aksge41 checkbox AK Self Guided 4 Field 1 Optional
aksge42 text AK Self Guided 4 Field 2 Optional
be___sge_2_select checkbox BE - SGE 2 Select Optional
be___sge_2_text text BE - SGE 2 Text Optional
lm_sge_2_select select LM-SGE 2 SELECT Optional
lm_sge_2_text checkbox LM SGE 2 Text Optional
cm_sge_2_text text CM SGE 2 Text Optional
cm____sge_2_select text CM - SGE 2 Select Optional
lm_insurance_cost text LM Insurance Cost Optional
lm__insurance_provider select LM Insurance Provider Optional
indian_currency number INR Optional
sge_2_yh_select select insurance providers Optional
sge_2_yh_checkbox checkbox SGE 2 YH Checkbox Optional
insured checkbox Insured Optional
yh___insurance_provider___exercise_4 select YH - Insurance Provider - Exercise 4 Optional
yh___insurance_cost___exercise_4 text YH - Insurance Cost - Exercise 4 Optional
co_sge_2_select select CO - SGE 2 Select Optional
co_sge_2_text text CO - SGE 2 Text Optional
os___insurance_providers select OS - Insurance Providers Optional
os___sge_2_checkbox checkbox OS - SGE 2 Checkbox) Optional
co_insurance_provider select CO Insurance Provider Optional
co_insurance_cost text CO Insurance Cost Optional
test_ph_no_field phone Test Phone number Field Optional
bz_sge_2_select select BZ SGE 2 Select Optional
jc_sge_2_select select JC SGE 2 Select Optional
bz_seg_2_check checkbox BZ SEG 2 Check Optional
jc_sge_2_check checkbox JC SGE 2 Check Optional
ns___sge_2_select select Insurance Provider Optional
ns___sge_2_checkbox checkbox Do you need Insured? Optional
ns_sg_ex4 text Insurance Cost Optional
dh___sge_2_select select DH - SGE 2 Select Optional
dh___sge_2_checkbox checkbox DH - SGE 2 Checkbox Optional
dh_sge4_insurance_provider select Insurance Provider Optional
dh_sge4_insurance_cost text Insurance Cost Optional
le2stdatepickerfield date LE2STDatePickerfield Optional
skt_insurance_provider text SKT Insurance Provider Optional
skt_insurance_cost integer SKT Insurance Cost Optional
skt_insurance_provider_drop_down multiselect SKT Insurance Provider Drop Down Optional
skt___sge_2_select select SKT - SGE 2 Select Optional
skt___sge_2_checkbox checkbox SKT - SGE 2 Checkbox Optional
select_vb select select vb Optional
managerphonenumber phone ManagerPhoneNumber Optional
adminphonenumber phone AdminPhoneNumber Optional
indian_rupees number INR Optional
sk_date date SK Date Optional
insuranceprovider select Insurance Provider Optional
insurancecost number Insurance Cost Optional

HTTP Method

  • POST

Errors

6001 No such Lead
6002 No such List
6006 No such User
6008 The phone number is invalid
6079 Invalid Email(s)

Delete Lead

Delete a lead for authenticated user.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
lead_id integer Lead`s ID Required

HTTP Method

  • POST

Errors

6001 No such Lead

Search Leads

Globally search through all the account leads.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
lead_id integer Lead`s ID Optional
list_id integer List`s ID Optional
user_id string User`s ID Optional
owner_id string Owner`s ID Optional
status string Lead`s status Optional
created_by lookup Created By Optional (searchable)
email email Email Optional (searchable)
last_modified_by lookup Last Modified By Optional (searchable)
owner_id lookup Lead Owner Optional (searchable)
first_name text First Name Optional (searchable)
last_name text Last Name Optional (searchable)
phone_number phone Primary Phone Optional (searchable)
alt_phone_1 phone Cell Phone Optional (searchable)
alt_phone_2 phone Work Phone Optional (searchable)
address1 text Address 1 Optional (searchable)
address2 text Address 2 Optional (searchable)
city text City Optional (searchable)
state select State Optional (searchable)
province text Province Optional (searchable)
postal_code text Postal Code Optional (searchable)
country select Country Optional (searchable)
gender select Gender Optional (searchable)
date_of_birth date Date Of Birth Optional (searchable)
created_at_start_date string Created At Start Date (2019-01-01 00:00:00) Optional (searchable)
created_at_end_date string Created At End Date (2019-01-01 23:59:59) Optional (searchable)
last_call_start_date string Last Call Start Date (2019-01-01 00:00:00) Optional (searchable)
last_call_end_date string Last Call End Date (2019-01-01 23:59:59) Optional (searchable)
need_pet_insurance checkbox Training - Do you need Pet Insurance? (non Searchable)
monthly_cost text Training - Monthly Cost (non Searchable)
do_you_currently_have_insurance checkbox Training - Do you currently have insurance (non Searchable)
ka_sge_2_select select Training - Insurance Provider (non Searchable)
training_select_long long_select Training Select Long (non Searchable)
geico__ch___sge_2_select long_select Geico :CH - SGE 2 Select (non Searchable)
allstate__ch___sge_2_text text Allstate :CH - SGE 2 Text (non Searchable)
ch_insurance_provider select CH Insurance provider (non Searchable)
ch_insurance_cost text CH Insurance Cost (non Searchable)
jr___sge2_select select JR - SGE2 Select (non Searchable)
jr___sge_2_checkbox checkbox JR - SGE 2 Checkbox (non Searchable)
jc_05302024_sge_2_select select JC 05302024: SGE 2 Select (non Searchable)
jc_05302024_sge_text text JC 05302024:SGE Text (non Searchable)
jc052024___sge4_insuranceprovider select Insurance Provider (non Searchable)
jc052024_sge4_insurance_cost text Insurance Cost (non Searchable)
dp___sge_2_select select Current Insurance (non Searchable)
dp___sge_2_checkbox checkbox Current Insurance expired? (non Searchable)
url text url (non Searchable)
amselect select AM- SGE2 Select (non Searchable)
yes checkbox AM - SGE2 Checkbox (non Searchable)
insurance_provider select AM Insurance provider Optional (searchable)
insurance_cost text AM Insurance cost Optional (searchable)
ek___sge_2_select select Insurance Providers (non Searchable)
ek___sge_checkbox checkbox Insurance Information (non Searchable)
re___sge_2_select select RE - SGE 2 Select (non Searchable)
re___sge_2_text text RE - SGE 2 Text (non Searchable)
ek_sg_ex4_field_name select Insurance Provider Optional (searchable)
insurance_cost_ek text EK Insurance Cost Field (non Searchable)
ak_inr number AK INR (non Searchable)
vb_inr number INR Optional (searchable)
re_insurance_provider select RE Insurance Provider (non Searchable)
re_insurance_cost text RE Insurance Cost (non Searchable)
sge_2_select long_select AK Insurance Providers Optional (searchable)
sge_2_checkbox checkbox AK SGE 2 Checkbox (non Searchable)
aksge41 checkbox AK Self Guided 4 Field 1 (non Searchable)
aksge42 text AK Self Guided 4 Field 2 (non Searchable)
be___sge_2_select checkbox BE - SGE 2 Select Optional (searchable)
be___sge_2_text text BE - SGE 2 Text Optional (searchable)
lm_sge_2_select select LM-SGE 2 SELECT Optional (searchable)
lm_sge_2_text checkbox LM SGE 2 Text Optional (searchable)
cm_sge_2_text text CM SGE 2 Text Optional (searchable)
cm____sge_2_select text CM - SGE 2 Select Optional (searchable)
lm_insurance_cost text LM Insurance Cost (non Searchable)
lm__insurance_provider select LM Insurance Provider (non Searchable)
indian_currency number INR Optional (searchable)
sge_2_yh_select select insurance providers (non Searchable)
sge_2_yh_checkbox checkbox SGE 2 YH Checkbox (non Searchable)
insured checkbox Insured (non Searchable)
yh___insurance_provider___exercise_4 select YH - Insurance Provider - Exercise 4 (non Searchable)
yh___insurance_cost___exercise_4 text YH - Insurance Cost - Exercise 4 (non Searchable)
co_sge_2_select select CO - SGE 2 Select (non Searchable)
co_sge_2_text text CO - SGE 2 Text (non Searchable)
os___insurance_providers select OS - Insurance Providers (non Searchable)
os___sge_2_checkbox checkbox OS - SGE 2 Checkbox) (non Searchable)
co_insurance_provider select CO Insurance Provider (non Searchable)
co_insurance_cost text CO Insurance Cost (non Searchable)
test_ph_no_field phone Test Phone number Field (non Searchable)
bz_sge_2_select select BZ SGE 2 Select (non Searchable)
jc_sge_2_select select JC SGE 2 Select (non Searchable)
bz_seg_2_check checkbox BZ SEG 2 Check (non Searchable)
jc_sge_2_check checkbox JC SGE 2 Check (non Searchable)
ns___sge_2_select select Insurance Provider (non Searchable)
ns___sge_2_checkbox checkbox Do you need Insured? (non Searchable)
ns_sg_ex4 text Insurance Cost (non Searchable)
dh___sge_2_select select DH - SGE 2 Select (non Searchable)
dh___sge_2_checkbox checkbox DH - SGE 2 Checkbox (non Searchable)
dh_sge4_insurance_provider select Insurance Provider (non Searchable)
dh_sge4_insurance_cost text Insurance Cost (non Searchable)
le2stdatepickerfield date LE2STDatePickerfield (non Searchable)
skt_insurance_provider text SKT Insurance Provider (non Searchable)
skt_insurance_cost integer SKT Insurance Cost (non Searchable)
skt_insurance_provider_drop_down multiselect SKT Insurance Provider Drop Down (non Searchable)
skt___sge_2_select select SKT - SGE 2 Select (non Searchable)
skt___sge_2_checkbox checkbox SKT - SGE 2 Checkbox (non Searchable)
select_vb select select vb (non Searchable)
managerphonenumber phone ManagerPhoneNumber (non Searchable)
adminphonenumber phone AdminPhoneNumber (non Searchable)
indian_rupees number INR (non Searchable)
sk_date date SK Date (non Searchable)
insuranceprovider select Insurance Provider (non Searchable)
insurancecost number Insurance Cost (non Searchable)
offset integer Pagination offset Optional
limit (max 2000) integer Maximum number of results to retrieve Optional

HTTP Method

  • POST

Errors

6000 Missing lists
7230 Invalid limit value
7231 Invalid offset value

Get Lead Recordings

Returns a list of all lead recordings.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
lead_id integer Lead`s ID Required
start_time string Start datetime [format: Y-m-d H:is] Optional
end_time string End datetime [format: Y-m-d H:is] Optional
offset integer Pagination offset Optional
limit integer Maximum number of results to retrieve Optional

HTTP Method

  • POST

Errors

6005 Missing users
7231 Invalid offset value

Lists

Insert List

Create a new list for authenticated user.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
name string List`s name, 10-30 characters long, acceptable symbols: a-z A-Z 0-9 : - _ space Required
campaign_id string Campaign`s ID Required
description string List`s description, 0-255 characters long Optional
status boolean List`s status Optional

HTTP Method

  • POST

Errors

6003 The List requires a name
6004 Unknown Campaign ID
6046 The List name should be at least 10 characters long

Update List

Update a list for authenticated user.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
list_id integer List`s ID Required
name string List`s name, 10-30 characters long, acceptable symbols: a-z A-Z 0-9 : - _ space Optional
campaign_id string Campaign`s ID Optional
status boolean List`s status Optional

HTTP Method

  • POST

Errors

6002 No such List
6004 Unknown Campaign ID
6046 The List name should be at least 10 characters long

Delete List

Delete a list for authenticated user.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
list_id integer List`s ID Required

HTTP Method

  • POST

Errors

6002 No such List

 

Search List

Search Lists by campaign_id.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
status string List`s Status Required
id string List`s Id Optional
campaign_id string Campaign`s ID Optional

HTTP Method

  • POST

Errors

6002 No such List

Revenue

Insert/Update Revenue Logs

Insert or update Revenue Logs

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
call_log_id string Call Log`s ID Required
revenue double Revenue (Number) Optional
return integer Return (0 or 1) Optional

HTTP Method

  • POST

Errors

6032 Missing Call Log ID
6033 No such Call Log
6036 Either Revenue or Return need to have value

Status

Insert Status

Create a new Status for authenticated user.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
status string Status Abbreviation, only Alphanumeric characters allowed. Must be between 2-6 characters long. Required
name string Status name Required
hex_color string Hex color Optional
final enum Final Option, set Y for Yes or N for No Required
reached enum Reached Option, set Y for Yes or N for No Required
success enum Success Option, set Y for Yes or N for No Required
dnc enum DNC Option, set Y for Yes or N for No Required
callback enum Callback Option, set Y for Yes or N for No Required
contact enum Contact Option, set Y for Yes or N for No Required
voicemail enum Voicemail Option, set Y for Yes or N for No Required

HTTP Method

  • POST

Errors

6060 Missing Status Description
6061 Missing or Invalid Status Abbreviation, only Alphanumeric characters allowed. Must be between 2-6 characters long.
6062 Missing or Invalid Final option, Must be Y for Yes or N for No.
6063 Missing or Invalid Reached option, Must be Y for Yes or N for No.
6064 Missing or Invalid Success option, Must be Y for Yes or N for No.
6065 Missing or Invalid DNC option, Must be Y for Yes or N for No.
6066 Missing or Invalid Callback option, Must be Y for Yes or N for No.
6067 Missing or Invalid Contact option, Must be Y for Yes or N for No.
6068 Missing or Invalid Voicemail option, Must be Y for Yes or N for No.
6078 HEX color defined is invalid, do not include #, valid example: 6711d1.

Update Status

Update a status for an authenticated user.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
status string Status Abbreviation Required
name string Status name Optional
hex_color string Hex color Optional
final enum Final Option, set Y for Yes or N for No Optional
reached enum Reached Option, set Y for Yes or N for No Optional
success enum Success Option, set Y for Yes or N for No Optional
dnc enum DNC Option, set Y for Yes or N for No Optional
callback enum Callback Option, set Y for Yes or N for No Optional
contact enum Contact Option, set Y for Yes or N for No Optional
voicemail enum Voicemail Option, set Y for Yes or N for No Optional

HTTP Method

  • POST

Errors

6069 Missing or Invalid Status Abbreviation, Only custom statuses can be modified.
6071 Final option can not be set to a empty value, please assign a Y for Yes or N for No or dont set parameter.
6072 Reached option can not be set to a empty value, please assign a Y for Yes or N for No or dont set parameter.
6073 Success option can not be set to a empty value, please assign a Y for Yes or N for No or dont set parameter.
6074 DNC option can not be set to a empty value, please assign a Y for Yes or N for No or dont set parameter.
6075 Callback option can not be set to a empty value, please assign a Y for Yes or N for No or dont set parameter.
6076 Contact option can not be set to a empty value, please assign a Y for Yes or N for No or dont set parameter.
6077 Voicemail option can not be set to a empty value, please assign a Y for Yes or N for No or dont set parameter.
6078 HEX color defined is invalid, do not include #, valid example: 6711d1.

Search Status

Search Status by status.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
query string Search status abbreviation or description. Required

HTTP Method

  • POST

User Activity

Globally search through all logged in users.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
campaign_id integer Filter by Campaign ID (for multiple comma seperate. Example: 102,104 Optional
queue_id integer Filter by Queue ID (for multiple comma seperate. Example: 203,204 Optional
user_id integer Filter by User ID (for multiple comma seperate. Example: 1002034,1030483 Optional
filter_by_skill_options string Filter by Skill Options (for multiple comma seperate. Example by state value: CA,TX,NY Optional

HTTP Method

  • POST

Users

Get Recordings

Returns a list of all user recording.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
user string User`s email Required
start_time string Start datetime [format: Y-m-d H:is] Optional
end_time string End datetime [format: Y-m-d H:is] Optional
offset integer Pagination offset Optional
limit integer Maximum number of results to retrieve Optional

HTTP Method

  • POST

Errors

6005 Missing users
7231 Invalid offset value

User Search

Returns a list of all user information.

Arguments

POST Field (case sensitive) Type Description Required/Optional
auth_token string API authentication token Required
user string User`s email , First Name , Last Name Optional
offset integer Pagination offset Optional
limit integer Maximum number of results to retrieve Optional

HTTP Method

  • POST

Errors

6005 Missing users
7231 Invalid offset value

 

 

 

 

 

 

 

 

Related articles