Employee telephony settings

GET /v1/telephony-users

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

GET /v1/telephony-users?userIds=42,43 calls voximplant.user.get with a USER_ID array. Requires an OAuth application key; webhook keys receive 403 OAUTH_REQUIRED before a Bitrix24 call. Response fields: id, defaultLine, phoneEnabled, sipServer, sipLogin, hasPassword, innerNumber. SIP_PASSWORD is never exposed. Bitrix24 checks permissions and may require administrator confirmation.

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.

Request parameters

Field	Type	Required	Meaning
FielduserIds	Typestring	Requiredyes	MeaningComma separated positive employee IDs from users.

Response fields

Field	Meaning
Fieldsuccess	MeaningBoolean result
Fielddata	MeaningResult described above; credentials are omitted

Examples

cURL OAuth

Terminal

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

JavaScript OAuth

javascript

const response = await fetch('https://vibecode.bitrix24.com/v1/telephony-users?userIds=42,43', {
  method: 'GET',
  headers: {"X-Api-Key": "FAKE_VIBE_API_KEY", "Authorization": "Bearer FAKE_APP_SESSION_TOKEN"},
});
console.log(await response.json());

Successful OAuth response was not checked live; no application OAuth key was available.

Errors

HTTP	Code
HTTP400	CodeINVALID_PARAMS / MISSING_REQUIRED_FIELDS / READONLY_FIELD
HTTP401	CodeMISSING_API_KEY / INVALID_API_KEY / TOKEN_MISSING
HTTP403	CodeSCOPE_DENIED / WRITE_BLOCKED_READONLY_KEY / BITRIX_ACCESS_DENIED
HTTP422	CodeBITRIX_ERROR
HTTP429	CodeRATE_LIMITED
HTTP502	CodeBITRIX_UNAVAILABLE
HTTP503	CodeBITRIX_TIMEOUT
HTTP403	CodeOAUTH_REQUIRED

Error reference

403 when using a webhook key:

JSON

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