لوكلاء AI: ملف markdown لهذه الصفحة — /docs-content-en/calls/log/list.md فهرس التوثيق — /llms.txt

مقالات التوثيق متاحة حاليًا باللغة الإنجليزية فقط.

List call journal

GET /v1/calls/log

Returns the key owner's personal call journal — incoming, outgoing and missed calls — with a missed-call counter. The journal is read page by page using a cursor from the last record.

Parameters

Parameter Type Required Default Description
Parameterstatus (query) Typestring / string[] Requiredno Default— DescriptionCall status: initiated, answered, declined, missed, case-insensitive. Several statuses — status[]=missed&status[]=answered or a repeated parameter status=missed&status=answered
ParameterexcludeStatus (query) Typestring Requiredno Default— DescriptionOne status from the same list to exclude from the results
Parametertype (query) Typestring Requiredno Default— DescriptionDirection: incoming or outgoing. When status is also passed, status takes precedence
Parametersearch (query) Typestring Requiredno Default— DescriptionSearch string
Parametercount (query) Typeinteger Requiredno Default50 DescriptionPage size, a positive integer. A value above 100 is capped at 100
ParameterlastId (query) Typeinteger Requiredno Default0 Descriptionid of the last record on the previous page. 0 — the first page
ParameterlastStatusTime (query) Typestring Requiredno Default— DescriptionstatusTime of the last record on the previous page, passed together with lastId

Other query parameters are rejected with 400 INVALID_PARAMS.

Pagination: for the next page, pass lastId and lastStatusTime from the last record of the current one. Pass statusTime unchanged, exactly as it arrived: it is an ATOM date with a time zone offset.

Examples

curl — personal key

Terminal 
curl -g -X GET "https://vibecode.bitrix24.com/v1/calls/log?status[]=missed&status[]=answered&count=50" \
  -H "X-Api-Key: YOUR_API_KEY"

curl — OAuth application

Terminal 
curl -g -X GET "https://vibecode.bitrix24.com/v1/calls/log?status[]=missed&status[]=answered&count=50" \
  -H "X-Api-Key: YOUR_APP_KEY" \
  -H "Authorization: Bearer USER_SESSION_TOKEN"

JavaScript — personal key

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/calls/log?status[]=missed&status[]=answered&count=50', {
  headers: { 'X-Api-Key': 'YOUR_API_KEY' },
})
const { success, data, error } = await response.json()
console.log(success ? data.calls : error.code)

JavaScript — OAuth application

javascript 
const response = await fetch('https://vibecode.bitrix24.com/v1/calls/log?status[]=missed&status[]=answered&count=50', {
  headers: {
    'X-Api-Key': 'YOUR_APP_KEY',
    'Authorization': 'Bearer USER_SESSION_TOKEN',
  },
})
const { success, data, error } = await response.json()
console.log(success ? data.calls : error.code)

Response fields

Field Type Description
Fieldsuccess Typeboolean Descriptiontrue on success
Fielddata.calls Typearray DescriptionJournal records; an empty array means there are none
Fielddata.calls[].id Typeinteger DescriptionJournal record ID. Used to delete a record and as lastId
Fielddata.calls[].sourceType Typestring DescriptionCall source
Fielddata.calls[].sourceCallId Typeinteger DescriptionCall ID in the source
Fielddata.calls[].status Typestring DescriptionStatus: initiated, answered, declined, missed
Fielddata.calls[].statusTime Typestring DescriptionTime of the status change in ATOM format. Used as lastStatusTime
Fielddata.calls[].type Typestring DescriptionDirection: incoming or outgoing
Fielddata.calls[].isUnseen Typeboolean DescriptionWhether the record is unseen
Fielddata.calls[].callData Typeobject DescriptionCall data. Only the fields present in the record are returned: phoneNumber, displayName, title, avatar, color, dialogId, chatType are strings, duration, userId, chatId, userCount are integers
Fielddata.missedCounter Typeinteger DescriptionMissed-call counter

Response example

A journal with no records:

JSON 
{
  "success": true,
  "data": {
    "calls": [],
    "missedCounter": 0
  }
}

Error response example

400 — unknown status:

JSON 
{
  "success": false,
  "error": {
    "code": "INVALID_FILTER_VALUE",
    "message": "Invalid filter value"
  }
}

Errors

HTTP Code Description
HTTP400 CodeINVALID_FILTER_VALUE Descriptionstatus or excludeStatus is outside the status list, the status array is empty, or type or search is not a string
HTTP400 CodeINVALID_PARAMS DescriptionUnknown query parameter: Unknown query parameter
HTTP400 CodeINVALID_PARAMS Descriptioncount is not a positive integer, lastId is not a non-negative integer, or lastStatusTime is not a string
HTTP403 CodeSCOPE_DENIED DescriptionThe key lacks the call scope
HTTP403 CodeBITRIX_ACCESS_DENIED DescriptionBitrix24 denied access
HTTP401 CodeTOKEN_MISSING DescriptionThe key has no Bitrix24 tokens configured
HTTP422 CodeBITRIX_ERROR DescriptionBitrix24 rejected the request; the text is in error.message
HTTP429 CodeRATE_LIMITED DescriptionThe Bitrix24 request limit is exceeded
HTTP502 CodeBITRIX_ERROR DescriptionThe journal response does not have the expected shape: Invalid call log response
HTTP502 CodeBITRIX_UNAVAILABLE DescriptionBitrix24 is unavailable
HTTP503 CodeBITRIX_TIMEOUT DescriptionBitrix24 did not respond in time

The full list of common API errors — Errors.

Known specifics

The journal is personal. The response contains only the calls of the user who owns the key. Call statistics for the Bitrix24 account are read separately — Analytics and reference data.

Strings with credentials are hidden. A string field of a record that contains a URL with a Bitrix24 access token is returned as [REDACTED].

The manage_call_log MCP tool. The same list is requested with action: "list" and parameters in query: { "status": ["missed", "answered"], "count": 50 }. The status array must contain at least one string; other query values are strings or numbers.

See also