## Получить ссылку по коду

`GET /v1/chats/sharing-links/:code`

Возвращает ссылку по её коду — ссылку на чат или гостевую ссылку. Нужен, чтобы по коду из адреса узнать, в какой чат ведёт ссылка и какого она вида.

## Параметры

| Параметр | Тип | Обяз. | Описание |
|----------|-----|:-----:|---------|
| `code` (path) | string | да | Код ссылки — поле `code` объекта ссылки или параметр `IM_CODE` её адреса. От 1 до 64 печатных символов без пробелов |

Параметры запроса не принимаются и отклоняются с `400 INVALID_PARAMS`.

## Примеры

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

```bash
curl "https://vibecode.bitrix24.tech/v1/chats/sharing-links/Xk9pQ2mZ7rT4vB1c" \
  -H "X-Api-Key: YOUR_API_KEY"
```

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

```bash
curl "https://vibecode.bitrix24.tech/v1/chats/sharing-links/Xk9pQ2mZ7rT4vB1c" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"
```

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

```javascript
const res = await fetch('https://vibecode.bitrix24.tech/v1/chats/sharing-links/Xk9pQ2mZ7rT4vB1c', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})

const { data } = await res.json()
console.log('Чат:', data.sharingLink.entityId, 'вид:', data.sharingLink.type)
```

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

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

const { data } = await res.json()
console.log('Чат:', data.sharingLink.entityId, 'вид:', data.sharingLink.type)
```

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

| Поле | Тип | Описание |
|------|-----|---------|
| `success` | boolean | Всегда `true` при успехе |
| `data.sharingLink.id` | number | ID ссылки |
| `data.sharingLink.entityType` | string | `chat` — ссылка на чат, `guest_chat` — гостевая ссылка |
| `data.sharingLink.entityId` | string | ID чата без префикса `chat` |
| `data.sharingLink.code` | string | Код ссылки |
| `data.sharingLink.type` | string | `primary` — основная, `individual` — личная, `custom` — персональное гостевое приглашение |
| `data.sharingLink.dateCreate` | string | Дата создания, ISO 8601 |
| `data.sharingLink.dateExpire` | string \| null | Срок действия. `null` — без срока |
| `data.sharingLink.requireApproval` | boolean | Требуется ли одобрение вступления |
| `data.sharingLink.url` | string | Адрес ссылки |
| `data.sharingLink.name` | string \| null | Только у гостевой ссылки. У приглашения по почте или SMS — адрес или номер, на который оно ушло, у личной гостевой ссылки — `null` |

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

```json
{
  "success": true,
  "data": {
    "sharingLink": {
      "id": 1012,
      "entityId": "42",
      "entityType": "chat",
      "code": "Xk9pQ2mZ7rT4vB1c",
      "type": "individual",
      "dateCreate": "2026-09-24T23:02:28+00:00",
      "dateExpire": null,
      "requireApproval": false,
      "url": "https://portal.bitrix24.ru/online/?IM_CODE=Xk9pQ2mZ7rT4vB1c"
    }
  }
}
```

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

422 — ссылки с таким кодом нет:

```json
{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "SHARING_LINK_NOT_FOUND",
    "b24Code": "SHARING_LINK_NOT_FOUND"
  }
}
```

## Ошибки

| HTTP | Код | Описание |
|------|-----|---------|
| 400 | `INVALID_PARAMS` | `code` не похож на код ссылки или передан параметр запроса. Проверяется до обращения к Битрикс24 |
| 422 | `BITRIX_ERROR` | Битрикс24 вернул ошибку, код портала — в `error.b24Code`. `SHARING_LINK_NOT_FOUND` — ссылки с таким кодом нет |
| 404 | `ENTITY_NOT_FOUND` | Битрикс24 ответил кодом «не найдено» без уточнения, код портала — в `error.b24Code` |
| 403 | `SCOPE_DENIED` | API-ключ не имеет скоупа `im` |
| 401 | `TOKEN_MISSING` | API-ключ не имеет настроенных токенов Битрикс24 |

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

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

**Отозванная ссылка читается так же, как действующая.** Признака отзыва в ответе нет: отозванную ссылку отличает только то, что [вступление по коду](/docs/chats/sharing/join) по ней отклоняется с `SHARING_LINK_REVOKED` в `error.b24Code`.

**Чтение доступно без участия в чате.** Вызов не принимает чат и не делает вас его участником, поэтому ключ только для чтения его выполняет. Права на чат при чтении не проверяются: ссылку прочтёт любой пользователь портала, который знает код.

**Гостевое приглашение раскрывает адрес.** У персонального приглашения по почте или SMS поле `name` содержит адрес или номер человека вне портала — пересылайте ответ только тем, кому можно видеть этот контакт.

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

- [Вступить в чат по коду](/docs/chats/sharing/join)
- [Отозвать ссылку по коду](/docs/chats/sharing/link-revoke)
- [Ссылки и гости](/docs/chats/sharing)