Creates a CDR export schedule for one domain. At each schedule-next-run-datetime, the CDR export service collects the calls that ended between schedule-last-run-datetime and schedule-next-run-datetime, keeps the directions the export-*-calls-enabled flags select, writes a CSV, and delivers it by export-method. It then moves both times forward by schedule-repeat-interval. Requires Office Manager, Reseller, or Super User scope. Basic User, Call Center Agent, and Site Manager can create one for themselves only: the schedule is stamped with their own extension, and a user naming someone else returns 403.schedule-preset is required. Daily, Weekly, and Monthly set data-lookup-window and schedule-repeat-interval for you. Weekly needs schedule-weekly-day-of-week and schedule-start-time, Monthly needs schedule-monthly-day-of-month, and Custom needs time-zone and data-lookup-window. Send schedule-next-run-datetime in RFC 3339 (2026-09-02T09:00:00-04:00) or as YYYY-MM-DD HH:MM:SS in time-zone. It is stored in UTC, and leaving it out means now. With Daily, Weekly, or Monthly, only its date is used: the time comes from schedule-start-time, or is midnight for Monthly. The owning reseller is filled in from the domain when you leave reseller out. A reseller that does not own the domain returns 400. schedule-user-export-scope is set from your scope and cannot be sent.The schedule was published over the service bus (SBUS) and is created when each server applies it. The body is {"code": 202}. Read the schedule back to confirm it.A name already used anywhere on the platform returns 409. A missing or invalid field returns 400 naming it, including an unknown time-zone, an unparseable date, a bad schedule-start-time, a name that breaks the pattern, export-methodscp copy, and a masked-looking export-password.
Request
Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Path Params
Body Params application/jsonRequired
Examples
Responses
🟠400
application/json
A required field is missing or invalid. The message names it. Causes: no schedule-preset, a preset missing its field, an invalid schedule-name, an unknown time-zone, an unparseable schedule-next-run-datetime or schedule-start-time, export-methodscp copy, a masked-looking export-password, or a reseller that does not own domain.