#List application lines

GET /v1/telephony-lines

Returns the list of external lines added by the application via POST /v1/telephony-lines. The list is returned in full — filtering, sorting, and offset are not supported; select the line you need on the client side.

#Parameters

#Examples

#curl — personal key

curl "https://vibecode.bitrix24.com/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_API_KEY"

#curl — OAuth application

curl "https://vibecode.bitrix24.com/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

#JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/telephony-lines', {
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
  },
})

const { success, data, meta } = await res.json()
console.log(`Found ${meta.total} lines`)

#JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/telephony-lines', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})

const { success, data, meta } = await res.json()

#Response fields

#Response example

HTTP 200, empty selection:

{"success":true,"data":[],"meta":{"total":0,"hasMore":false}}

HTTP 200, one line:

{
  "success": true,
  "data": [
    {
      "number": "doc-test-line-001",
      "name": "Test line (audit)",
      "crmAutoCreate": true
    }
  ],
  "meta": {
    "total": 1,
    "hasMore": false
  }
}

#Error response example

403 — no scope:

{
  "success": false,
  "error": {
    "code": "SCOPE_DENIED",
    "message": "This endpoint requires 'telephony' scope"
  }
}

#Errors

Full list of common API errors — Errors.

#Known specifics

Only this application's lines. The list contains lines created via POST /v1/telephony-lines under the current API key. Lines rented from Voximplant or connected over SIP are available via GET /v1/voximplant-lines.

Filtering, sorting, and offset do not work. The filter, order, and offset parameters are accepted without error but ignored — the whole list of lines is returned. Only limit (caps the count) and select (field selection in camelCase) work. Filter by number or name on the client side.

All response fields are in camelCase, including crmAutoCreate (boolean). Previously this field came back in UPPER_SNAKE_CASE as the string "Y"/"N" — since 07.2026 it is normalized to a camelCase boolean, like the other fields.

serverName is not returned. The field is declared in GET /v1/telephony-lines/fields but never comes back in the list under any condition — even if it was set at creation (details).

#See also

• Add a line — POST /v1/telephony-lines
• Update a line — PATCH /v1/telephony-lines/:number
• Delete a line — DELETE /v1/telephony-lines/:number
• Voximplant lines — GET /v1/voximplant-lines
• Filtering syntax
• Outbound calls — lines are used as fromLine

#Add a line

POST /v1/telephony-lines

Registers a new external application line in the Bitrix24 account. After creation the line is available in GET /v1/telephony-lines and can be used as fromLine in outbound calls. Fields are passed flat at the JSON root — without a fields wrapper.

#Request fields (body)

#Examples

#curl — personal key

curl -X POST "https://vibecode.bitrix24.com/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "sip-line-1",
    "name": "Main line",
    "crmAutoCreate": false
  }'

#curl — OAuth application

curl -X POST "https://vibecode.bitrix24.com/v1/telephony-lines" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "number": "sip-line-1",
    "name": "Main line",
    "crmAutoCreate": false
  }'

#JavaScript — personal key

const res = await fetch('https://vibecode.bitrix24.com/v1/telephony-lines', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    number: 'sip-line-1',
    name: 'Main line',
    crmAutoCreate: false,
  }),
})

const { success, data } = await res.json()
console.log('Internal record ID:', data.id)

#JavaScript — OAuth application

const res = await fetch('https://vibecode.bitrix24.com/v1/telephony-lines', {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    number: 'sip-line-1',
    name: 'Main line',
    crmAutoCreate: false,
  }),
})

const { success, data } = await res.json()

#Response fields

#Response example

{
  "success": true,
  "data": {
    "id": 17
  }
}

#Error response example

422 — the number field was not provided:

{
  "success": false,
  "error": {
    "code": "BITRIX_ERROR",
    "message": "NUMBER should not be empty"
  }
}

#Errors

Full list of common API errors — Errors.

#Known specifics

serverName is declared in GET /v1/telephony-lines/fields but does not work. The field is accepted on creation (response 201), but it is not stored, not returned on read, and not updated (a PATCH with serverName alone responds 422 "There are no fields to update"). Do not use it — the value you pass is lost.

The crmAutoCreate field is a camelCase boolean. Pass true/false; if omitted, the line is created with the default value true. Previously only the UPPER_SNAKE name CRM_AUTO_CREATE was accepted as a "Y"/"N" string and crmAutoCreate was silently dropped — since 07.2026 the canonical form is a camelCase boolean (the raw UPPER variant is still accepted on write for compatibility).

data.id is an internal identifier, not used for other operations. Updating and deleting a line are done by the number from the request body, not by data.id from the response. Save the number you passed — it is exactly what goes into the PATCH /v1/telephony-lines/:number and DELETE /v1/telephony-lines/:number URLs. Values with +, spaces, or / are allowed — when substituted into the URL they must be encoded: +12025550123 → %2B12025550123.

#See also

• List application lines — GET /v1/telephony-lines
• Update a line — PATCH /v1/telephony-lines/:number
• Delete a line — DELETE /v1/telephony-lines/:number
• Outbound calls — using number as fromLine