GET API (HTTP GET Method)

• Getting Started
• API Endpoint
• Acceptable Parameters
• Example Request using cURL
• Example JSON Return
• Example XML Return
• More Info

Calldrip’s REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. Because the REST API is based on open standards, you can use any web development language to access the API. The REST API enables developers to access core function of Calldrip. If you’re building an application that leverages core Calldrip objects, then this is the API for you. Imagine building an interface which enhances your current offering in a matter of minutes – all with a few RESTful API calls. In addition to offering programmatic access to sources, this API also enables developers a multitude of integration opportunities to interact with Calldrip. Through the REST API, the user can create and post real-time calls, and set options with each call.

API Endpoint

US: https://app.calldrip.com/api/scoreddata
EU: https://app.calldrip.eu/api/scoreddata

Acceptable Parameters

GET API Parameters

{warning} Important! Keep your API Key safe.

Example Request using cURL

URL

GET https://app.calldrip.eu/api/scoreddata?apikey=asdf2134132okajsdf2r84jn&fromDate=2015-12-01&toDate=2016-01-20&returnType=json

cURL

$url = "https://app.calldrip.eu/api/scoreddata";
$apikey = "asdf2134132okajsdf2r84jn";
$sdate = "2015-12-01";
$edate = "2016-01-20";
$returntype = "json";
$get_params ="apikey={$apikey}&fromDate={$sdate}&toDate={$edate}&returnType={$returntype}";
$final_url = $url . '?' . $get_params;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $final_url);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 5);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_FOLLOWLOCATION, 1);
curl_setopt($ch, CURLOPT_POST, 0);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, 0);
$result = curl_exec($ch);
curl_close($ch);

Example JSON Return

{
  "id": "12345",
  "altid": "54321, 789872",
  "dealerName": "Calldrip Auto",
  "source": "Calldrip Test",
  "status": "ANSWER",
  "date": "2016-11-17",
  "time": "14:12:20",
  "firstName": "Calldrip",
  "lastName": "Lead",
  "email": "calldriplead@calldrip.com",
  "phone": "5555555555",
  "callNotes": "No Notes",
  "callAttempts": null,
  "callDuration": "141",
  "callRecording": "https://calldrip.colynk.eu/calldrip/dealrec.php?rec=CalldripLead",
  "agent": "Calldrip Agent",
  "responseTime": null,
  "scoredFname": "Calldrip",
  "scoredlname": "Lead",
  "altPhone": "5555555555", 
  "callSummary": "Joe calls Calldrip Lead to inform him that they have the blue vehicle in stock, and it's ready to be picked up whenever Calldirp is.",
  "scoredEmail": "calldriplead@calldrip.com",
  "scoredAgent": "Calldrip Agent",
  "department": "New",
  "scoredNotes": "Calldrip contacted Lead in regards to his online inquiry. They discuss vehicle details that interest Lead. Will made an appointment for Lead to visit the dealership the following Wednesday at 1:15 p.m. He plans to send Lead an email with his contact information. ",
  "appointmentDate": "2016-11-23",
  "appointmentTime": "13:15",
  "callEnd": "Spoke with Agent",
  "alert": "none",
  "currentMake": "",
  "currentModel": "",
  "currentYear": "",
  "currentRegistrationNumber": "",
  "currentSummary": "",
  "calledOnMake": "Toyota",
  "calledOnModel": "RAV4",
  "calledOnYear": "2016",
  "calledOnRegistrationNumber": "",
  "calledOnSummary": "",
  "transcibedBy": "TB",
  "leadtype": null,
  "cat1Name": "Enthusiastic Greeting w\/name:",
  "cat2Name": "Taking Control, did not answer first question",
  "cat3Name": "Qualified Customers Needs:",
  "cat4Name": "Attempted to set appointment:",
  "cat5Name": "Pen and Paper:",
  "cat6Name": "Driving Directions",
  "cat7Name": "Sales Appointment Set",
  "cat8Name": null,
  "cat9Name": null,
  "cat10Name": null,
  "cat1": "1",
  "cat2": "1",
  "cat3": "1",
  "cat4": "1",
  "cat5": "1",
  "cat6": "0",
  "cat7": "0",
  "cat8": "0",
  "cat9": "0",
  "cat10": "0",
  "wow": "0",
  "coachNotes": null,
  "coachedBy": null
}

Example XML Return

<?xml version='1.0' encoding='UTF-8'?>
<calldrip>
    <id>12345</id>
    <altid>54321, 789872</altid>
    <dealerInfo>
        <name>Calldrip Autos</name>
    </dealerInfo>
    <dripInfo>
        <name id='first'>Calldrip</name>
        <name id='last'>Lead</name>
        <phone>5555555555</phone>
        <email>calldriplead@calldrip.com</email>
    </dripInfo>
    <callInfo>
        <source>Calldrip Test</source>
        <status>ANSWER</status>
        <date>2016-11-17</date>
        <time>14:12:20</time>
        <callNotes>No Notes</callNotes>
        <callAttempts></callAttempts>
        <callDuration>141</callDuration>
        <callRecording>https://calldrip.colynk.com/calldrip/dealrec.php?rec=KhongNg
            uyen1479417140.390698</callRecording>
        <agent>Calldrip Agent</agent>
        <responseTime></responseTime>
        <callSummary>Joe calls Calldrip Lead to inform him that they have the blue vehicle in stock, and it's ready to be picked up whenever Calldirp is.</callSummary>
    </callInfo>
    <scoreData>
        <scoredFname>Calldrip</scoredFname>
        <scoredLname>Lead</scoredLname>
        <altPhone>555555555</altPhone>
        <scoredEmail>calldriplead@calldrip.com</scoredEmail>
        <scoredAgent>Calldrip Agent</scoredAgent>
        <department>New</department>
        <scoredNotes>Agent contacted prospect in regards to his online inquiry. They discuss vehicle details that interest the prospect. Will made an appointment for prospect to visit the dealership the following Wednesday at 1:15 p.m. He plans to send prospect an email with his contact information.
        </scoredNotes>
        <appointmentDate>2016-11-23</appointmentDate>
        <appointmentTime>13:15</appointmentTime>
        <callEnd>Spoke with Agent</callEnd>
        <alert>none</alert>
        <vehicle>
            <current>
                <make></make>
                <model></model>
                <year></year>
                <registrationNumber></registrationNumber>
                <summary></summary>
            </current>
            <calledOn>
                <make>Toyota</make>
                <model>RAV4</model>
                <year>2016</year>
                <registrationNumber></registrationNumber>
                <summary></summary>
            </calledOn>
        </vehicle>
        <transcibedBy>TB</transcibedBy>
        <leadtype>Web</leadtype>
        <scoreCategories>
            <cat1 name='Enthusiastic Greeting w/name:'>1</cat1>
            <cat2 name='Taking Control, did not answer first
question'>1</cat2>
            <cat3 name='Qualified Customers Needs:'>1</cat3>
            <cat4 name='Attempted to set appointment:'>1</cat4>
            <cat5 name='Pen and Paper:'>1</cat5>
            <cat6 name='Driving Directions'>0</cat6>
            <cat7 name='Sales Appointment Set'>0</cat7>
            <cat8 name=''>0</cat8>
            <cat9 name=''>0</cat9>
            <cat10 name=''>0</cat10>
        </scoreCategories>
        <wow>0</wow>
        <coachNotes></coachNotes>
        <coachedBy></coachedBy>
    </scoreData>
</calldrip>

More Info

Questions? product@calldrip.com