login
Logs an agent into Omni-Channel with a specific presence status. You also can use this method to reconnect to Omni-Channel after a connection error. Available in API versions 32.0 and later.
| Name | Type | Description |
|---|---|---|
statusId | String | The ID of the presence status. Agents must be given access to this presence status through their associated profile or permission set. |
callback | function | JavaScript method to call when the agent is logged in with the presence status associated with statusId. |
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 the login was successful; false if the login wasn’t successful. |