## Получить подключение

`GET /v1/voximplant-sip/:configId`

Возвращает SIP-подключение офисной или облачной АТС по ID — например, чтобы после создания проверить регистрацию на SIP-сервере.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|----------|
| `configId` (path) | number | да | ID подключения. Список: [`GET /v1/voximplant-sip`](/docs/voximplant-sip/list) |

## Примеры

### curl — личный ключ

```bash
curl "https://vibecode.bitrix24.tech/v1/voximplant-sip/17" \
  -H "X-Api-Key: YOUR_API_KEY"
```

### curl — OAuth-приложение

```bash
curl "https://vibecode.bitrix24.tech/v1/voximplant-sip/17" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

### JavaScript — личный ключ

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-sip/17', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data } = await res.json()
if (success) {
  console.log(data.title, data.server, 'пароль задан:', data.hasPassword)
}
```

### JavaScript — OAuth-приложение

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/voximplant-sip/17', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data } = await res.json()
if (success) {
  console.log(data.title, data.server, 'пароль задан:', data.hasPassword)
}
```

## Поля ответа

Пароли в ответ не попадают — вместо них приходят признаки `hasPassword` и `hasIncomingPassword`.

| Поле | Тип | Описание |
|------|-----|----------|
| `success` | boolean | `true` при успехе |
| `data` | object | SIP-подключение. Его поля — строками `data.*` ниже |
| `data.configId` | string | ID подключения |
| `data.type` | string | Тип АТС: `office` — офисная, `cloud` — облачная |
| `data.title` | string | Название подключения |
| `data.server` | string | Адрес SIP-сервера |
| `data.login` | string | Логин на SIP-сервере |
| `data.hasPassword` | boolean | Задан ли пароль подключения |
| `data.authUser` | string \| null | Имя пользователя для авторизации на SIP-сервере. `null`, если не задано |
| `data.outboundProxy` | string \| null | Адрес прокси-сервера для исходящих вызовов. `null`, если не задан |
| `data.detectLineNumber` | string | Определять ли номер линии по SIP-заголовкам входящего вызова: `N` — не определять |
| `data.lineDetectHeaderOrder` | string | SIP-заголовки, по которым определяется номер линии, в порядке проверки, например `diversion;to` |
| `data.registrationStatusCode` | string \| null | Код результата регистрации на SIP-сервере, например `502`, когда сервер не найден |
| `data.registrationErrorMessage` | string \| null | Текст ошибки регистрации. `null`, если ошибки нет |
| `data.regId` | string | Только облачная АТС: ID регистрации на SIP-сервере |
| `data.incomingServer` | string | Только офисная АТС: адрес сервера для входящих вызовов, его выдаёт Битрикс24 |
| `data.incomingLogin` | string | Только офисная АТС: логин для входящих вызовов, его выдаёт Битрикс24 |
| `data.hasIncomingPassword` | boolean | Только офисная АТС: задан ли пароль для входящих вызовов |

## Пример ответа

```json
{
  "success": true,
  "data": {
    "type": "office",
    "configId": "17",
    "server": "sip.example.com",
    "login": "office-line",
    "hasPassword": true,
    "incomingServer": "ip.b24-1234-1234567890.bitrixphone.com",
    "incomingLogin": "sip17",
    "hasIncomingPassword": true,
    "authUser": null,
    "outboundProxy": null,
    "detectLineNumber": "N",
    "lineDetectHeaderOrder": "diversion;to",
    "registrationStatusCode": "0",
    "registrationErrorMessage": null,
    "title": "Офисная АТС"
  }
}
```

## Пример ответа при ошибке

404 — подключение не найдено:

```json
{
  "success": false,
  "error": {
    "code": "ENTITY_NOT_FOUND",
    "message": "SIP connection not found"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|----------|
| 400 | `INVALID_PARAMS` | `configId` — не целое положительное число |
| 404 | `ENTITY_NOT_FOUND` | Подключения с таким `configId` нет среди подключений, доступных ключу |
| 401 | `MISSING_API_KEY` | Не передан заголовок `X-Api-Key` |
| 401 | `INVALID_API_KEY` | Платформа не знает такой строки ключа: опечатка, обрезанное значение или удалённый ключ |
| 401 | `TOKEN_MISSING` | У ключа нет доступа к порталу: у личного ключа нет вебхука портала, ключу приложения не передан `Authorization: Bearer` с токеном сессии |
| 403 | `SCOPE_DENIED` | У ключа нет скоупа `telephony` |
| 403 | `BITRIX_ACCESS_DENIED` | Битрикс24 отказал в доступе — [разбор причин](/docs/errors/auth#bitrix_access_denied-403) |
| 422 | `BITRIX_ERROR` | Битрикс24 отклонил запрос, причина — в `error.message` |
| 429 | `RATE_LIMITED` | Превышена частота запросов |
| 429 | `QUEUE_OVERFLOW` | Очередь запросов к порталу переполнена, запрос отклонён без ожидания. Задержку подсказывает заголовок `Retry-After` |
| 429 | `QUEUE_TIMEOUT` | Запрос не дождался очереди к порталу и не был отправлен в Битрикс24. Задержку подсказывает заголовок `Retry-After` |
| 502 | `BITRIX_UNAVAILABLE` | Битрикс24 недоступен |
| 503 | `BITRIX_TIMEOUT` | Битрикс24 не ответил вовремя |

Полный список общих ошибок API — [Ошибки](/docs/errors).

## Известные особенности

- **Видны только подключения своего приложения.** Метод находит подключение, только если оно создано тем же приложением Битрикс24, что и ключ: ключ приложения — подключения своего приложения, личный ключ — подключения, созданные через вебхуки портала. На `configId` подключения другого приложения метод отвечает `404 ENTITY_NOT_FOUND`.

## Смотрите также

- [Список подключений](/docs/voximplant-sip/list)
- [Изменить подключение](/docs/voximplant-sip/update)
- [Удалить подключение](/docs/voximplant-sip/delete)
- [SIP-подключения](/docs/voximplant-sip)