setOperatorAvailability
Returns the availability of an agent.
Input parameters
Parameter | Type | Required | Description |
---|---|---|---|
OperatorID | string id | yes | The identifier of the agent. |
ServiceTypeID | string id | yes | The identifier of the service type. See ServiceType for a list of types. |
StatusType | integer | yes* |
Built-in agent status ID. The accepted StatusTypes are the following:
|
CustomOperatorStatusID | integer | yes* |
Custom agent status ID. Use the getCustomOperatorStatuses method to get the list of available custom status IDs. An error is returned in the following cases:
|
ClientID | string id | yes | The ID of the client. Use the getOperatorClients method to get the ID. |
* Either the StatusType or CustomOperatorStatusID parameter must be provided. If both are provided, an error is returned.
Return values