API Reference

Get the list of bought numbers API

Filters

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/numbers/"

headers = {
    'authorization':"XXXXXX-XXXX-XXXX-XXXXXXXXX",
    'x-api-key':"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

response =requests.request("GET", url,headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/numbers/",
  "method": "GET",
  "headers": {
    "authorization":"XXXXXXX-XXXX-XXXX-XXXXXXX",
    "x-api-key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  }
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/numbers/",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_HTTPHEADER =>array(
    "authorization:XXXXXX-XXXX-XXXX-XXXXXXXXXX",
    "x-api-key:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Call Center API to create an order.

Body Description

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/call-center/create_order/"

payload = "{\n     \"ivr_id\":\"100xxxxx20\",\n     \"additional_number\":\"+919xxxxxxx89\",\n     \"timezone\":\"Asia/Kolkata\",\n     \"priority\":10, \n     \"order-throttling\":2,\n     \"start_time\":\"2018-07-2018:17\", \n     \"call_scheduling_start_time\":\"09:00\",\n     \"call_scheduling_stop_time\":\"23:00\",\n     \"is_transactional\":1 ,\n     \"user_plan_id\":440274 ,\n     \"outbound_callcenter\":1 ,\n     \"call_scheduling\":[1,1,1,1,1,1,1],\n     \"end_time\":\"2018-07-2018:35\"\n}"
headers = {
    'authorization':"550xxxxxxxxxxxxxxxxxxa97e612",
    'content-type':"application/json",
    'x-api-key':"NRMxxxxxxxxxxxxxxxxxx8rxsDMlo",

    }

response =requests.request("POST", url,data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/call-center/create_order/",
  "method": "POST",
  "headers": {
    "authorization":"550xxxxxxxxxxxxxxx4a97e612",
    "content-type":"application/json",
    "x-api-key":"NRxxxxxxxxxxxxxxxxxxxxxxxx4iVH768rxsDMlo",
  },
  "processData": false,
  "data": "{\n     \"ivr_id\":\"10xxxxxxxx0520\",\n     \"additional_number\":\"+91xxxxxx589\",\n     \"timezone\":\"Asia/Kolkata\",\n     \"priority\":10, \n     \"order-throttling\":2,\n     \"start_time\":\"2018-07-2018:17\", \n     \"call_scheduling_start_time\":\"09:00\",\n     \"call_scheduling_stop_time\":\"23:00\",\n     \"is_transactional\":1 ,\n     \"user_plan_id\":44xx74 ,\n     \"outbound_callcenter\":1 ,\n     \"call_scheduling\":[1,1,1,1,1,1,1],\n     \"end_time\":\"2018-07-2018:35\"\n}"
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/call-center/create_order/",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "POST",
  CURLOPT_POSTFIELDS =>"{\n     \"ivr_id\":\"10xxxxxx0\",\n     \"additional_number\":\"+9199xxxxx589\",\n     \"timezone\":\"Asia/Kolkata\",\n     \"priority\":10, \n     \"order-throttling\":2,\n     \"start_time\":\"2018-07-2018:17\", \n     \"call_scheduling_start_time\":\"09:00\",\n     \"call_scheduling_stop_time\":\"23:00\",\n     \"is_transactional\":1 ,\n     \"user_plan_id\":4xxx74 ,\n     \"outbound_callcenter\":1 ,\n     \"call_scheduling\":[1,1,1,1,1,1,1],\n     \"end_time\":\"2018-07-2018:35\"\n}",
  CURLOPT_HTTPHEADER =>array(
    "authorization:5508xxxxxxxxxxxxxxxxxxxx8874a97e612",
    "cache-control:no-cache",
    "content-type:application/json",
    "x-api-key:NRMxxxEB9xxxxxxxxxxxxxxxxxxxxxx8rxsDMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

API to add number in a campaign,by assiging it to an existing order_id whose status is either in progress or pending.

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/call-center/add_call_to_order"

payload = "{\n  \"order_id\":19xxxx88, \n  \"phone_numbers\":\"+9191xxxxx66\",\n  \"call_times_retry\":3, \n  \"retry_timedelta\":1 \n}"
headers = {
    'authorization':"5508exxxxxxxxxxxxxxxx874a97e612",
    'x-api-key':"NRMxxxxxxxxxxxxxiVH768rxsDMlo",
    'content-type':"application/json",
    }

response =requests.request("PUT", url,data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/call-center/add_call_to_order",
  "method": "PUT",
  "headers": {
    "authorization":"5508ed2xxxxxxxxxx874a97e612",
    "x-api-key":"NRMPGxxxxxxxxxxxH768rxsDMlo",
    "content-type":"application/json",
  },
  "processData": false,
  "data": "{\n  \"order_id\":19xxx488, \n  \"phone_numbers\":\"+91xxxx69466\",\n  \"call_times_retry\":3, \n  \"retry_timedelta\":1 \n}"
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/call-center/add_call_to_order",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "PUT",
  CURLOPT_POSTFIELDS =>"{\n  \"order_id\":19xxxxx88, \n  \"phone_numbers\":\"+9xxxxxx9466\",\n  \"call_times_retry\":3, \n  \"retry_timedelta\":1 \n}",
  CURLOPT_HTTPHEADER =>array(
    "authorization:550xxxxxxxxxxxxx7e612",
    "content-type:application/json",
    "x-api-key:NRMPGExxxxxxxxxxxxxxxxxxxxxxxxxxxxsDMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Lists out all the circle ids against a telco-circle. Optional. If want to get circles for of the provided country. If not provided then it will pick the country from your account setting

Body Description

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/numbers/Circle"

headers = {
    'authorization':"XXXXXX-XXXXX-XXXX-XXXXXX",
    'x-api-key':"XXXXXXXXXXXXXXXXXXXXXXXXXXX",
    }

response =requests.request("GET", url,headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/numbers/Circle",
  "method": "GET",
  "headers": {
    "authorization":"XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX",
    "x-api-key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/numbers/Circle",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_HTTPHEADER =>array(
    "authorization:"XXXXXXX-XXXX-XXXX-XXXXXXXX",
    "x-api-key:XXXXXXXXXXXXXXXXXXXXXXXXXXX"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Lists out all the plan details associated with an account

Body Description

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/plans"

headers = {
    'authorization':"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX",
    'x-api-key':"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    }

response =requests.request("GET", url,headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/plans",
  "method": "GET",
  "headers": {
    "authorization":"XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX",
    "x-api-key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/plans",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_HTTPHEADER =>array(
    "authorization:XXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX",
    "x-api-key:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Lists out all the available phone numbers in the telco-circles

Body Description

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/numbers/AvailablePhoneNumbers"

querystring = {"circle_id":"1"}

headers = {
    'authorization':"XXXXXXX-XXXX-XXXX-XXXXXXXXXX",
    'x-api-key':"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    }

response =requests.request("GET", url,headers=headers,params=querystring)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/numbers/AvailablePhoneNumbers?circle_id=1",
  "method": "GET",
  "headers": {
    "authorization":"XXXXXX-XXXX-XXXX-XXXXXXXXXXXXXX",
    "x-api-key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  }
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/numbers/AvailablePhoneNumbers?circle_id=1",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_HTTPHEADER =>array(
    "authorization:XXXXXXX-XXXXXX-XXX-XXXXXXX",
    "x-api-key:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Allocate the available phone numbers in the telco-circles for a particular plan id with an expiry time

Body Description

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/numbers"

payload = "{\"user_plan_id\":\"XXXX\",\n\"expiry_time\":\"2017-04-2500:00:00\",\n\"number\":\"+91XXXXXXXXXX\"\n}"
headers = {
    'authorization':"XXXXXX-XXXX-XXXX-XXXXXXX",
    'content-type':"application/json",
    'x-api-key':"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    }

response =requests.request("POST", url,data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/numbers",
  "method": "POST",
  "headers": {
    "authorization":"XXXXXX-XXXX-XXXX-XXXXXXX",
    "content-type":"application/json",
    "x-api-key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  },
  "processData": false,
  "data": "{\"user_plan_id\":\"XXXX\",\n\"expiry_time\":\"2017-04-2500:00:00\",\n\"number\":\"+91XXXXXXXXXX\"\n}"
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/numbers",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "POST",
  CURLOPT_POSTFIELDS =>"{\"user_plan_id\":\"XXXX\",\n\"expiry_time\":\"2017-04-2500:00:00\",\n\"number\":\"+91XXXXXXXXXX\"\n}",
  CURLOPT_HTTPHEADER =>array(
    "authorization:XXXXXX-XXXX-XXXX-XXXXXXX"
    "content-type:application/json",
    "x-api-key:XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

The Sound API is an important tool to upload and list sound under an account.
Once the developer upload a sound it goes under approval process. Then Knowlarity's support team authorize the sound on the basis of the content and mark it as "Approved" or "Rejected".
The developer can use only approved sound in the campaigns.

Using Sound API the developer can:

1. 1. Upload a sound file
2. 2. List all the sound files.

This API allows developers upload phonebook which they can use in campaign API.

This API includes:

1. 1. Uploading of phonebook
2. 2. Listing of uploaded phonebook

Get list of phonebooks associated with the SR account.

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/contacts/phonebook/"

headers = {
    'authorization':"046XXXXXXXXXXXXXXXXXXXXXXXXXXXX301",
    'x-api-key':"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    'cache-control':"no-cache"
    }

response =requests.request("GET", url,headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/contacts/phonebook/",
  "method": "GET",
  "headers": {
    "authorization":"046XXXXXXXXXXXXXXXXXXXXXXXXXXXX301",
    "x-api-key":"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    "cache-control":"no-cache"
  }
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/contacts/phonebook/",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046XXXXXXXXXXXXXXXXXXXXXXXXXXXX301",
    "cache-control:no-cache",
    "x-api-key:NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Upload a phonebook in associated SR account.

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/contacts/phonebook"

payload = "{\n\"phonebookname\":\"phonebook_1\",\n\"numbers\":\"+91XXXXXXXXXX;+91XXXXXXXXXX\"\n}\n"
headers = {
    'authorization':"046XXXXXXXXXXXXXXXXXXXXXXXXXX301",
    'x-api-key':"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    'content-type':"application/json",
    'cache-control':"no-cache",
    }

response =requests.request("POST", url,data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/contacts/phonebook",
  "method": "POST",
  "headers": {
    "authorization":"046XXXXXXXXXXXXXXXXXXXXXXXXXX301",
    "x-api-key":"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    "content-type":"application/json",
    "cache-control":"no-cache",
  },
  "processData": false,
  "data": "{\n\"phonebookname\":\"phonebook_1\",\n\"numbers\":\"+91XXXXXXXXXX;+91XXXXXXXXXX\"\n}\n"
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/contacts/phonebook",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "POST",
  CURLOPT_POSTFIELDS =>"{\n\"phonebookname\":\"phonebook_1\",\n\"numbers\":\"+91XXXXXXXXXX;+91XXXXXXXXXX\"\n}\n",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046XXXXXXXXXXXXXXXXXXXXXXXXXX301",
    "cache-control:no-cache",
    "content-type:application/json",
    "x-api-key:NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Get list of sounds associated with the SR account.

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/sound"

headers = {
    'authorization':"046XXXXXXXXXXXXXXXXXXXXXXXXXXX301",
    'x-api-key':"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    'cache-control':"no-cache",
    }

response =requests.request("GET", url,headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/sound",
  "method": "GET",
  "headers": {
    "authorization":"046XXXXXXXXXXXXXXXXXXXXXXXXXXX301",
    "x-api-key":"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    "cache-control":"no-cache",
  }
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/sound",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046XXXXXXXXXXXXXXXXXXXXXXXXXXX301",
    "cache-control:no-cache",
    "x-api-key:NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

This API allows developers to handle agent-related customizations. This powerful API has many uses, including but not limited to defining factors for call routing, providing role-based access rights and tracking agent work schedules. It helps manage the users in a contact center solution.
Agent Details - In order to create an agent, you must enter correct values for name, phone number and email address. This will help generate a unique ID for each agent in your account.
Role - This attribute assigns hierarchical roles to the agents in the account. Supervisors and Agents have different levels of access in the account and the agent API allows you to set the correct access level for every agent.
Status - This attribute gives us the availability of an agent to receive a call. In addition, this helps keep a track of agent performance.
Call Groups - This attribute allows segmentation of users based on their teams. The call groups can be defined based on your team structure and this information can be utilized while deciding the call flow.

Upload sound to the associated SR account.

After uploading sound, user will get it's status as '0' which means the sound is under approval process which is done by Knowlarity's support team.
Status description -
Under Approval : '0'
Approved : '1'
Rejected : '2'

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/sound/"

payload = "{\n    \"soundname\":\"test\",\n    \"soundfile\":\"https://XXXXXXXXXXXXXXXXXXXX.mp3\",\n    \"description\":\"test\",\n    \"language\":\"eng\"\n    \n}\n\n\n"
headers = {
    'authorization':"046XXXXXXXXXXXXXXXXXXXXXX301",
    'x-api-key':"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    'content-type':"application/json",
    'cache-control':"no-cache",
    }

response =requests.request("POST", url,data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/sound/",
  "method": "POST",
  "headers": {
    "authorization":"046XXXXXXXXXXXXXXXXXXXXXX301",
    "x-api-key":"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    "content-type":"application/json",
    "cache-control":"no-cache",
  },
  "processData": false,
  "data": "{\n    \"soundname\":\"test\",\n    \"soundfile\":\"https://XXXXXXXXXXXXXXXXXXXX.mp3\",\n    \"description\":\"test\",\n    \"language\":\"eng\"\n    \n}\n\n\n"
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/sound/",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "POST",
  CURLOPT_POSTFIELDS =>"{\n    \"soundname\":\"test\",\n    \"soundfile\":\"https://XXXXXXXXXXXXXXXXXXXX.mp3\",\n    \"description\":\"test\",\n    \"language\":\"eng\"\n    \n}\n\n\n",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046XXXXXXXXXXXXXXXXXXXXXX301",
    "cache-control:no-cache",
    "content-type:application/json",
    "x-api-key:NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

List out all the campaigns created via the SR account.

Filters Description

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/call/campaign"

querystring = {"start_time__gt":"2017-04-10","start_time__lt":"2017-04-12"}

headers = {
    'authorization':"046XXXXXXXXXXXXXXXXXXXXXXXX301",
    'x-api-key':"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    'cache-control':"no-cache",
    }

response =requests.request("GET", url,headers=headers,params=querystring)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/call/campaign?start_time__gt=2017-04-10&start_time__lt=2017-04-12",
  "method": "GET",
  "headers": {
    "authorization":"046XXXXXXXXXXXXXXXXXXXXXXXX301",
    "x-api-key":"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    "cache-control":"no-cache",
  }
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/call/campaign?start_time__gt=2017-04-10&start_time__lt=2017-04-12",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046XXXXXXXXXXXXXXXXXXXXXXXX301",
    "cache-control:no-cache",
    "x-api-key:NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

API to create a campaign

Body Description

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/call/campaign"

payload = "{\"sound_id\":1,\n\"phonebook\":1,\n\"timezone\":\"Asia/Kolkata\",\n\"priority\":1,\n\"order_throttling\":10,\n\"retry_duration\":15,\n\"max_retry\":1,\n\"start_time\":\"2017-04-1118:26\",\n\"call_scheduling\":\"[1,1, 1, 1, 1, 0,0]\",\n\"call_scheduling_start_time\":\"9:00\",\n\"call_scheduling_stop_time\":\"21:00\",\n\"k_number\":\"+91XXXXXXXXXX\",\n\"additional_number\":\"\"\n}"
headers = {
    'authorization':"046XXXXXXXXXXXXXXXXXXXX301",
    'x-api-key':"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    'content-type':"application/json",
    'cache-control':"no-cache",
    }

response =requests.request("POST", url,data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/call/campaign",
  "method": "POST",
  "headers": {
    "authorization":"046XXXXXXXXXXXXXXXXXXXX301",
    "x-api-key":"NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo",
    "content-type":"application/json",
    "cache-control":"no-cache",
  },
  "processData": false,
  "data": "{\"sound_id\":1,\n\"phonebook\":1,\n\"timezone\":\"Asia/Kolkata\",\n\"priority\":1,\n\"order_throttling\":10,\n\"retry_duration\":15,\n\"max_retry\":1,\n\"start_time\":\"2017-04-1118:26\",\n\"call_scheduling\":\"[1,1, 1, 1, 1, 0,0]\",\n\"call_scheduling_start_time\":\"9:00\",\n\"call_scheduling_stop_time\":\"21:00\",\n\"k_number\":\"+91XXXXXXXXXX\",\n\"additional_number\":\"\"\n}"
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/call/campaign",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "POST",
  CURLOPT_POSTFIELDS =>"{\"sound_id\":1,\n\"phonebook\":1,\n\"timezone\":\"Asia/Kolkata\",\n\"priority\":1,\n\"order_throttling\":10,\n\"retry_duration\":15,\n\"max_retry\":1,\n\"start_time\":\"2017-04-1118:26\",\n\"call_scheduling\":\"[1,1, 1, 1, 1, 0,0]\",\n\"call_scheduling_start_time\":\"9:00\",\n\"call_scheduling_stop_time\":\"21:00\",\n\"k_number\":\"+91XXXXXXXXXX\",\n\"additional_number\":\"\"\n}",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046XXXXXXXXXXXXXXXXXXXX301",
    "content-type:application/json"
    "x-api-key:NRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

API to control the campaign.

Status can be pause, resume and stop

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/call/campaign/1xx"

payload = "{\n  \"status\": \"stop\"\n}"
headers = {
    'authorization':"046ccxxxxxxxxxxxxxxx20e9301",
    'x-api-key':"NRMxxxxxxxxxxxxxxxxxH768rxsDMlo",
    'cache-control':"no-cache",
    }

response =requests.request("PUT", url,data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/call/campaign/1xx",
  "method": "PUT",
  "headers": {
    "authorization":"046ccxxxxxxxxxxxxxxxx0e9301",
    "x-api-key":"NRMPGExxxxxxxxxxxxxxx0iT4iVH768rxsDMlo",
    "cache-control":"no-cache",
  },
  "data": "{\n  \"status\": \"stop\"\n}"
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/call/campaign/123",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "PUT",
  CURLOPT_POSTFIELDS =>"{\n  \"status\":\"stop\"\n}",
  CURLOPT_HTTPHEADER =>array(
    "authorization:04xxxxxxxxxxx9301",
    "cache-control:no-cache",
    "x-api-key:NRxxxxxxxxxxxxxxxxxxxMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

API to add number in a campaign whose status is either in progress or pending.

Notes - sivr_call_ids in response is the set of call ids generated by product and used for all retry attempts of a call.

import requests

url ="https://kpi.knowlarity.com/test/v1/account/call/campaign/add-numbers/"

payload = "{\n\t\"order_id\":178,\n\t\"phone_numbers\":\"+9170xxxx0689\"\n}"
headers = {
    'authorization':"046ccxxxxxxxxxxxxxx67cf20e9301",
    'x-api-key':"NRMxxxxxxxxxxxxxxxxxxxxH768rxsDMlo",
    'content-type':"application/json"
    }

response =requests.request("POST", url,data=payload, headers=headers)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/test/v1/account/call/campaign/add-numbers/",
  "method": "POST",
  "headers": {
    "authorization":"046cc3f4-xxxxxxxxxxxxxxxxxx67cf20e9301",
    "x-api-key":"NRMPxxxxxxxxxxxxxxxxxxxiT48rxsDMlo",
    "content-type":"application/json"
  },
  "processData": false,
  "data": "{\n\t\"order_id\":178,\n\t\"phone_numbers\":\"+917xxxxxx0689\"\n}"
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/test/v1/account/call/campaign/add-numbers/",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "POST",
  CURLOPT_POSTFIELDS =>"{\n\t\"order_id\":178,\n\t\"phone_numbers\":\"+9170xxxxx0689\"\n}",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046ccxxxxxxxxxxxxxxx-067cf20e9301",
    "content-type:application/json",
    "x-api-key:NRMPxxxxxxxxxxxxxxxx4iVH768rxsDMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

SuperReceptionist’s first aim is to help businesses so that they never lose a lead. We understand how important every lead is and we have a simple solution to deal with the problem of missing out on leads - generating Follow-up Tasks for any missed or deferred calls using the Tasks API.
This API is especially useful to capture leads for the calls received during a missed call campaign. Once the list of callers has been identified via call logs API, the Tasks API allows the calls to be assigned to agents with specific due-dates.
This also means that agents can schedule reminders for follow-up calls to customers, thus plan their work more efficiently. Inputs like creation time, due date, status etc. are highly useful in analyzing agent-performances and in planning for high call volumes.

An important aspect of any contact centre solution is the information capturing mechanism or the CRM. Using Contact APIs, the developer can store and retrieve customer details. Results can be filtered using attributes like status, phone number, email address etc. You can also assign a status to the customers, edit their details etc.
You can also customize your searches. For eg. Finding out how many calls someone with the status ‘Hot’ made in the last month, all you would need to do is query all ‘Hot’ leads using Contacts API and then use Call-log APIs to get the logs of those callers.

Call APIs are used to make outbound calls. These APIs can be used in two ways:

While making multiple calls, the developer can do a plethora of customizations. Some of them are:

- defining call timings,
- setting priority while running multiple campaigns,
- scheduling the time,
- starting, pausing or stopping a campaign,
- adding phone numbers to a live campaign,
- selecting the number of concurrent calls to be made by the system
- defining the nature of a campaign - Transactional or Promotional - based on regulatory permitting limitations.**
- Getting a list of ongoing campaigns with their real-time status.

In short, call API helps you save manual intervention and organize communication for you like never before.
**Please be noted that Transactional campaigns are not allowed by default due to legal restrictions set by TRAI. If you wish to avail this feature, please get in touch with our support team to help you get the required clearance.

Notification APIs allow your SuperReceptionist number to receive notifications about any live calls. Using this API, developers can build highly verbose applications (eg. two users connected in a call can be notified about the status of the call).
The API uses a streaming API that generates various events (refer table below) which can be monitored by developers. Each event has a different call status (eg. ORIGINATE_AGENT_CALL, which means the call has been originated from the SuperReceptionist web panel to the agent’s number).
The developer can also set specific actions for each of these events (eg. For all HANGUP statuses, the developer can send a "Thank You" message).
This API facilitates the development of an interactive application, thereby leads to improvement in user experience and better relationship with customers.

Fetches list of agents for a given SR Account.

This API call fetches the details of an agent.

Fetches all call logs matching the given filters

Request Parameters

Response Fields

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/calllog"

payload = ""
headers = {
    'channel': "Basic",
    'x-api-key':"NRMPGEBxxxxxxxxxx7sa5xxxxxVH768rxsDMlo",
    'authorization':"046cc3f4xxxxxxxxxx7sa5xxxxxcf20e9301",
    'content-type':"application/json",
    'start_time':"2017-03-13 12:00:00+05:30",
    'end_time':"2017-03-14 12:00:00+05:30",
    'cache-control':"no-cache",
    }

response =requests.request("GET", url,data=payload, headers=headers)

print(response.text)

var http = require("https");

var options = {
  "method": "GET",
  "hostname":"kpi.knowlarity.com",
  "port": null,
  "path":"/Basic/v1/account/calllog",
  "headers": {
    "channel": "Basic",
    "x-api-key":"NRMPGEBxxxxxxxxxx7sa5xxxxxH768rxsDMlo",
    "authorization":"046cc3xxxxxxxxxx7sa5xxxxx7cf20e9301",
    "content-type":"application/json",
    "start_time":"2017-03-13 12:00:00+05:30",
    "end_time":"2017-03-14 12:00:00+05:30",
    "cache-control":"no-cache",
  }
};

var req =http.request(options, function(res) {
  var chunks = [];

  res.on("data", function(chunk) {
    chunks.push(chunk);
  });

  res.on("end", function() {
    var body =Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/calllog",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_POSTFIELDS =>"",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046cc3xxxxxxxxxx7sa5xxxxxcf20e9301",
    "cache-control:no-cache",
    "channel: Basic",
    "content-type:application/json",
    "end_time: 2017-03-1412:00:00+05:30",
    "start_time:2017-03-13 12:00:00+05:30",
    "x-api-key:NRMPGExxxxxxxxxx7sa5xxxxxH768rxsDMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Get List of tasks associated with SR Account.

var http = require("https");

var options = {
  "method": "GET",
  "hostname":"kpi.knowlarity.com",
  "port": null,
  "path":"/Basic/v1/account/tasks",
  "headers": {
    "channel": "Basic",
    "x-api-key":"NRMPGxxxxxxxxxx7sa5xxxxxH768rxsDMlo",
    "authorization":"046ccxxxxxxxxxx7sa5xxxxx0e9301",
    "content-type":"application/json",
    "cache-control":"no-cache",
  }
};

var req =http.request(options, function(res) {
  var chunks = [];

  res.on("data", function(chunk) {
    chunks.push(chunk);
  });

  res.on("end", function() {
    var body =Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/tasks"

payload = ""
headers = {
    'channel': "Basic",
    'x-api-key':"NRMPGEBxxxxxxxxxx7sa5xxxxx68rxsDMlo",
    'authorization':"046cxxxxxxxxxx7sa5xxxxxcf20e9301",
    'content-type':"application/json",
    'cache-control':"no-cache",
    }

response =requests.request("GET", url,data=payload, headers=headers)

print(response.text)

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/tasks",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_POSTFIELDS =>"",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046cc3xxxxxxxxxx7sa5xxxxx7cf20e9301",
    "cache-control:no-cache",
    "channel: Basic",
    "content-type:application/json",
    "x-api-key:NRMPGEBxxxxxxxxxx7sa5xxxxxVH768rxsDMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Fetch a specific Task under an account

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/tasks/4591040"

payload = ""
headers = {
    'channel': "Basic",
    'x-api-key':"NRMPGxxxxxxxxxx7sa5xxxxxxsDMlo",
    'authorization':"046cxxxxxxxxxx7sa5xxxxx0e9301",
    'content-type':"application/json",
    'cache-control':"no-cache",
    }

response =requests.request("GET", url,data=payload, headers=headers)

print(response.text)

var http = require("https");

var options = {
  "method": "GET",
  "hostname":"kpi.knowlarity.com",
  "port": null,
  "path":"/Basic/v1/account/tasks/4591040",
  "headers": {
    "channel": "Basic",
    "x-api-key":"NRMPGEBxxxxxxxxxx7sa5xxxxxVH768rxsDMlo",
    "authorization":"046cc3xxxxxxxxxx7sa5xxxxx20e9301",
    "content-type":"application/json",
    "cache-control":"no-cache",
  }
};

var req =http.request(options, function(res) {
  var chunks = [];

  res.on("data", function(chunk) {
    chunks.push(chunk);
  });

  res.on("end", function() {
    var body =Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/tasks/4591040",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_POSTFIELDS =>"",
  CURLOPT_HTTPHEADER =>array(
    "authorization:046cc3f4xxxxxxxxxx7sa5xxxxxf20e9301",
    "cache-control:no-cache",
    "channel: Basic",
    "content-type:application/json",
    "x-api-key:NRMPGEB9xxxxxxxxxx7sa5xxxxxH768rxsDMlo"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Establish a call between two numbers (Agent and Customer). The first call is placed to agent number, and it is then connects with the customer. In the event where an agent misses the call, no call is placed to the customer number.
Note -

• To use the Make Call API, you need to register your SupreReceptionist number for receiving notifications from our Streaming API. On how to do this, please refer the Notifications API section on this page.
• If you are getting message that 'Agent Number not register with SR account' then check in your SR account -> settings -> plan settings, whether you have enabled 'Allowed agents Only', if yes then add the agent number there.
• caller_id field is optional.

Triggers an OTP (one-time password) voice call over the WhatsApp channel using your Voice Console / Super Receptionist configuration. Use your SR auth key and API key in the headers.

Query parameters

Headers

Sample curl

curl --request GET \
  --url "https://kpi.knowlarity.com/Basic/v1/account/otpcall?ivr_id=100xxxxxxx&k_number=%2B91xxxxxxxxxx&customer_number=%2B91xxxxxxxxxx&channel=Whatsapp&call_permission_request=true" \
  --header "x-api-key: APPLICATION_ACCESSKEY" \
  --header "Authorization: SR_API_KEY"

Sample Response (200 OK)

{
    "success": {
        "call_id": "abcd1234-5678-efgh-9012-ijklmnopqrst",
        "message": "OTP call initiated successfully",
        "status": "initiated"
    }
}

Error Response (400)

{
        "error": {
         "message": "Not allowed to send call permission request."
        }
    }
    or
    {
        "error": {
         "message": "Sent call permission request to customer. Please try calling after sometime"
        }
    }

Enable/Disable an Existing registered integration.

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/notifications"

payload = "\n{\n\"knowlarity_number\":\"+91906xxx1811\",\n\"enable\": \"enable\"\n}\n"
headers = {
    'channel': "Basic",
    'x-api-key':"mxoX4520Ih5xxxxxxxxxx7sa5xxxxx5QdC79PP",
    'authorization':"84239xxxxxxxxxx7sa5xxxxx66beb27a027",
    'content-type':"application/json",
    'cache-control':"no-cache",
    }

response =requests.request("PUT", url,data=payload, headers=headers)

print(response.text)

var http = require("https");

var options = {
  "method": "PUT",
  "hostname":"kpi.knowlarity.com",
  "port": null,
  "path":"/Basic/v1/account/notifications",
  "headers": {
    "channel": "Basic",
    "x-api-key":"mxoX4520Ih5xxxxxxxxxxx7sa5xxxxxQdC79PP",
    "authorization":"XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX",
    "content-type":"application/json",
    "cache-control":"no-cache",
  }
};

var req =http.request(options, function(res) {
  var chunks = [];

  res.on("data", function(chunk) {
    chunks.push(chunk);
  });

  res.on("end", function() {
    var body =Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ knowlarity_number:'+91906xxx41811', enable:'enable' }));
req.end();

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/notifications",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "PUT",
  CURLOPT_POSTFIELDS =>"\n{\n\"knowlarity_number\":\"+9190xxxx811\",\n\"enable\": \"enable\"\n}\n",
  CURLOPT_HTTPHEADER =>array(
    "authorization:8423xxxxxxxxxx7sa5xxxxxb27a027",
    "cache-control:no-cache",
    "channel: Basic",
    "content-type:application/json",
    "x-api-key:mxoX4520xxxxxxxxxx7sa5xxxxxQdC79PP"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Register your SuperReceptionist number to start receiving live call notifications (Streaming API) for all incoming and outgoing calls.

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/notifications"

payload = "\n{\n\"knowlarity_number\": [\n   \"+91XXXXXXXXXX\"\n ]\n}"
headers = {
    'channel': "Basic",
    'x-api-key':"mxoX452xxxxxxxxxxxxx7Jsa5xxxxx9PP",
    'authorization':"842393ddxxxxxxxxxx7Jsa5xxxxx6beb27a027",
    'content-type':"application/json",
    'cache-control':"no-cache",
    }

response =requests.request("POST", url,data=payload, headers=headers)

print(response.text)

var http = require("https");

var options = {
  "method": "POST",
  "hostname":"kpi.knowlarity.com",
  "port": null,
  "path":"/Basic/v1/account/notifications",
  "headers": {
    "channel": "Basic",
    "x-api-key":"mxoX4520Ih5xxxxxxxxxx7Jsa5xxxxxZAq67Jsa5QdC79PP",
    "authorization":"842393xxxxxxxxxx7Jsa5xxxxx9504-066beb27a027",
    "content-type":"application/json",
    "cache-control":"no-cache",
  }
};

var req =http.request(options, function(res) {
  var chunks = [];

  res.on("data", function(chunk) {
    chunks.push(chunk);
  });

  res.on("end", function() {
    var body =Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.write(JSON.stringify({ knowlarity_number: ['+9190xxxx1811' ] }));
req.end();

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/notifications",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "POST",
  CURLOPT_POSTFIELDS =>"\n{\n\"knowlarity_number\": [\n   \"+9190xxxx1811\"\n ]\n}",
  CURLOPT_HTTPHEADER =>array(
    "authorization:842393xxxxxxxxxx7Jsa5xxxxx-066beb27a027",
    "cache-control:no-cache",
    "channel: Basic",
    "content-type:application/json",
    "x-api-key:mxoX4520Ixxxxxxxxxx7sa5xxxxxjCZAq67Jsa5QdC79PP"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Summary: Receive live call notifications for your registered SuperReceptionist number. Please see event descriptions above.

Computer-Telephony Integration (CTI)

SuperReceptionist provides CTI APIs for seamlessly integrating our cloud telephony with other applications. These APIs adds a lot to the agent's ability to respond to callers efficiently. At a minimum, these telephony events can be consumed to show relevant information on the agent's workstation whenever a call is delivered to the agent via telephone. A typical CTI application manages the event flow that is generated by the telephony API during the life cycle of a call. This typically proceeds along the following sequence:

The event data is in JSON format and has the following fields.

CDR event data:

 
{ 
    "business_call_type":"Unanswered",
    "agent_number":"+91XXXXXXXXXX",
    "call_recording":null,
,   "call_type":null,
    "uuid":"40eec284206dtf6d2d0e503c9877f9",
    "customer_number":"+91XXXXXXXXXX",
    "knowlarity_number":"+91XXXXXXXXXX",
    "event_type":"ORIGINATE",
    "called":"81XXXXXXXX"
}

Call Detail Record (CDR) event is generated at the end of a call after the agent/customer hangs up. Event fields are different from the actual telephony events and they described are below.

An example of CDR data can be like:

{
   "dispnumber" :"+91XXXXXXXXXX",
   "business_call_type" :"Phone",
   "caller_id" :"+91XXXXXXXXXX",
   "Call_Type" : "Incoming",
   "start_time" :"2015-11-20 11:50:18+05:30",
   "uuid" :"129ac15d-d8b4-499e-92e1-83317d1745df",
   "call_duration" : 29,
   "destination" :"+91XXXXXXXXXX",
   "end_time" : "2015-11-2011:51:37.868542+05:30",
   "resource_url" :"http://kservices.knowlarity.com/kstorage/read?uuid=6cd3bc78-3181-4e7d-aacf-daac580601a9_0_1_r.mp3&server_ip=124.7.51.154&base_dir=recording",
   "type" : "CDR",
   "timezone_offset" :"+0530"
}

Note: Please observe that for general events keyword for type is "event_type" and for CDR it is just "type".

import requests
importsys
import traceback
while True:
    try:
        r =requests.get('https://konnect.knowlarity.com:8100/update-stream/{SR_API_KEY}/konnect',stream=True)
        printr.status_code
        if r.status_code== 200:
            print'Connection Open'
            for line inr.iter_lines():
                if line:
                    printline
        else:
            printr.status_code, r.text
            break
    exceptKeyboardInterrupt:
        sys.exit()
    except:
        traceback.format_exc()
        print 'ConnectionClosed'
        continue

URL ="https://konnect.knowlarity.com:8100/update-stream/{SR_API_KEY}/konnect"
source = newEventSource(URL);
source.onmessage = function(event) {
	var data =JSON.parse(event.data)
	console.log('Received anevent .......');
	console.log(data);
}

curl --get'https://konnect.knowlarity.com:8100/update-stream/{SR_API_KEY}/konnect'--verbose

List of SuperReceptionist number registered for notifications.

import requests
importjson

url ="https://kpi.knowlarity.com/Basic/v1/account/notifications"

payload = ""
headers = {
    'channel': "Basic",
    'x-api-key':"mxoX452xxxxxxxxxx7sa5xxxxx7Jsa5QdC79PP",
    'authorization':"XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX",
    'content-type':"application/json",
    'cache-control':"no-cache",
    }

response =requests.request("GET", url,data=payload, headers=headers)

json_data =response.json()
#print(response.text)

var http = require("https");

var options = {
  "method": "GET",
  "hostname":"kpi.knowlarity.com",
  "port": null,
  "path":"/Basic/v1/account/notifications",
  "headers": {
    "channel": "Basic",
    "x-api-key":"mxoX4520Ixxxxxxxxxx7sa5xxxxxq67Jsa5QdC79PP",
    "authorization":"XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX",
    "content-type":"application/json",
    "cache-control":"no-cache",
  }
};

var req =http.request(options, function(res) {
  var chunks = [];

  res.on("data", function(chunk) {
    chunks.push(chunk);
  });

  res.on("end", function() {
    var body =Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

$curl = curl_init();

curl_setopt_array($curl,array(
  CURLOPT_URL =>"https://kpi.knowlarity.com/Basic/v1/account/notifications",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_POSTFIELDS =>"",
  CURLOPT_HTTPHEADER =>array(
    "authorization:842393xxxxxxxxxx7sa5xxxxx66beb27a027",
    "cache-control:no-cache",
    "channel: Basic",
    "content-type:application/json",
    "x-api-key:mxoX4520xxxxxxxxxx7sa5xxxxx67Jsa5QdC79PP"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);
echo$response;
curl_close($curl);

Get Detailed Call Log API

Filters

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/call/get-detailed-call-log?uuid={}"

payload = {}
headers = {
    'authorization':"XXXXXX-XXXX-XXXX-XXXXXXXXX",
    'x-api-key':"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    'Content-Type':"application/json"
}

response =requests.request("GET", url,headers=headers, data=payload)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/call/get-detailed-call-log?uuid={}",
  "method": "GET",
  "headers": {
    "authorization":"XXXXXXX-XXXX-XXXX-XXXXXXX",
    "x-api-key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  
    "Content-Type":"application/json"  }
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/call/get-detailed-call-log?uuid={}",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_FOLLOWLOCATION =>true,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "GET",
  CURLOPT_HTTPHEADER =>array(
    "authorization:XXXXXX-XXXX-XXXX-XXXXXXXXXX",
    "x-api-key:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    "Content-Type:application/json"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}

Get Call Log Records for New UI API

Filters

import requests

url ="https://kpi.knowlarity.com/Basic/v1/account/sr/calllog"

payload = json.dumps({
    'start_time__gt': "2023-11-07 00:00:00",
    'start_time__lt': "2023-12-06 13:26:19",
    'limit': 10,
    'offset': 10,
    'customer__contains': "+9197957XXXXX",

}
headers = {
    'Authorization':"XXXXXX-XXXX-XXXX-XXXXXXXXX",
    'x-api-key':"XXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    'Content-Type':"application/json"
}

response =requests.request("POST", url,headers=headers, data=payload)

print(response.text)

var settings = {
  "async": true,
  "crossDomain": true,
  "url":"https://kpi.knowlarity.com/Basic/v1/account/sr/calllog",
  "method": "POST",
  "headers": {
    "authorization":"XXXXXXX-XXXX-XXXX-XXXXXXX",
    "x-api-key":"XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"  
    "Content-Type":"application/json"  
},
  "data": JSON.stringify({
    "start_time__gt":"2023-11-07 00:00:00",
    "start_time__lt":"2023-12-06 13:26:19"  
    "limit":10  
      'offset': 10,
    'customer__contains': "+9197957XXXXX",
}
}

$.ajax(settings).done(function(response) {
  console.log(response);
});

 "https://kpi.knowlarity.com/Basic/v1/account/sr/calllog",
  CURLOPT_RETURNTRANSFER=> true,
  CURLOPT_ENCODING =>"",
  CURLOPT_MAXREDIRS =>10,
  CURLOPT_TIMEOUT =>30,
  CURLOPT_FOLLOWLOCATION =>true,
  CURLOPT_HTTP_VERSION=> CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST=> "POST",
  CURLOPT_POSTFIELDS =>{"'{"}
    "start_time__gt:2023-11-07 00:00:00",
    "start_time__lt:2023-12-06 13:26:19"
    "limit:10"
    'offset': 10,
    'customer__contains': "+9197957XXXXX",
  {"}'"},
  CURLOPT_HTTPHEADER =>array(
    "authorization:XXXXXX-XXXX-XXXX-XXXXXXXXXX",
    "x-api-key:XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
    "Content-Type:application/json"
  ),
));

$response =curl_exec($curl);
$err =curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" .$err;
} else {
  echo $response;
}