v1

latestOpenAPI 3.0.32026-07-24156161.2 MB

Calls

Get all calls

The GET all calls API allows you to retrieve the calls made from the PBX. You can apply various request parameters as filters to segment and limit the number of records.

Parameters

id : Integer
object_type_id : Integer
caller_user_id : Integer
start_at : DateTime URL encoded format 2020-09-01T00:00:00
end_at : DateTime URL encoded format 2020-09-01T00:00:00
src : String
dst : String
call_uuid : String
agent_callerid_name : String
agent_callerid_number : String
agent_hangup_disposition : String
client_callerid_name : String
client_callerid_number : String
client_hangup_disposition : String
call_duration : Integer
call_bill_duration : Integer
status : String
record_file : String
created_at : DateTime URL encoded format 2020-09-01T00:00:00
q850 : String
beep_detected : Boolean
sip_term_status : String
cost : String

get/calls/

Response

Successful operation / Failed operation

total_callsnumber

Example response

{
  "calls": [
    {
      "agent_callerid_name": null,
      "agent_callerid_number": null,
      "agent_hangup_disposition": null,
      "amd_result": null,
      "amd_status": null,
      "beep_detected": "0",
      "call_bill_duration": "40",
      "call_duration": "40",
      "call_uuid": "0a12dfe6-2fb2-46ee-a914-c826f7c85945",
      "caller_user": null,
      "caller_user_id": null,
      "client_callerid_name": "380947109780",
      "client_callerid_number": "+380947109780",
      "client_hangup_disposition": "system",
      "cost": "0.2268",
      "created_at": "2023-08-24 09:47:12",
      "dst": "068213072041732",
      "end_at": "2023-08-24 09:47:12",
      "id": "97",
      "object_type_id": "4",
      "phonebook": null,
      "q850": "16",
      "record_file": null,
      "sip_term_status": "0",
      "src": "+380947109780@did.commpeak.net",
      "start_at": "2023-08-24 09:46:33",
      "status": "NORMAL_CLEARING"
    },
    {
      "agent_callerid_name": null,
      "agent_callerid_number": null,
      "agent_hangup_disposition": null,
      "amd_result": null,
      "amd_status": null,
      "beep_detected": "0",
      "call_bill_duration": "11",
      "call_duration": "11",
      "call_uuid": "e5ff5559-0e97-4993-b240-8190c92a37b3",
      "caller_user": null,
      "caller_user_id": null,
      "client_callerid_name": "447702858216",
      "client_callerid_number": "+447702858216",
      "client_hangup_disposition": "agent",
      "cost": "0.2268",
      "created_at": "2023-08-24 09:12:23",
      "dst": "068213072041732",
      "end_at": "2023-08-24 09:12:23",
      "id": "96",
      "object_type_id": "4",
      "phonebook": null,
      "q850": "16",
      "record_file": null,
      "sip_term_status": "0",
      "src": "+447702858216@did.commpeak.net",
      "start_at": "2023-08-24 09:12:13",
      "status": "NORMAL_CLEARING"
    }
  ],
  "total_calls": 2
}