POportsip
CDR

Update call report

Update call report properties.

post/call_reports/{id}

Request

Path parameters

idstring required

The unique ID of the resource.

Example:NzAwNTUxOTA5NzczMTQ4MTYw

The unique ID of the call report.

Request body

namestring

The name of call report.

emailstring

The email address.

format'CSV' | 'HTML'

The report output files format can be either:

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

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

OK

Changes

No recorded changes to this operation across all 1 revision of this API.