getAgentState()
Returns the agent’s current Chat status, such as Online, Away, or Offline. Available in API version 29.0 or later.
| Name | Type | Description |
|---|---|---|
callback | function | JavaScript method called upon completion of the method. |
This method is asynchronous so it returns its response in an object in a callback method. The response object contains the following properties:
| Name | Type | Description |
|---|---|---|
state | String | String representing the current agent state—for example, Online, Away, or Offline. |
success | Boolean | true if getting the agent’s Chat status was successful; false if getting the agent’s Chat status wasn’t successful. |