For AI agents: markdown of this page — /docs-content-en/voximplant-lines/default.md documentation index — /llms.txt

Default outgoing line

GET /v1/voximplant-lines/default

Scope: telephony | Authentication: X-Api-Key | URL: https://vibecode.bitrix24.com/v1

GET /v1/voximplant-lines/default calls voximplant.line.outgoing.get and returns data: {lineId}. PUT with {lineId} calls voximplant.line.outgoing.set, then re-reads the setting. lineId is required and must exist in GET /v1/voximplant-lines. Empty or unknown ID: 400 before writing. This setting changes the entire Bitrix24 account.

Errors: 400 invalid parameters; 401 key or token; 403 scope, Bitrix24 permissions or READONLY writes; 422 upstream refusal; 429 limits; 502 unavailable Bitrix24 account; 503 timeout or freeze.

PUT /v1/voximplant-lines/default

Request parameters

Field Type Required Meaning
lineId string yes for PUT Existing ID from available lines; changes the entire account setting.

Response fields

Field Meaning
success Boolean result
data Result described above; credentials are omitted

Examples

cURL Personal key

Terminal 
curl -X GET 'https://vibecode.bitrix24.com/v1/voximplant-lines/default' \
  -H 'X-Api-Key: FAKE_VIBE_API_KEY'

cURL OAuth

Terminal 
curl -X GET 'https://vibecode.bitrix24.com/v1/voximplant-lines/default' \
  -H 'X-Api-Key: FAKE_VIBE_API_KEY' \
  -H 'Authorization: Bearer FAKE_APP_SESSION_TOKEN'

JavaScript Personal key

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/voximplant-lines/default', {
  method: 'GET',
  headers: {"X-Api-Key": "FAKE_VIBE_API_KEY"},
});
console.log(await response.json());

JavaScript OAuth

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/voximplant-lines/default', {
  method: 'GET',
  headers: {"X-Api-Key": "FAKE_VIBE_API_KEY", "Authorization": "Bearer FAKE_APP_SESSION_TOKEN"},
});
console.log(await response.json());

Observed on the test account 2026-10-02; the example shows nonsecret response fields.

JSON 
{
  "success": true,
  "data": {
    "lineId": "reg151083"
  }
}

Write the selected lineId using PUT; use the same authentication headers as above:

Terminal 
curl -X PUT https://vibecode.bitrix24.com/v1/voximplant-lines/default \
  -H 'X-Api-Key: FAKE_VIBE_API_KEY' \
  -H 'Content-Type: application/json' \
  --data '{"lineId":"reg151083"}'

Errors

HTTP Code
400 INVALID_PARAMS / MISSING_REQUIRED_FIELDS / READONLY_FIELD
401 MISSING_API_KEY / INVALID_API_KEY / TOKEN_MISSING
403 SCOPE_DENIED / WRITE_BLOCKED_READONLY_KEY / BITRIX_ACCESS_DENIED
422 BITRIX_ERROR
429 RATE_LIMITED
502 BITRIX_UNAVAILABLE
503 BITRIX_TIMEOUT

Error reference

403 when the key has no telephony scope:

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

See also

Calls

SIP