This method returns the agent's availability to accept chat requests.
Available states are:
- Online: Agents can accept chat requests.
- Away: Agents cannot accept chat requests.
- Occupied: Agents can receive chats that were transferred to them.
Request
| Method | URL |
|---|---|
| GET | https://{domain}/api/account/{accountId}/agentSession/{agentSessionId}/availability?v=1&NC=true |
Request Headers
| Header | Description |
|---|---|
| Authorization Bearer {bearer-from-login} | |
| Content-Type | application/json |
| Accept | application/json |
Formats
The body media type must have one of the following formats:
- XML
- JSON
Response
Elements in the response
| Name | Description | Type/Value | Notes |
|---|---|---|---|
| chat | Displays the agent's availability to accept chats. | string | Valid values: "Online", "Away", "Occupied" |
Response Codes
| Code | Response |
|---|---|
| 200 | OK |
Response example:
{
"availability": {
"chat": "Online",
"voice": "Offline"
}
}