[EVENT]
Fetched Operator State
The op_status
event contains information about the current state of an operator. It is returned under a number of circumstances, such as when a command is used to change the state of an operator or a call.
Examples of commands that can return op_status...
Operator-specific:
- Logging In an Operator
- Extending the Wrap Period for an Operator
- Restarting the Wrap Period for an Operator
- Ending the Wrap Period for an Operator
- Starting a Break or Busy Period for an Operator
- Ending a Break or Busy Period for an Operator
- Logging Out an Operator
- Changing the Phone Number of an Operator
List of potential operator state codes...
Code | State | Description |
---|---|---|
1 | opStateIdle | The operator is logged in and waiting for a call. |
2 | opStateRinging | The operator has an inbound call assigned to them. |
4 | opStateInCall | The operator is currently participating in an inbound call. |
5 | opStateWrapup | The operator is in the standard wrap-up period following the end of a call. |
11 | opStateBusyWithMessage |
The operator is currently in a busy state. |
13 | opStateExtendedWrapup | The operator is in a wrap-up period following a call, but that period has been either restarted or extended. |
14 | opStateBreak |
The operator is currently on a break. |
201 | opStateOutboundRinging | The operator has been assigned to an outbound dialler call, which is now ringing. |
400 | opStateInOutboundCall | The operator is currently on an outbound call with the call's target. |
Parameters
operator_id | number | The unique, system-defined ID of the operator. |
customer_id | number | The unique, system-defined ID of the customer associated with the operator. |
name | string | The operator's name. |
string | The operator's e-mail address. | |
login_state | Boolean | Whether or not the operator is currently logged in. |
op_state_code | number | A code representing the current state of the operator. |
op_state_desc | string | A short description of the state linked to op_state_code . |
target | string | The phone number of the operator. If they are a VoIP operator, this number will be 3333 followed by their operator_id . |
ring_time | number | The ring time, in seconds, allocated to the operator. |
wrap_time | number | The wrap time, in seconds, allocated to the operator. |
break_id | number | If the operator is on a break, this will show the unique, system-defined ID of the break or busy state currently assigned to them. |
break_name | string | A short description of the break or busy state linked to break_id , if one is applied. |
Example Response
Copy
{"event":{"event_type":"op_status","operator_ID":76085,"customer_ID":607,"name":"Luigi Pomodoro","email":"","login_state":1,"op_state_code":1,"op_state_desc":"Waiting","target":"0132 5460897","ring_time":30,"wrap_time":250,"break_id":0,"break_name":""}}