Create Scheduled risk check

Creates a Scheduled risk check, returned as scheduled_report: a Caller ID Risk Check of the given phone numbers that runs daily, weekly or monthly at time in the contact center time zone. Every run is charged like a one-off check and is listed by Get Caller ID Risk Checks (GET /api/v4/numbers/risk_checks) with the report's ID in scheduled_report_id.

Phone numbers follow the rules of Create Caller ID Risk Check (POST /api/v4/numbers/risk_checks). A contact center can have at most 10 active scheduled reports created through the API; the eleventh is rejected with 422. The report is owned by an administrator of the contact center; a contact center without one cannot create reports (422).

Scheduled reports created in the contact center are not reachable through the API, and reports created through the API are not listed in the contact center.

Available only if Scheduled risk check and Caller ID Risk Check API access are enabled for the contact center. Requires an API key with the numbers.risk_checks.scheduled_reports.manage scope.

Body Params
string
required
length ≤ 100

The name of the scheduled report.

string
enum
required

How often the check runs.

Allowed:
string
required
^([01]\d|2[0-3]):[0-5]\d$

Time of day the check runs, as HH:MM in the contact center time zone.

phone_numbers
array of strings
required
length between 1 and 1000

Phone numbers to check on every run, in E.164 format with or without the leading plus sign. Spaces, dots, dashes and brackets are ignored.

phone_numbers*
Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json