klink-developers-logo

Telephony

Get Telephony CDR

GET/api/v1/telephony-cdr

Request

Authorization

Bearer Token

Provide your API token in the Authorization header. See Authentication to issue one.

Example:Authorization: Bearer ********************

Query Params
  • selectedDatestringoptional

    Date filter applied by the service; used with x-client-timezone to interpret the date.

    Example:

  • typearray[string]optional

    Filter by call type(s). Values depend on your telephony CDR type enum (e.g., Inbound/Outbound/Internal).

    Example:

  • statusarray[string]optional

    Filter by call status(es). Values depend on your telephony CDR status enum (e.g., Answered/No Answer/Busy/Failed).

    Example:

  • callFromstringoptional

    Filters by caller. The service expands this across contact phones, queue numbers, and extensions before filtering.

    Example:

  • callTostringoptional

    Filters by callee. Also expands across contact phones, queue numbers, and extensions.

    Example:

  • trunkarray[string]optional

    Filter by trunk name(s).

    Example:

  • agentIdsarray[string]optional

    Filter by multiple agent IDs.

    Example:

  • contactIdstringoptional

    Filter CDRs by a specific contact.

    Example:

  • recordingsOnlybooleanoptional

    If true, returns only calls with recordings.

    Example:

  • pageintegeroptional

    Page index (1-based). Default 1.

    Example:

  • pageSizeintegeroptional

    Page size. Default 10. Max 200 enforced upstream.

    Example:

  • userIdstringoptional

    Filter CDRs by a specific user ID (agent).

    Example:

  • queueStatusbooleanoptional

    true if answered, or false if no-answered

    Example:

  • agentCallsOnlybooleanoptional

    If true, returns only agent-related calls.

    Example:

  • tagIdsarray[string]optional

    Filter CDRs that have any of the specified tag IDs.

    Example:

Responses

200

OK

  • requestIdstringrequired
  • dataarray[object]required
    Child attributes
    • idstringoptional
    • uniqueCallIdstringoptional
    • timeStartstringoptional
    • callFromstringoptional
    • callTostringoptional
    • callDurationintegeroptional
    • talkDurationintegeroptional
    • srcTrunkNamestringoptional
    • dstTrunkNamestringoptional
    • statusstringoptional
    • typestringoptional
    • recordingstringoptional
    • didNumberstringoptional
    • agentRingTimeintegeroptional
    • uploadIdstringoptional
    • serialNumberstringoptional
    • extensionIdstringoptional
    • telephonyQueueIdstringoptional
    • contactIdstringoptional
    • createdAtstringoptional
    • updatedAtstringoptional
    • deletedAtstringoptional
    • isQueueMissedCallbooleanoptional
    • callParticipantsstringoptional
    • wrapUpFormIdstringoptional
    • telephonyIvrIdstringoptional
    • recordingFileUrlstringoptional

      Temporary recording file URL. Expires in 1 hour.

    • extensionobjectoptional
      Child attributes
      • idstringrequired
      • userIdstringrequired
      • userobjectrequired
        Child attributes
        • idstringrequired
        • createdAtstringrequired
        • updatedAtstringrequired
        • namestringrequired
        • phonestringrequired
      • extensionIdstringrequired
      • extensionNamestringrequired
      • createdAtstringrequired
      • updatedAtstringrequired
      • deletedAtstringrequired
    • telephonyQueueobjectoptional
      Child attributes
      • idstringrequired
      • namestringrequired
      • statusstringrequired
      • ringStrategystringrequired
      • callTimeoutintegerrequired
      • companyIdstringrequired
      • wrapUpTimeintegerrequired
      • createdAtstringrequired
      • updatedAtstringrequired
      • deletedAtstringrequired
    • contactobjectoptional
      Child attributes
      • idstringrequired
      • createdAtstringrequired
      • updatedAtstringrequired
      • deletedAtstringrequired
      • namestringrequired
      • addressstringrequired
      • channelstringrequired
      • notesstringrequired
      • contactNumberintegerrequired
      • companyIdstringrequired
      • contactProfilestringrequired
      • socialProfileUrlstringrequired
    • tagsarray[object]optional
      Child attributes
      • idstringoptional
      • namestringoptional
      • colorstringoptional
  • totalintegerrequired
  • pageintegerrequired
  • pageSizeintegerrequired
  • lastPageintegerrequired