# Employee telephony settings

`GET /v1/telephony-users`

Returns employee telephony settings: the default outbound line, SIP phone status, the server address and login for connecting the SIP phone, and the extension number. The SIP password is never returned. The `hasPassword` flag is returned instead.

Scope: `telephony`. Works only with an OAuth application key `vibe_app_…` and a user session token. Bitrix24 checks permission to read the settings and may require administrator approval.

## Parameters

| Parameter | Type | Req. | Description |
|---|---|---|---|
| `userIds` (query) | string | yes | Comma-separated positive employee IDs. List: [`GET /v1/users`](/docs/entities/users/list) |

## Examples

A personal key `vibe_api_…` receives `403 OAUTH_REQUIRED`. Use an OAuth application key `vibe_app_…`.

### curl — OAuth application

```bash
curl -X GET 'https://vibecode.bitrix24.com/v1/telephony-users?userIds=42,43' \
  -H 'X-Api-Key: YOUR_APP_KEY' \
  -H 'Authorization: Bearer USER_SESSION_TOKEN'
```

### JavaScript — OAuth application

```javascript
const res = await fetch('https://vibecode.bitrix24.com/v1/telephony-users?userIds=42,43', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { data } = await res.json()
console.log(data)
```

## Response fields

| Field | Type | Description |
|---|---|---|
| `success` | boolean | Always `true` on success |
| `data` | array | Telephony settings for each employee found |
| `data[].id` | string | Employee ID |
| `data[].defaultLine` | string | Default outbound line |
| `data[].phoneEnabled` | string | Whether the SIP phone is activated: `Y` — yes, `N` — no |
| `data[].sipServer` | string | Server address for connecting the SIP phone |
| `data[].sipLogin` | string | Login for connecting the SIP phone |
| `data[].hasPassword` | boolean | Whether a SIP password is set. The password itself is not returned |
| `data[].innerNumber` | string | Employee extension number |

## Response example

```json
{
  "success": true,
  "data": [
    {
      "id": "77",
      "hasPassword": true,
      "innerNumber": "177"
    }
  ]
}
```

## Error response example

403 — request with a personal key:

```json
{
  "success": false,
  "error": {
    "code": "OAUTH_REQUIRED",
    "message": "This endpoint requires an OAuth application key; webhook keys have no application context."
  }
}
```

## Errors

| HTTP | Code | Description |
|---|---|---|
| 400 | `MISSING_REQUIRED_FIELDS` | `userIds` is missing or contains a value that is not a positive integer |
| 403 | `OAUTH_REQUIRED` | Request with a personal key `vibe_api_…`. An OAuth application key is required |
| 403 | `SCOPE_DENIED` | The key lacks the `telephony` scope |
| 403 | `BITRIX_ACCESS_DENIED` | Bitrix24 denied access to the telephony settings |
| 401 | `MISSING_API_KEY` | `X-Api-Key` was not passed |
| 401 | `INVALID_API_KEY` | The key was not found or has been revoked |
| 401 | `TOKEN_MISSING` | The key has no connection to Bitrix24 |
| 422 | `BITRIX_ERROR` | Bitrix24 rejected the request. The reason is in `message` |
| 429 | `RATE_LIMITED` | Request limit exceeded |
| 502 | `BITRIX_UNAVAILABLE` | Bitrix24 is unavailable or returned an invalid response |
| 503 | `BITRIX_TIMEOUT` | Bitrix24 did not respond in time |

Full list of common API errors — [Errors](/docs/errors).

## See also

- [Calls](/docs/calls)
- [SIP connections](/docs/voximplant-sip)
- [Employees](/docs/entities/users)