Skip to main content
Version: v8.2

Get operation times report

GET

/org/{tenant}/v2/reports/operation-times

Platform support: MT and CC

Returns a list of resources that have operation times rules configured, together with the effective operation times of each resource.

Two things exclude a resource. Operation times being explicitly turned off excludes any resource; for extensions that means the Operation Times enhanced service being switched off. In addition, a DID that is itself disabled is excluded from a tenant-scoped request unless the master server is running in groups DID mode.

Exactly one operation times field is set per item. Extensions are reported through extension_operation_times because they keep their rules in the enhanced service schema. Every other resource type is reported through operation_times.

A DID covering a range of numbers also carries number_range_end, so the range can be rendered as number - number_range_end.

type is required and selects the resource kind; a request without it is rejected rather than defaulting, so a misspelled parameter name cannot silently return a different resource. query searches within the selected kind, and the searched fields depend on it:

  • did — DID number, range end, destination extension, name, route, tenant code, server name, city and area code
  • ivr, queue — name, extension number, email, autoprovisioning MAC address, and account ID when the SNet customisation is enabled
  • extension — name, extension number, email and autoprovisioning MAC address
  • erg, dial_group — name and extension number prefix

Searches match on a prefix, with two exceptions. The resource name matches anywhere in the value for did, extension, ivr and queue; for erg and dial_group it is prefix matched like everything else. Account ID is matched exactly rather than as a prefix.

For did only, a term consisting entirely of digits has a single leading zero removed before matching, and the shortened term is what every DID field is compared against. A DID whose number is zero filled therefore has to be searched by its stored number rather than by the padded value this endpoint renders.

When a page is requested, size defaults to 10 and is then capped by both the number of matching rows and the record limit configured on the tenant server, a page beyond the last one falls back to the first page, and the page actually served is reported back in pagination.

limit and offset are accepted as an alternative to size and page. A limit above 0 replaces size and derives the page as offset / limit + 1, so a page sent alongside limit is ignored.

Request​

Responses​

Operation times report retrieved successfully