setAgentState()
Sets an agent’s Chat status, such as Online, Away, or Offline. Available in API version 29.0 or later.
| Name | Type | Description |
|---|---|---|
state | String | Chat status you want to set the agent to—for example, Online, Away, or Offline. |
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 |
|---|---|---|
success | Boolean | true if setting the agent’s Chat status was successful; false if setting the agent’s Chat status wasn’t successful. |