Articles in this section

API Documentation

Avatar
Matt Beam
Updated
Follow

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

Documentation URL: https://admin-dt.convoso.com/api/leads#/LeadInsert

Required Fields:

  1. auth_token
  2. list_id
  3. phone_number

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 Curl:

$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' => 'XXXXXXXXXX',
'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:

Update Lead:

API URL: https://api.convoso.com/v1/leads/update

Documentation URL: https://admin-dt.convoso.com/api/leads#/LeadUpdate

Required Fields:

  1. auth_token
  2. lead_id

HTTP Method: POST

Errors:

6001 No such Lead
6002 No such List
6006 No such User
6008 The phone number is invalid

Sample Curl:

$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' => 'XXXXXXXXXX',
'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:

Delete Lead:

API URL: https://api.convoso.com/v1/leads/delete

Documentation URL: https://admin-dt.convoso.com/api/leads#/LeadDelete

Required Fields:

  1. auth_token
  2. lead_id

HTTP Method: POST

Errors:

6001 No such Lead

Sample Curl:

$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' => 'XXXXXXXXXX',
'lead_id' => '65007347',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$result = curl_exec($ch);

curl_close($ch);

Example JSON Response:

Search Leads:

API URL: https://api.convoso.com/v1/leads/search

Documentation URL: https://admin-dt.convoso.com/api/leads#/LeadSearch

Required Fields:

  1. auth_token

HTTP Method: POST

Errors:

6000 Missing lists

Sample Curl:

$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' => 'XXXXXXXXXX',
'FirstName' => 'John',
'LastName' => 'Test',
'offset' => 0,
'limit' => 10,
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$result = curl_exec($ch);

curl_close($ch);

Example JSON Response:

Get Lead Recordings:

API URL: https://api.convoso.com/v1/leads/get-recordings

Documentation URL: https://admin-dt.convoso.com/api/leads#/LeadGetRecordings

Required Fields:

  1. auth_token

HTTP Method: POST

Errors:

6005 Missing users

Sample Curl:

$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' => 'XXXXXXXXXX',
'lead_id' => '65007347',
'start_time' => '2010-01-01 00:00:00',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

 

$result = curl_exec($ch);

Example JSON Response:

Agent Performance:

API URL: https://api.convoso.com/v1/agent-performance/search

Documentation URL: https://admin-dt.convoso.com/api/agent-performance#/AgentPerformance

Required Fields:

  1. auth_token

HTTP Method: POST

Errors:

6031 Missing Agents

Sample Curl:

$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' => 'XXXXXXXXXXX',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

$result = curl_exec($ch);

curl_close($ch);

Example JSON Response:

Call Logs:

API URL: https://api.convoso.com/v1/log/retrieve

Documentation URL: https://admin-dt.convoso.com/api/call-logs#/CallLogs

Required Fields:

  1. auth_token

HTTP Method: POST

Errors:

6002 Unknown List Id
6006 Unknown User Id
6004 Unknown Campaign ID
6030 Unknown Queue ID

Sample Curl:

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.convoso.com/v1/log/retrieve');
curl_setopt($ch, CURLOPT_POST, 1);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query(array(
'auth_token' => 'XXXXXXXXXX',
)));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);

 

$result = curl_exec($ch);

curl_close($ch);

Example JSON Response:

Callbacks:

API URL: https://api.convoso.com/v1/callbacks/search

Documentation URL: https://admin-dt.convoso.com/api/callbacks#/Callbacks

Required Fields:

  1. 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:

  1. auth_token
  2. campaign_id
  3. 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:

  1. 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:

  1. auth_token
  2. name
  3. 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:

  1. auth_token
  2. 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:

  1. auth_token
  2. 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:

  1. auth_token
  2. 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:

  1. auth_token
  2. 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:

  1. 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:

 

Related articles