For AI agents: markdown of this page — /docs-content-en/telephony/crm/hide.md documentation index — /llms.txt

Hide the call card

POST /v1/calls/:callId/hide

Removes the active-call card shown over open Bitrix24 windows for the specified user. Symmetric to POST /v1/calls/:callId/show.

Parameters

Parameter In Type Required Description
ParametercallId Inpath Typestring Requiredyes DescriptionCALL_ID from the POST /v1/calls/register response

Request fields (body)

Parameter Type Required Default Description
ParameteruserId Typenumber Requiredyes Default— DescriptionID of the Bitrix24 user whose card is hidden. A positive integer. A numeric string such as "42" is also accepted. Employees

Examples

curl — personal key

Terminal 
curl -X POST https://vibecode.bitrix24.com/v1/calls/CALL_ID/hide \
  -H "X-Api-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"userId": 1}'

curl — OAuth application

Terminal 
curl -X POST https://vibecode.bitrix24.com/v1/calls/CALL_ID/hide \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"userId": 1}'

JavaScript — personal key

javascript 
const callId = 'externalCall.00b1e735843c558431be668e3687a58b.1777974304'

const res = await fetch(`https://vibecode.bitrix24.com/v1/calls/${callId}/hide`, {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_API_KEY',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userId: 1 }),
})

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

JavaScript — OAuth application

javascript 
const callId = 'externalCall.00b1e735843c558431be668e3687a58b.1777974304'

const res = await fetch(`https://vibecode.bitrix24.com/v1/calls/${callId}/hide`, {
  method: 'POST',
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({ userId: 1 }),
})

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

Response fields

Field Type Description
Fielddata Typeboolean Descriptiontrue — the card was hidden successfully, false — the card was not found: the call does not exist or has already finished

Response example

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

Error response example

400 — a required parameter is missing:

JSON 
{
  "success": false,
  "error": {
    "code": "MISSING_PARAMS",
    "message": "Required: userId (positive integer)"
  }
}

Errors

HTTP Code Description
HTTP400 CodeMISSING_PARAMS DescriptionuserId is missing or is not recognized as a positive integer
HTTP401 CodeMISSING_API_KEY DescriptionThe X-Api-Key header is missing
HTTP401 CodeINVALID_API_KEY DescriptionThe key is not recognized — no such key exists on the platform
HTTP401 CodeTOKEN_MISSING DescriptionThe API key has no Bitrix24 tokens configured
HTTP401 CodeKEY_INACTIVE DescriptionThe API key is inactive or revoked
HTTP403 CodeSCOPE_DENIED DescriptionThe key is missing the telephony scope
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 returned an error (text in error.message)
HTTP429 CodeRATE_LIMITED DescriptionRequest limit exceeded
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable

Full list of common API errors — Errors.

Known specifics

The success indicator is the data field, not the HTTP status. For a non-existent callId, Bitrix24 returns HTTP 200 with data: false. Check the field value, not the response code.

userId does not have to match the user who registered the call. The card can be hidden for any user in the Bitrix24 account.

See also