Sign in
latestOpenAPI 3.1.0PortSIP2026-08-105581112.6 MB

577415d4a3d5

CDR

Create new call report

post/call_reports

Request body

namestring required

The name of call report.

type'NORMAL' | 'EXTENSION_GROUP_CALL_COST' | 'QUEUE_PERFORMANCE' | 'QUEUE_DETAILED_STATISTICS' | 'QUEUE_ABANDONED_CALLS' | 'QUEUE_SLA_STATISTICS' | 'QUEUE_BREACHES_SLA_STATISTICS' | 'QUEUE_CALLBACKS' | 'QUEUE_FAILED_CALLBACKS' | 'TEAM_QUEUE_GENERAL_STATISTICS' | 'RING_GROUP_STATISTICS' required

The report types can be either:

  • NORMAL:
  • EXTENSION_GROUP_CALL_COST:
  • QUEUE_PERFORMANCE:
  • QUEUE_DETAILED_STATISTICS:
  • QUEUE_ABANDONED_CALLS:
  • QUEUE_SLA_STATISTICS:
  • QUEUE_BREACHES_SLA_STATISTICS:
  • QUEUE_CALLBACKS:
  • QUEUE_FAILED_CALLBACKS:
  • TEAM_QUEUE_GENERAL_STATISTICS:
  • RING_GROUP_STATISTICS:
emailstring required

The email address.

format'CSV' | 'HTML' required

The report output files format can be either:

  • CSV:
  • HTML:
range'TODAY' | 'YESTERDAY' | 'LAST_WEEK' | 'LAST_SEVEN_DAYS' | 'LAST_MONTH' | 'LAST_THIRTY_DAYS' | 'CUSTOM' required

The report range can be either:

  • TODAY: the day the report was generated.
  • YESTERDAY: yesterday of the day the report was generated.
  • LAST_WEEK: the last week of the day the report was generated.
  • LAST_SEVEN_DAYS: seven days before the day the report was generated.
  • LAST_MONTH: the last month of the day the report was generated.
  • LAST_THIRTY_DAYS: thirty days before the day the report was generated.
  • CUSTOM: custom date range.
started_atstring date_time

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

ended_atstring date_time

The RFC 3339 format is defined by The date_time notation as defined by RFC 3339, section 5.6, for example, 2017-07-21T17:32:28Z

cron_exprstring

The crontab expression https://en.wikipedia.org/wiki/Cron

Example request

{
  "email": "example@example.com",
  "started_at": "2017-07-21T17:32:28Z",
  "ended_at": "2017-07-21T17:32:28Z"
}

Response

Created

idstring

The unique ID of the resource.

Example response

{
  "id": "NzAwNTUxOTA5NzczMTQ4MTYw"
}