Place Outbound Call

API Endpoint

POST https://kpi.knowlarity.com/Basic/v1/account/call/campaign

Required Parameters

ParameterDescription
sound_idString
phonebookString
additional_numberString
k_numberString

Optional Parameters

priorityHigher the number higher the weightage
order_throttlingDefault - 500
retry_durationInteger value (lower limit 1, upper limit not defined)
start_timeAhead of current time
end_time+ 15 mins start time
max_retryInt
call_schedulingString
call_scheduling_start_timeString
call_scheduling_stop_timeString
is_transactionalString

Sample Request

curl -X POST \
  https://kpi.knowlarity.com/Basic/v1/account/call/campaign \
  -H 'accept: application/json' \
  -H 'authorization: <authorization-key>' \
  -H 'x-api-key: <x-api-key>'
  -H 'content-type: application/json' \
  -d '{
  "sound_id": "368576",
  "phonebook": "879476",
  "timezone": "Asia/Kolkata",
  "priority": "1",
  "order_throttling": "10",
  "retry_duration": "15",
  "start_time": "2022-06-03 18:23",
  "end_time": "2022-07-04 18:46",
  "max_retry": "1",
  "call_scheduling": "[1, 1, 1, 1, 1, 0, 0]",
  "call_scheduling_start_time": "09:00",
  "call_scheduling_stop_time": "21:00",
  "k_number": "+9176693XXXXX",
  "additional_number":"+9190396XXXXX",
  "is_transactional": "False"
}'

Sample Response

{
    "order_id": 51452625,
    "result": "placed order successfully",
    "status_code": 1
}

Get outbound call status

API Endpoint

GET  https://kpi.knowlarity.com/Basic/v1/account/call/campaign/order-status/?order_id={order_id}

Sample Request

curl --location --request GET \
  'https://kpi.knowlarity.com/Basic/v1/account/call/campaign/order-status/?order_id=<order_id>' \
  --header 'Content-Type: application/json' \
  --header 'Accept: application/json' \
  --header 'Authorization: <authorization-key>' \
  --header 'x-api-key: <x-api-key>'

Sample Response

{
    "result": {
        "answered_calls": 0,
        "call_start_time": "9:00",
        "call_stop_time": "21:00",
        "calling_days": "Monday Tuesday Wednesday Thursday Friday Saturday Sunday ",
        "failed_calls": 0,
        "finished_calls": 115,
        "inprocess_calls": 1,
        "is_lifo": false,
        "order_number": 50938308,
        "order_state": "Completed",
        "pending_calls": 1,
        "priority": 5,
        "retry_calls": 0,
        "start_time": "20-05-2022 10:35",
        "stop_time": "20-05-2022 10:54",
        "successful_calls": 115,
        "total_calls": 163,
        "total_mous": 0,
        "total_pulses": 0
    },
    "status_code": 1
}