[COMMAND]
Starting a Break or Busy Period for an Operator
The op_start_break
command is used to put a specific operator into a break or busy state. If the operator is currently on a call, the chosen state will be applied once that call (and associated wrap period) is over.
This command will also change the operator's state code to one of the following:
-
For break states: 14 (
Break: [Break State Description]
) -
For busy states: 11 (
Busy: [Busy State Description]
)
Parameters
operator_idrequired |
number | The unique, system-allocated ID of the intended operator. |
break_idrequired |
number | The unique, system-allocated ID of the intended break or busy state. If this is set to 0, a generic busy with message state will be applied, and you should use the busy_text parameter to elaborate. |
busy_textoptional |
string | A short message describing the circumstances of the operator's change in state. |
Example Request
Copy
{"command":{"command_type":"op_start_break", "operator_id":619, "break_id":2400}}
Responses
On Success:
If the operator is successfully put into the chosen break or busy state, an op_status
event will return details of the updated operator.