Call Detail Records

Sample Request

curl --request GET \
     --url https://api-smartflo.tatateleservices.com/v1/call/records \
     --header 'accept: application/json'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Query Params)

The following parameter is required to retrieve the call detail records.

Variable Name	Description	Data Type
from_date	Date from where records need to be fetched Format: Y-m-d H:i:s	String
to_date	Date till where records need to be fetched Format: Y-m-d H:i:s	String
page	Page number	String
limit	Number of records to be fetched	String
agents	Array of agents containing values in below format: agent\|id.	Array
department	Unique IDs of departments	Array
ivr	Unique IDs of IVRs	Array
call_type	Type of the call. [ c = answered, m = missed ]	String
callerid	Caller ID of the client [clients number]	String
destination	The number where incoming call is directed	String
direction	Direction of the call (inbound/outbound)	String
duration	Total duration of the call	String
operator	Mathematical operator to be used for duration filter Allowed filters: [`>`, `\<`, `>=`, `\<=`, `!=`]	String
services	Comma (,) separated services.	String
broadcast	Whether records for broadcast is to be fetched or not.	String
did_number	Number from which the call is routed from.	String

Note: Names of the agents/department/ivr/broadcast will take values in lowercase.

Sample Response

{
  "count": 406,
  "limit": 20,
  "size": 20,
  "page": 1,
  "results": [    
     {
      "id": "663c6bc92b66f80b611f8f40",
      "call_id": "1715235734.129662",
      "uuid": "48e0d4fbe3ad9",
      "direction": "inbound",
      "description": "Call answered",
      "detailed_description": null,
      "status": "answered",
      "blocked_number_id": null,
      "recording_url": "https://cloudphone.tatateleservices.com/file/recording?callId=1715235734.129662&type=rec&token=d48061c8381229980fa3dbac677add32",
      "service": "Dialer",
      "date": "2024-05-09",
      "time": "11:52:14",
      "end_stamp": "2024-05-09 11:53:02",
      "broadcast_id": null,
      "dtmf_input": null,
      "call_duration": 48,
      "answered_seconds": 31,
      "minutes_consumed": 0,
      "charges": 0,
      "department_name": null,
      "agent_number": "Extension-06047530219",
      "agent_number_with_prefix": "Extension-06047530219",
      "agent_name": "Parag Yadav",
      "client_number": "919650134255",
      "did_number": "+918069651170",
      "reason": "disconnected_by_caller",
      "hangup_cause": "Normal clearing",
      "notes": null,
      "contact_details": {
        "id": 35866918,
        "field_0": "+919650134255",
        "field_1": "parag"
      },
      "missed_agents": [],
      "call_flow": [
        {
          "type": "init",
          "value": "1715235734.129662",
          "time": 1715235734.438,
          "readableTime": "09-05-2024 11:52:14"
        },
        {
          "app_data": "test parag dialer",
          "app_id": "53273",
          "app_name": "Dialer Campaign",
          "dept_dialst": "Answered",
          "id": "10060",
          "name": "AHMM",
          "ringst": 1,
          "time": 1715235734.438,
          "type": "Inbound Queue",
          "readableTime": "09-05-2024 11:52:14"
        },
        {
          "type": "Customer",
          "dialst": "Answered",
          "time": 1715235734.541,
          "readableTime": "09-05-2024 11:52:14"
        },
        {
          "type": "Agent",
          "id": "05047530422",
          "name": "Parag Yadav",
          "num": "Extension-06047530219",
          "dialst": "Dialed",
          "app_id": 53273,
          "time": 1715235747.393,
          "readableTime": "09-05-2024 11:52:27"
        },
        {
          "type": "Agent",
          "id": "05047530422",
          "name": "Parag Yadav",
          "num": "Extension-06047530219",
          "dialst": "Answered",
          "app_id": 53273,
          "time": 1715235751.901,
          "readableTime": "09-05-2024 11:52:31"
        },
        {
          "type": "Agent-Hangup",
          "id": "05047530422",
          "name": "Parag Yadav",
          "time": 1715235782.812,
          "readableTime": "09-05-2024 11:53:02"
        },
        {
          "type": "Hangup",
          "time": 1715235782.812,
          "readableTime": "09-05-2024 11:53:02"
        }
      ],
      "accountid": "Shrish.test",
      "agent_ring_time": "N.A.",
      "circle": {
        "operator": "Airtel India",
        "circle": "Delhi"
      },
      "agent_hangup_data": [
        {
          "id": "05047530422",
          "name": "Parag Yadav(Extension-06047530219)",
          "timegroup_id": null,
          "timegroup_name": null,
          "disposition": "ANSWERED",
          "time": 1715235747.393,
          "readableTime": "09-05-2024 11:52:27"
        }
      ],
      "transfer_missed_agent": [],
      "call_hint": "dialer",
      "support_api_call": false,
      "lead_id": "62415995212bae083f1e4592",
      "is_incoming_from_broadcast": false,
      "caller_id_num": "+919650134255",
      "sip_agent_ids": null,
      "dialer_call_details": {
        "customer_ring_time": 0,
        "call_wait_time": 18,
        "agent_talk_time": 30,
        "total_hold_duration": null,
        "hold_count": null,
        "disposition_id": null,
        "total_call_duration": 48,
        "disposition_name": "Undisposed",
        "disposition_code": "UNDIS",
        "hangup_cause": 16,
        "sub_disposition_id": null,
        "sub_disposition_name": null,
        "sub_disposition_code": null,
        "call_type": "inbound",
        "dialin_enabled": null,
        "dialout_enabled": true,
        "campaign_id": 53273,
        "campaign_name": "test parag dialer",
        "list_id": "149897",
        "list_name": "test parag",
        "extension_dialer": true,
        "dialer_queue_details": [
          {
            "queue_details": {
              "app_data": "test parag dialer",
              "app_id": "53273",
              "app_name": "Dialer Campaign",
              "dept_dialst": "Answered",
              "id": "10060",
              "name": "AHMM",
              "ringst": 1,
              "time": 1715235734.438,
              "type": "Inbound Queue",
              "readableTime": "09-05-2024 11:52:14"
            },
            "missed_by": [],
            "answered_by": {
              "type": "Agent",
              "id": "05047530422",
              "name": "Parag Yadav",
              "num": "Extension-06047530219",
              "dialst": "Answered",
              "app_id": 53273,
              "time": 1715235751.901,
              "readableTime": "09-05-2024 11:52:31"
            }
          }
        ],
        "dialer_queue_transfer_details": [],
        "inbound_queue": "AHMM",
        "is_short_call": "No",
        "sla_status": "Call answered outside SLA",
        "feedback_rating": null,
        "feedback_recording_type": null,
        "disposition_duration": 0,
        "first_call_resolution": "No",
        "agent_call_duration": "Parag Yadav: 31",
        "agents_call_details": {
          "05047530422": {
            "hold_duration": 0,
            "hold_count": 0
          }
        }
      },
      "custom_status": null,
      "voicemail_recording": false,
      "aws_call_recording_identifier": "4a2085b89941a442783d7d79414ac3bd"
    },.......
  ]
}

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
count	Number of records that are fetched.	Integer
limit	Number of records to be fetched.	Integer
size		Integer
page	Index of the page.	Integer
results[].id	Unique ID of the record.	String
results[].call_id	The unique ID of the call that allows customers to fetch call related details. For example,1627373566.350603.	String
results[].uuid	The call ID of the number that helps to track the different triggers for a particular call. For example, 61111f5e708c5.	String
results[].direction	The direction of the call. The possible values are: Inbound Outbound	String
results[].description	Description of the call detail record.	String
results[].detailed_description	Detailed description of the call detail record.	String
results[].status	The status of the call response. For example, missed	String
results[].blocked_number_id	Unique ID of the blocked number.	String
results[].recording_url	The URL of the recorded call.	String
results[].service	The type of call services. For example, Click to Call. Note: These are separated by commas.	String
results[].date	The date on which the call was made. For example, the format is YYYY-MM-DD (2021-03-10).	String
results[].time	The time on which the call was made. For example, the format is hh:mm:ss, (17:16:18).	String
results[].end_stamp	The time_stamp on which the call was made. For example, the format is YYYY-MM-DD hh:mm:ss, (2021-03-10 17:16:18).	String
results[].broadcast_id	The ID of the braodcast call. For example: 3432.	String
results[].dtmf_input	The number pressed by the customer on hearing the IVR. For example: 3432.	String
results[].call_duration	The total duration of the call. For example, 30.	Integer
results[].answered_seconds	The total duration of the call in seconds after getting answered. For example, 90.	Integer
results[].minutes_consumed	The time in minutes consumed in the call. For example, 2.	Integer
results[].charges	charged at applied to the call.
results[].department_name	Name of the department.	String
results[].agent_number	Number of the agent.	String
results[].agent_number_with_prefix	Number of the agent with prefix.	String
results[].agent_name	Name of the agent.	String
results[].client_number	Number of the client to whom the call was connected.	String
results[].did_number	The DID from which the agent makes or receives the call. For example, 918069010149.	String
results[].reason	Hangup reason. (Used internally)	String
results[].hangup_cause	Cause for hanging up the call.	String
results[].notes	Call note added to the call.	Object
results[].contact_details	The contact number and name of the client. For example, 91XXXXXXXXX.	Object
results[].missed_agents	The details of the agents who missed the call.	Array
results[].call_flow	Complete call flow of the call, details can vary depending upon the type of call.	Array
results[].account_id	Client ID of the user.	String
results[].agent_ring_time	Time duration for which the call was ringed for the agent.	String
results[].circle.operator	Operator of the circle.	String
results[].circle.circle	State of the circle.	String
results[].agent_hangup_data	All details of the call after being disposed.	String
results[].transfer_missed_agent	Whether the transferred agent missed the call or not.	Array
results[].call_hint	Type of the call. For example: C2C, dialer, etc.	String
results[].support_api_call	Whether the support API is called or not.	Boolean
results[].lead_id	Unique ID of the lead.	String
results[].is_incoming_from_broadcast	Whether the call is an incoming on broadcast.	Boolean
results[].caller_id_num	Caller ID number of the call.	String
results[].dialer_call_details	Call details in case the type of the call is dialer.	Object
results[].voicemail_recording	Whether the call is on voicemail or not.	Boolean
results[].aws_call_recording_identifier	Unique identifier when the call is uploaded on AWS.	String