Reports API Version 2 PBX triggers
Introduction
These reports display PBX trigger data about your Installation.
Operator Availability
List pbxUserState triggers revealing operator availability.
Request:
GET /reports/v2/igrps/{IGRP SPECIFIER}/pbxUserStateTriggers
URL Path Params
- IGRP SPECIFIER (int) - Installation ID.
GET Params
- startDate (string) OPTIONAL - Start Date to filter by, see Dates and Timezones.
- endDate (string) OPTIONAL - End Date to filter by, see Dates and Timezones.
- tz (string) OPTIONAL - Timezone to convert to, see Dates and Timezones.
- filter (array) OPTIONAL - One or more filters, see Filter Types.
- sort (array) - One or more sorts, see Sort Types.
- limit (int) - Limit result set, see Pagination.
- offset (int) OPTIONAL - Offset result set, see Pagination.
Filter Types
- triggerDatetime (datetime) - The trigger datetime
- operatorRef (string) - The operatorRef
- operatorState (string) - The operatorState (online/offline/dnd)
- operatorStateDuration (int) - The duration the operator was in this state
Sort Types
Same fields as Filter Types, see above.
Response:
A list of operator states and the duration the operator was in this state.