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:

1. auth_token
2. list_id
3. phone_number

Insert Lead

Arguments

HTTP Method

POST

Errors

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:

1. auth_token
2. lead_id

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

1. auth_token
2. lead_id

$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);

{
  "success": true
}

Search Leads:

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

Required Fields:

1. auth_token

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

1. auth_token

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

1. auth_token

Retrieving agent performance records

Arguments

HTTP Method

POST

Errors

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:

1. auth_token

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: