Where can I find my Authorization Token?
URL: https://admin-dt.convoso.com/api/auth-token#/Token
Insert Lead:
API URL: https://api.convoso.com/v1/leads/insert
Required Fields:
- auth_token
- list_id
- phone_number
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 |
user_id | string | User`s ID | Optional |
status | string | Lead`s status | Optional |
created_by | lookup | Created By | Optional |
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 |
age | text | Age | Optional |
notes | textarea_long | Notes | 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 | 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 | boolean | 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 |
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 |
Sample PHP:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/leads/insert');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'd2e422d1311c72c408344465fe2258c2a7356061',
'list_id' => 10,
'phone_number' => '8181234560',
'status' => 'CALLBK',
'phone_code' => 1,
'user' => 'john1',
'FirstName' => 'John',
'LastName' => 'Test',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
{
"success": true,
"data": {
"lead_id": "65007347"
}
}
Update Lead:
Update a lead for the authenticated users.
API URL: https://api.convoso.com/v1/leads/update
Required Fields:
- auth_token
- lead_id
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 |
user | string | User`s username | Optional |
status | string | Lead`s status | Optional |
created_by | lookup | Created By | Optional |
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 |
age | text | Age | Optional |
notes | textarea_long | Notes | Optional |
HTTP Method
POST
Errors
6001 |
No such Lead |
6002 |
No such List |
6006 |
No such User |
6008 |
The phone number is invalid |
Example PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/leads/update');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'd2e422d1311c72c408344465fe2258c2a7356061',
'lead_id' => '65007347',
'list_id' => 10,
'PhoneNumber' => '8181234561',
'phone_code' => 44,
'user' => 'john1',
'status' => 'CALLBK',
'FirstName' => 'John',
'LastName' => 'Test',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response
{
"success": true,
"data": {
"lead_id": "65007347"
}
}
Delete Lead:
Delete a lead for an authenticated user.
API URL: https://api.convoso.com/v1/leads/delete
Required Fields:
- auth_token
- lead_id
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 |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/leads/delete');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'd2e422d1311c72c408344465fe2258c2a7356061',
'lead_id' => '65007347',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response
{
"success": true
}
Search Leads:
API URL: https://api.convoso.com/v1/leads/search
Required Fields:
- auth_token
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 | string | User`s username | Optional |
status | string | Lead`s status | Optional |
created_by | lookup | Created By | Optional (searchable) |
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) |
vertical | text | Vertical | Optional (searchable) |
credit_grade | select | Credit Grade | (non Searchable) |
municipality | checkbox | Pay a Municipality | (non Searchable) |
homeowner | checkbox | Homeowner | (non Searchable) |
roof_flat | checkbox | Flat Roof | (non Searchable) |
roof_accommodating | checkbox | Roof Accommodating | (non Searchable) |
credit_score_old | select | Credit Score Old | (non Searchable) |
shade_level | select | Shade Level | (non Searchable) |
header_text | text | Header Text | (non Searchable) |
employment | select | Employment Status | (non Searchable) |
age | integer | Age | (non Searchable) |
comments | text | Comments | (non Searchable) |
mtg_lates | integer | Number of Mortgage Lates | (non Searchable) |
tax_liens | checkbox | Tax Liens | (non Searchable) |
judgements | checkbox | Judgements | (non Searchable) |
jornaya_leadid_token | text | Jornaya Lead ID | (non Searchable) |
gov_loan | checkbox | Has FHA or VA Loan | (non Searchable) |
employment_status | checkbox | Verifiable Income | (non Searchable) |
military | checkbox | Military | (non Searchable) |
cash_out | integer | Cash Out Amount | (non Searchable) |
property_value | integer | Property Value | (non Searchable) |
ltv | number | LTV | (non Searchable) |
bal_1 | integer | 1st Loan Balance | (non Searchable) |
bal_2 | integer | 2nd Loan Balance | (non Searchable) |
rate_1 | number | 1st Loan Rate | (non Searchable) |
rate_2 | number | 2nd Loan Rate | (non Searchable) |
annual_income | integer | Annual Income | (non Searchable) |
monthly_debt_pmt | integer | Monthly Debt Payment | (non Searchable) |
gross_income | integer | Annual Gross Income | (non Searchable) |
net_income | integer | Monthly Net Income | (non Searchable) |
property_type | select | Property Type | (non Searchable) |
roof_type | select | Roof Type | (non Searchable) |
solar_income | select | Solar Income | (non Searchable) |
utility_other | text | Other Utility | (non Searchable) |
utility_provider | long_select | Utility Provider | (non Searchable) |
solar_taxes | select | Taxes more than $7k | (non Searchable) |
mtg_lates_solar | select | Mtg Lates Last 12 Months | (non Searchable) |
electric_disc | select | Electric Discounts | (non Searchable) |
bk_fc | select | BK/FC Last 3 Years | (non Searchable) |
tree_removal | select | Tree Removal | (non Searchable) |
lp_lead_id | text | LeadsPedia Lead ID | (non Searchable) |
lp_affiliate_id | text | LeadsPedia Affiliate ID | (non Searchable) |
lp_campaign_id | text | LeadsPedia Campaign ID | (non Searchable) |
lp_offer_id | text | LeadsPedia Offer ID | (non Searchable) |
lp_vertical_id | text | LeadsPedia Vertical ID | (non Searchable) |
time_stamp | date | Time Stamp | Optional (searchable) |
lead_date | datetime | Lead Date | Optional (searchable) |
avg_mon_elec_bill | integer | Avg Monthly Electric Bill | (non Searchable) |
source | text | Source | Optional (searchable) |
sms_response | text | SMS Response | (non Searchable) |
ip_address | text | IP Address | (non Searchable) |
source_url | text | Source URL | (non Searchable) |
service_type | select | Service Type | (non Searchable) |
user_name | text | User Name | (non Searchable) |
latitude | text | Latitude | (non Searchable) |
longitude | text | Longitude | (non Searchable) |
field_rep_first | text | Field Rep First | (non Searchable) |
field_rep_last | text | Field Rep Last | (non Searchable) |
field_rep_email | Field Rep Email | (non Searchable) | |
the_source | text | the_source | Optional (searchable) |
cost_per | number | Cost per | Optional (searchable) |
appointment | datetime | Appointment DateTime | (non Searchable) |
solar_specialist | text | Solar Specialist | (non Searchable) |
bill_verified | select | Bill Verified | (non Searchable) |
rmc_date | date | RMC Date | (non Searchable) |
time_stamp_new | datetime | Time Stamp New | (non Searchable) |
cost_per_new | number | Cost per New | (non Searchable) |
source_id_number | text | Source ID | (non Searchable) |
credit_score | select | Credit Score | Optional (searchable) |
shade_level_new | select | Shade Level New | Optional (searchable) |
unsecured_debt | integer | Amount of Unsecured Debt | (non Searchable) |
avg_mon_elec_bill_new | integer | Avg Monthly Electric Bill New | Optional (searchable) |
roof_type_new | select | Roof Type New | Optional (searchable) |
calendars | select | Calendars | (non Searchable) |
appt_type | text | Appt Type | (non Searchable) |
account_number | text | Account Number | (non Searchable) |
county | text | County | (non Searchable) |
usage_jan | text | January Usage | (non Searchable) |
usage_feb | text | February Usage | (non Searchable) |
usage_mar | text | March Usage | (non Searchable) |
usage_apr | text | April Usage | (non Searchable) |
usage_may | text | May Usage | (non Searchable) |
usage_jun | text | June Usage | (non Searchable) |
usage_jul | text | July Usage | (non Searchable) |
usage_aug | text | August Usage | (non Searchable) |
usage_sep | text | September Usage | (non Searchable) |
usage_oct | text | October Usage | (non Searchable) |
usage_nov | text | November Usage | (non Searchable) |
usage_dec | text | December Usage | (non Searchable) |
usage_tot | text | Total Usage | (non Searchable) |
trusted_form_token | text | Trusted Form Token | (non Searchable) |
provider_type | select | Provider Type | (non Searchable) |
lead_dead | text | Lead Dead | Optional (searchable) |
offset | integer | Pagination offset | Optional |
limit (max 2000) | integer | Maximum number of results to retrieve | Optional |
HTTP Method
POST
Errors
6000 |
Missing lists |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/leads/search');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'd2e422d1311c72c408344465fe2258c2a7356061',
'FirstName' => 'John',
'LastName' => 'Test',
'offset' => 0,
'limit' => 10,
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response
{
"success": true,
"data": {
"offset": "0",
"limit": "10",
"total": 1,
"entries": [
{
"id": 38002,
"created_at": "2015-01-29T14:09:57-0800",
"status": "CALLBK",
"phone_number": "8181234561"
},
{
"...": "..."
}
]
}
}
Get Lead Recordings:
API URL: https://api.convoso.com/v1/leads/get-recordings
Required Fields:
- auth_token
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 |
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/leads/get-recordings');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'd2e422d1311c72c408344465fe2258c2a7356061',
'lead_id' => '65007347',
'start_time' => '2010-01-01 00:00:00',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
Example JSON Response
{
"success": true,
"data": {
"offset": 0,
"limit": 10,
"total": 1,
"entries": [
{
"recording_id": 8,
"lead_id": 270,
"start_time": "2014-06-19 21:11:36",
"end_time": "",
"seconds": 10,
"url": "1403237496-all.wav"
}
]
}
}
Agent Performance:
API URL: https://api.convoso.com/v1/agent-performance/search
Required Fields:
- auth_token
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 |
Example PHP
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/agent-performance/search');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'd2e422d1311c72c408344465fe2258c2a7356061',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response
{
"success": true,
"code": 200,
"total": 6,
"data": {
"1000479": {
"name": "Bob Smith",
"talk_sec_pt": 3.31,
"wait_sec_pt": 87.13,
"pause_sec_pt": 8.82,
"wrap_sec_pt": 0.74,
"talk_sec": "00:00:09",
"wait_sec": "00:03:57",
"pause_sec": "00:00:24",
"wrap_sec": "00:00:02",
"total_time": "00:04:32",
"am": 0,
"others": 2,
"calls": 2,
"am_pt": 0,
"others_pt": 100,
"call_type": "",
"user_id": "1000479"
}
}
}
Search Call Logs:
API URL: https://api.convoso.com/v1/log/retrieve
Required Fields:
- auth_token
Arguments
POST Field (case sensitive) | Type | Description | Required/Optional |
---|---|---|---|
auth_token | string | API authentication token | Required |
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 |
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 |
Callbacks:
API URL: https://api.convoso.com/v1/callbacks/search
Documentation URL: https://admin-dt.convoso.com/api/callbacks#/Callbacks
Required Fields:
- auth_token
Errors:
6000 Missing callbacks
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/callbacks/search');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'XXXXXXXXXXX',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
Campaign Status:
API URL: https://api.convoso.com/v1/campaigns/status
Documentation URL: https://admin-dt.convoso.com/api/campaigns#/CampaignStatus
Required Fields:
- auth_token
- campaign_id
- status
HTTP Method: POST
Errors:
6004 Unknown Campaign ID
6010 Missing status
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/campaigns/status');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'XXXXXXXXXXX',
'campaign_id' => 8,
'status' => true,
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
Search Campaign:
API URL: https://api.convoso.com/v1/campaigns/search
Documentation URL: https://admin-dt.convoso.com/api/campaigns#/CampaignSearch
Required Fields:
- auth_token
HTTP Method: POST
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/campaigns/search');
curl_setopt($ch, CURLOPT_POST, 1); 'auth_token' => 'd2e422d1311c72c408344465fe2258c2a7356061')));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
Insert List:
API URL: https://api.convoso.com/v1/lists/insert
Documentation URL: https://admin-dt.convoso.com/api/lists#/ListInsert
Required Fields:
- auth_token
- name
- campaign_id
HTTP Method: POST
Errors:
6003 The List requires a name
6004 Unknown Campaign ID
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/lists/insert');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'XXXXXXXXXX',
'name' => 'List Name',
'campaign_id' => '80',
'description' => 'List Description',
'status' => 1
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
Update List:
API URL: https://api.convoso.com/v1/lists/update
Documentation URL: https://admin-dt.convoso.com/api/lists#/ListUpdate
Required Fields:
- auth_token
- list_id
Errors:
6002 No such List
6004 Unknown Campaign ID
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/lists/update');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'd2e422d1311c72c408344465fe2258c2a7356061',
'list_id' => 17257,
'name' => 'List Name',
'campaign_id' => '81',
'status' => 0
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
Delete List:
API URL: https://api.convoso.com/v1/lists/delete
Documentation URL: https://admin-dt.convoso.com/api/lists#/ListDelete
Required Fields:
- auth_token
- list_id
HTTP Method: POST
Errors:
6002 No such List
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/lists/delete');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'XXXXXXXXXXX',
'list_id' => '17257',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
Search List:
API URL: https://api.convoso.com/v1/lists/search
Documentation URL: https://admin-dt.convoso.com/api/lists#/ListSearch
Required Fields:
- auth_token
- status
HTTP Method: POST
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/lists/search');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'XXXXXXXXX',
'status' => '1',
'campaign_id' => '80'
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
Get Recordings:
API URL: https://api.convoso.com/v1/users/recordings
Documentation URL: https://admin-dt.convoso.com/api/users#/GetRecordings
Required Fields:
- auth_token
- user
HTTP Method: POST
Errors:
6005 Missing users
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/users/recordings');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'XXXXXXXXXX',
'start_time' => '2015-01-01 00:00:00',
'end_time' => '2015-02-01 00:00:00',
'user' => 'john1@gmail.com',
'limit' => 20,
'offset' => 40
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response:
Search:
API URL: https://api.convoso.com/v1/users/search
Documentation URL: https://admin-dt.convoso.com/api/users#/Search
Required Fields:
- auth_token
HTTP Method: POST
Errors:
6005 Missing users
Sample Curl:
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/users/search');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'XXXXXXXXXX',
'user' => 'john1@gmail.com',
'limit' => 20,
'offset' => 40
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
$result = curl_exec($ch);
curl_close($ch);
Example JSON Response: