---
title: "Agent status"
slug: "agent-status"
updated: 2024-10-25T14:59:05Z
published: 2024-10-25T14:59:05Z
canonical: "docs.voiso.com/agent-status"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.voiso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Agent status

The **Agent Status** API is part of Voiso's Agent Application APIs. Use it to obtain the email address, extension, and current availability status of every agent in the contact center. The API endpoint description is [here](/v1-api/apidocs/agents-status).

## Prerequisites

- You must have access to your [Contact Center API key](/v1-api/apidocs/authentication).
- You must have at least one [user](https://docs.voiso.com/docs/users-users) for your contact center.

## Making requests

The **Agent Status** API requires the [base URL](/v1-api/apidocs/base-endpoint) (cluster_id) and the The [Contact Center API key](/v1-api/apidocs/authentication) (client_api_key). It uses the following parameters to initiate a call:

The contact center API key. Voiso responds with a list of all agents and their current availability status.

For example:

```
https://cluster1.voiso.com/api/v1/cc7c76b8b...b80ab6c3/agents_status
```

## Response

The response contains an array of information about each user, including their sign-in email address, phone extension, and current status.

The following table describes the elements of the response.

| Element | Description | Type | Notes |
| --- | --- | --- | --- |
| email | The user's sign-in email address. | string |  |
| ext | The user's phone extension. | string |  |
| status | The user's current availability status. | string | Valid values are: Available, Idle, Logout, Outbound, Inbound, Dialer waiting, and Unavailable with one of the [unavailable codes defined for your contact center](https://docs.voiso.com/docs/administration-unavailable-codes). |

### Response sample

```
[
  {
    "email": "pt@fg.com",
    "ext": "7777",
    "status": "available"
  },
  {
    "email": "px@fg.com",
    "ext": "5555",
    "status": "unavailable"
  }
]
```

## Troubleshooting

The following issues are sometimes encountered:

### Invalid key

The **Agent Status** API requires the contact center API key to validate the request. If you see this error, `"error": "Invalid key"`, check that you are using the correct contact center API key. For more information about API keys, refer to [Authentication](/v1-api/apidocs/authentication).