Call reports

List call reports

GEThttp://127.0.0.1:8888/api/call_reports

Query parameters

Response

Body

countinteger (int64)

Total number of resource.

Example: 100

itemsarray of object

Request

const response = await fetch('http://127.0.0.1:8888/api/call_reports', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "count": 100,
  "items": [
    {
      "id": {},
      "name": "text",
      "type": "NORMAL",
      "cron_expr": "text",
      "status": "RUNNING"
    }
  ]
}

Create new call report

POSThttp://127.0.0.1:8888/api/call_reports

Body

name*string

The name of call report.

type*enum

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:

NORMALEXTENSION_GROUP_CALL_COSTQUEUE_PERFORMANCEQUEUE_DETAILED_STATISTICSQUEUE_ABANDONED_CALLSQUEUE_SLA_STATISTICSQUEUE_BREACHES_SLA_STATISTICSQUEUE_CALLBACKSQUEUE_FAILED_CALLBACKSTEAM_QUEUE_GENERAL_STATISTICSRING_GROUP_STATISTICS

email*all of

The email address to which the report file will be sent after the report is complete.

format*enum

The report output files format can be either:

CSV:
HTML:

CSVHTML

range*enum

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.

TODAYYESTERDAYLAST_WEEKLAST_SEVEN_DAYSLAST_MONTHLAST_THIRTY_DAYSCUSTOM

started_atall of

Filter data after specified data time.
Only valid when the range is specified as CUSTOM

ended_atall of

Filter data before specified data time.
Only valid when the range is specified as CUSTOM

cron_exprstring

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

filter*one of

Response

Created

Body

idall of

The unique ID of this call report.

Request

const response = await fetch('http://127.0.0.1:8888/api/call_reports', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "text",
      "type": "NORMAL",
      "email": {},
      "format": "CSV",
      "range": "TODAY",
      "filter": {}
    }),
});
const data = await response.json();

Response

{
  "id": {}
}

Get call report details

Get details of call report by it's unique ID.

GEThttp://127.0.0.1:8888/api/call_reports/{id}

Path parameters

id*all of

The unique ID of this call report.

Response

Body

idall of

The unique ID of this call report.

namestring

The name of call report.

typeenum

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:

emailall of

The email address to which the report file will be sent after the report is complete.

formatenum

The report output files format can be either:

CSV:
HTML:

CSVHTML

rangeenum

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.

TODAYYESTERDAYLAST_WEEKLAST_SEVEN_DAYSLAST_MONTHLAST_THIRTY_DAYSCUSTOM

started_atall of

Filter data after specified data time.
Only valid when the range is specified as CUSTOM

ended_atall of

Filter data before specified data time.
Only valid when the range is specified as CUSTOM

cron_exprstring

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

filterone of

statusenum

The report status can be either:

RUNNING:
SCHEDULED:
ABORTED:

RUNNINGSCHEDULEDABORTED

Request

const response = await fetch('http://127.0.0.1:8888/api/call_reports/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "id": {},
  "name": "text",
  "type": "NORMAL",
  "email": {},
  "format": "CSV",
  "range": "TODAY",
  "started_at": {},
  "ended_at": {},
  "cron_expr": "text",
  "filter": {
    "from": "ANY",
    "from_value": "text",
    "to": "ANY",
    "to_value": "text",
    "answer_state": "ANY",
    "duration": "ANY"
  },
  "status": "RUNNING"
}

Update call report

Update call report properties.

POSThttp://127.0.0.1:8888/api/call_reports/{id}

Path parameters

id*all of

The unique ID of this call report.

Body

namestring

The name of call report.

emailall of

The email address to which the report file will be sent after the report is complete.

formatenum

The report output files format can be either:

CSV:
HTML:

CSVHTML

rangeenum

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.

TODAYYESTERDAYLAST_WEEKLAST_SEVEN_DAYSLAST_MONTHLAST_THIRTY_DAYSCUSTOM

started_atall of

Filter data after specified data time.
Only valid when the range is specified as CUSTOM

ended_atall of

Filter data before specified data time.
Only valid when the range is specified as CUSTOM

cron_exprstring

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

filterone of

Response

Request

const response = await fetch('http://127.0.0.1:8888/api/call_reports/{id}', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

PreviousCdrs NextDestroy

const response = await fetch('http://127.0.0.1:8888/api/call_reports', { method: 'POST', headers: { "Content-Type": "application/json" }, body: JSON.stringify({ "name": "text", "type": "NORMAL", "email": {}, "format": "CSV", "range": "TODAY", "filter": {} }), }); const data = await response.json();

{ "id": {}, "name": "text", "type": "NORMAL", "email": {}, "format": "CSV", "range": "TODAY", "started_at": {}, "ended_at": {}, "cron_expr": "text", "filter": { "from": "ANY", "from_value": "text", "to": "ANY", "to_value": "text", "answer_state": "ANY", "duration": "ANY" }, "status": "RUNNING" }