crm.activity.list
Получить список дел
Описание
Метод crm.activity.list возвращает список активностей по фильтру с учетом прав текущего пользователя.
Параметры
select
array
необязательный
Массив полей дела crm.activity.fields, которые необходимо выбрать.
Чтобы получить поля COMMUNICATIONS и FILES укажите их в select.
filter
object
необязательный
Объект для фильтрации выбираемых элементов в формате ключ-значение.
Возможные значения для field соответствуют полям дела crm.activity.fields.
Ключу может быть задан дополнительный префикс, уточняющий поведение фильтра. Возможные значения префикса:
>=— больше либо равно>— больше<=— меньше либо равно<— меньше@— IN (в качестве значения передаётся массив)!@— NOT IN (в качестве значения передаётся массив)%— LIKE, поиск по подстроке. Символ%в значении фильтра передавать не нужно. Поиск ищет подстроку в любой позиции строки=%— LIKE, поиск по подстроке. Символ%нужно передавать в значении. Примеры:
- "мол%" — ищем значения, начинающиеся с «мол»
- "%мол" — ищем значения, заканчивающиеся на «мол»
- "%мол%" — ищем значения, где «мол» может быть в любой позиции%=— LIKE (см. описание выше)!%— NOT LIKE, поиск по подстроке. Символ%в значении фильтра передавать не нужно. Поиск идет с обоих сторон.=%— NOT LIKE, поиск по подстроке. Символ%нужно передавать в значении. Примеры:
- "мол%" — ищем значения, не начинающиеся с «мол»
- "%мол" — ищем значения, не заканчивающиеся на «мол»
- "%мол%" — ищем значения, где подстроки «мол» нет в любой позиции!%=— NOT LIKE (см. описание выше)=— равно, точное совпадение (используется по умолчанию)!=- не равно!— не равно
order
object
необязательный
Набор пар ключ-значение для сортировки результатов вывода.
В качестве ключей можно использовать смотрите поля дела crm.activity.fields.
Возможные значения для order:
asc— в порядке возрастанияdesc— в порядке убывания
По-умолчанию сортируется по увеличению поля Дата начала (START_TIME)
start
integer
необязательный
Параметр используется для управления постраничной навигацией.
Размер страницы результатов всегда статичный: 50 записей.
Чтобы выбрать вторую страницу результатов, необходимо передавать значение 50. Чтобы выбрать третью страницу результатов — значение 100 и так далее.
Формула расчета значения параметра start:
start = (N-1) * 50, где N — номер нужной страницы
Примеры запроса
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"DESC"},"filter":{"BINDINGS":[{"OWNER_TYPE_ID":2},{"OWNER_TYPE_ID":3}]},"select":["*","COMMUNICATIONS"],"start":0}' \
https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.activity.list
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"order":{"ID":"DESC"},"filter":{"BINDINGS":[{"OWNER_TYPE_ID":2},{"OWNER_TYPE_ID":3}]},"select":["*","COMMUNICATIONS"],"start":0,"auth":"**put_access_token_here**"}' \
https://**put_your_bitrix24_address**/rest/crm.activity.list
// This snippet is an ES module: top-level await requires type="module" or a bundler.
// $b24 is an already-initialized SDK instance (see the SDK "Get started" guide).
import { Text } from '@bitrix24/b24jssdk'
import type { B24Frame, ISODate } from '@bitrix24/b24jssdk'
declare const $b24: B24Frame
// Shape of each activity item returned in result[]
type ActivityItem = {
ID: string
OWNER_ID: string
OWNER_TYPE_ID: string
TYPE_ID: string
SUBJECT: string
CREATED: ISODate | null
LAST_UPDATED: ISODate | null
START_TIME: ISODate | null
END_TIME: ISODate | null
DEADLINE: ISODate | null
COMPLETED: string
STATUS: string
RESPONSIBLE_ID: string
DIRECTION: string
AUTHOR_ID: string
EDITOR_ID: string
}
try {
// crm.activity.list returns a single page (max 50 records). For the whole result set
// use a list helper: $b24.actions.v2.callList.make() returns every record as one
// array, $b24.actions.v2.fetchList.make() yields them in chunks (async generator).
// NOTE: the list helpers do not accept `order` (it is excluded from their params, so
// passing it is a TS error) — keep this call.make + `start` variant when sort matters.
const response = await $b24.actions.v2.call.make<ActivityItem[]>({
method: 'crm.activity.list',
params: {
order: { ID: 'DESC' },
filter: {
BINDINGS: [
{ OWNER_TYPE_ID: 2 },
{ OWNER_TYPE_ID: 3 },
],
},
select: ['*', 'COMMUNICATIONS'],
start: 0,
},
requestId: Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
} else {
const result = response.getData()!.result
console.info('Activities matched by bindings on page:', result.length, result)
}
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
<!-- Load the SDK (UMD build); it is exposed as the global B24Js -->
<script src="https://unpkg.com/@bitrix24/b24jssdk@1/dist/umd/index.min.js"></script>
<script>
async function listActivitiesWithBindings() {
try {
// Initialize the SDK inside a Bitrix24 frame
const $b24 = await B24Js.initializeB24Frame()
const response = await $b24.actions.v2.call.make({
method: 'crm.activity.list',
params: {
order: { ID: 'DESC' },
filter: {
BINDINGS: [
{ OWNER_TYPE_ID: 2 },
{ OWNER_TYPE_ID: 3 },
],
},
select: ['*', 'COMMUNICATIONS'],
start: 0,
},
requestId: B24Js.Text.getUuidRfc4122()
})
// The payload is available only on a successful response
if (!response.isSuccess) {
console.error(response.getErrorMessages().join('; '))
return
}
const result = response.getData().result
console.info('Activities matched by bindings on page:', result.length, result)
} catch (error) {
// Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
console.error(error)
}
}
document.addEventListener('DOMContentLoaded', listActivitiesWithBindings)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.list(
select=[
"*",
"COMMUNICATIONS",
],
filter={
"BINDINGS": [
{
"OWNER_TYPE_ID": 2,
},
{
"OWNER_TYPE_ID": 3,
},
],
},
order={
"ID": "DESC",
},
).response
result = bitrix_response.result
print(result)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.list(
select=[
"*",
"COMMUNICATIONS",
],
filter={
"BINDINGS": [
{
"OWNER_TYPE_ID": 2,
},
{
"OWNER_TYPE_ID": 3,
},
],
},
order={
"ID": "DESC",
},
).as_list().response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
from b24pysdk.errors import BitrixAPIError, BitrixSDKException
try:
bitrix_response = client.crm.activity.list(
select=[
"*",
"COMMUNICATIONS",
],
filter={
"BINDINGS": [
{
"OWNER_TYPE_ID": 2,
},
{
"OWNER_TYPE_ID": 3,
},
],
},
order={
"ID": "DESC",
},
).as_list_fast(descending=True).response
result = bitrix_response.result
for item in result:
print(item)
except BitrixAPIError as error:
print(
"Ошибка Bitrix API",
f"error: {error.error}",
f"error_description: {error.error_description}",
sep="\n",
)
except BitrixSDKException as error:
print(f"Ошибка Bitrix SDK: {error.message}")
except Exception as error:
print(f"Непредвиденная ошибка: {error}")
try {
$response = $b24Service
->core
->call(
'crm.activity.list',
[
'order' => [
'ID' => 'DESC',
],
'filter' => [
'BINDINGS' => [
[
'OWNER_TYPE_ID' => 2,
],
[
'OWNER_TYPE_ID' => 3,
],
],
],
'select' => [
'*',
'COMMUNICATIONS',
],
'start' => 0,
]
);
$result = $response
->getResponseData()
->getResult();
if ($result->error()) {
error_log($result->error());
} else {
echo 'Activities: ' . print_r($result->data(), true);
}
} catch (Throwable $e) {
error_log($e->getMessage());
echo 'Error getting activity list: ' . $e->getMessage();
}
BX24.callMethod(
'crm.activity.list',
{
order: {
ID: 'DESC',
},
filter: {
BINDINGS: [
{
OWNER_TYPE_ID: 2,
},
{
OWNER_TYPE_ID: 3,
},
],
},
select: [
'*',
'COMMUNICATIONS',
],
start: 0,
},
result => {
if (result.error()) {
console.error(result.error());
} else {
console.dir(result.data());
}
}
);
require_once('crest.php');
$result = CRest::call(
'crm.activity.list',
[
'order' => ['ID' => 'DESC'],
'filter' => [
'BINDINGS' => [
['OWNER_TYPE_ID' => 2],
['OWNER_TYPE_ID' => 3]
]
],
'select' => ['*', 'COMMUNICATIONS'],
'start' => 0
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "crm.activity.list", b24.Params{
"order": b24.Params{
"ID": "DESC",
},
"filter": b24.Params{
"BINDINGS": []b24.Params{
{
"OWNER_TYPE_ID": 2,
},
{
"OWNER_TYPE_ID": 3,
},
},
},
"select": []string{"*", "COMMUNICATIONS"},
"start": 0,
}, b24.WithIdempotent())
if err != nil {
return fmt.Errorf("crm.activity.list: %w", err)
}
var items []struct {
ID b24.ID `json:"ID"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
fmt.Println(it.ID)
}
// Total и Next заполняют списочные методы; для полного
// обхода списка есть client.Core().Pages и Scan.
if res.Total != nil {
fmt.Println("всего:", *res.Total)
}
Ответ
HTTP-статус: 200
{
"result": [
{
"ID": "20",
"OWNER_ID": "15",
"OWNER_TYPE_ID": "3",
"TYPE_ID": "2",
"PROVIDER_ID": "VOXIMPLANT_CALL",
"PROVIDER_TYPE_ID": "CALL",
"PROVIDER_GROUP_ID": null,
"ASSOCIATED_ENTITY_ID": "0",
"SUBJECT": "Исходящий звонок Андрей Николаев",
"CREATED": "2020-09-27T13:26:55+03:00",
"LAST_UPDATED": "2021-03-21T20:28:24+03:00",
"START_TIME": "2020-09-27T13:25:00+03:00",
"END_TIME": "2020-09-27T19:25:00+03:00",
"DEADLINE": "2020-09-27T13:25:00+03:00",
"COMPLETED": "Y",
"STATUS": "2",
"RESPONSIBLE_ID": "505",
"PRIORITY": "2",
"NOTIFY_TYPE": "1",
"NOTIFY_VALUE": "15",
"DESCRIPTION": "",
"DESCRIPTION_TYPE": "1",
"DIRECTION": "2",
"LOCATION": "",
"SETTINGS": [],
"ORIGINATOR_ID": null,
"ORIGIN_ID": null,
"AUTHOR_ID": "505",
"EDITOR_ID": "505",
"PROVIDER_PARAMS": [],
"PROVIDER_DATA": null,
"RESULT_MARK": "0",
"RESULT_VALUE": null,
"RESULT_SUM": null,
"RESULT_CURRENCY_ID": null,
"RESULT_STATUS": "0",
"RESULT_STREAM": "0",
"RESULT_SOURCE_ID": null,
"AUTOCOMPLETE_RULE": "0"
},
// .. Еще 49 элементов
],
"next": 50,
"total": 123456,
"time": {
"start": 1724677896.295857,
"finish": 1724677897.197243,
"duration": 0.901386022567749,
"processing": 0.8762130737304688,
"date_start": "2024-08-26T16:11:36+03:00",
"date_finish": "2024-08-26T16:11:37+03:00",
"operating_reset_at": "2024-08-26T16:11:37+03:00",
"operating": 0.0162130737304688
}
}
Возвращаемые данные
result
array
Массив дел. Для получения информации о структуре дела смотрите метод crm.activity.fields
time
time
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "INVALID_REQUEST",
"error_description": "Https required"
}

