Найти клиента в CRM по номеру телефона telephony.externalCall.searchCrmEntities

Scope: telephony

Кто может выполнять метод: любой пользователь

Метод telephony.externalCall.searchCrmEntities возвращает CRM-объекты по номеру телефона клиента и данные ответственного сотрудника.

Параметры метода

Обязательные параметры отмечены *

Название `тип`	Описание
PHONE_NUMBER* `string`	Номер телефона клиента

Примеры кода

Как использовать примеры в документации

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"PHONE_NUMBER":"79062195047"}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/telephony.externalCall.searchCrmEntities

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"PHONE_NUMBER":"79062195047","auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/telephony.externalCall.searchCrmEntities

try
        {
            const response = await $b24.callMethod(
                'telephony.externalCall.searchCrmEntities',
                {
                    PHONE_NUMBER: '79062195047'
                }
            );
            
            const result = response.getData().result;
            console.log('CRM entities found:', result);
            processResult(result);
        }
        catch( error )
        {
            console.error('Error:', error);
        }

try {
            $response = $b24Service
                ->core
                ->call(
                    'telephony.externalCall.searchCrmEntities',
                    [
                        'PHONE_NUMBER' => '79062195047'
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            echo 'Success: ' . print_r($result, true);
            processData($result);
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error searching CRM entities: ' . $e->getMessage();
        }

BX24.callMethod(
            "telephony.externalCall.searchCrmEntities",
            {
                PHONE_NUMBER: '79062195047'
            },
            function(result)
            {
                if (result.error())
                {
                    console.error(result.error(), result.error_description());
                }
                else
                {
                    console.log(result.data());
                }
            }
        );

require_once('crest.php');
        
        $result = CRest::call(
            'telephony.externalCall.searchCrmEntities',
            [
                'PHONE_NUMBER' => '79062195047'
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

Обработка ответа

HTTP-статус: 200

{
            "result": [
                {
                "CRM_ENTITY_TYPE": "CONTACT",
                "CRM_ENTITY_ID": 651,
                "ASSIGNED_BY_ID": 99,
                "NAME": "Иван Иванов",
                "ASSIGNED_BY": {
                    "ID": "99",
                    "TIMEMAN_STATUS": "CLOSED",
                    "USER_PHONE_INNER": null,
                    "WORK_PHONE": null,
                    "PERSONAL_PHONE": null,
                    "PERSONAL_MOBILE": "79062195047"
                }
                },
                {
                "CRM_ENTITY_TYPE": "COMPANY",
                "CRM_ENTITY_ID": 643,
                "ASSIGNED_BY_ID": 99,
                "NAME": "ООО Ромашка",
                "ASSIGNED_BY": {
                    "ID": "99",
                    "TIMEMAN_STATUS": "CLOSED",
                    "USER_PHONE_INNER": null,
                    "WORK_PHONE": null,
                    "PERSONAL_PHONE": null,
                    "PERSONAL_MOBILE": "79062195047"
                }
                }
            ],
            "time": {
                "start": 1772808159,
                "finish": 1772808159.397228,
                "duration": 0.3972280025482178,
                "processing": 0,
                "date_start": "2026-03-06T17:42:39+03:00",
                "date_finish": "2026-03-06T17:42:39+03:00",
                "operating_reset_at": 1772808759,
                "operating": 0.25037074089050293
            }
        }

Возвращаемые данные

Название `тип`	Описание
result `array`	Массив найденных объектов CRM
CRM_ENTITY_TYPE `string`	Тип объекта CRM. Возможные значения: `CONTACT` — контакт `LEAD` — лид `COMPANY` — компания
CRM_ENTITY_ID `integer`	Идентификатор объекта CRM
ASSIGNED_BY_ID `integer`	Идентификатор ответственного сотрудника
NAME `string`	Название или ФИО найденного объекта CRM
ASSIGNED_BY `object`	Данные ответственного сотрудника
time `time`	Информация о времени выполнения запроса

Объект ASSIGNED_BY

Название `тип`	Описание
ID `integer`	Идентификатор сотрудника
TIMEMAN_STATUS `string`	Статус рабочего времени сотрудника. Возможные значения: `OPENED` — рабочий день начат `CLOSED` — рабочий день завершен `PAUSED` — перерыв `EXPIRED` — рабочий день истек `UNAVAILABLE` — учет рабочего времени отключен у сотрудника `NOT_INSTALLED` — модуль учета рабочего времени не установлен
USER_PHONE_INNER `string`	Внутренний номер сотрудника
WORK_PHONE `string`	Рабочий телефон сотрудника
PERSONAL_PHONE `string`	Личный телефон сотрудника
PERSONAL_MOBILE `string`	Мобильный телефон сотрудника

Обработка ошибок

HTTP-статус: 400

{
            "error": "ERROR_CORE",
            "error_description": "PHONE_NUMBER is empty"
        }

Название `тип`	Описание
error `string`	Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания
error_description `error_description`	Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код	Описание	Значение
`ERROR_CORE`	PHONE_NUMBER is empty	Не передан обязательный параметр `PHONE_NUMBER`
`ERROR_CORE`	CRM is not installed.	На портале не установлен модуль CRM

Статусы и коды системных ошибок

HTTP-статус: 20x, 40x, 50x

Описанные ниже ошибки могут возникнуть при вызове любого метода

Статус	Код Текст ошибки	Описание
`500`	`INTERNAL_SERVER_ERROR` Internal server error	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	Возникла внутренняя ошибка сервера, обратитесь к администратору сервера или в техническую поддержку Битрикс24
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	Превышен лимит на интенсивность запросов
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	Текущий метод не разрешен для вызова с помощью batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	Превышена максимальная длина параметров, переданных в метод batch
`401`	`NO_AUTH_FOUND` Wrong authorization data	Неверный access-токен или код вебхука
`400`	`INVALID_REQUEST` Https required	Для вызовов методов требуется использовать протокол HTTPS
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	REST API заблокирован из-за перегрузки. Это ручная индивидуальная блокировка, для снятия необходимо обращаться в техническую поддержку Битрикс24
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	REST API доступен только на коммерческих планах
`403`	`INVALID_CREDENTIALS` Invalid request credentials	У пользователя, с чьим access-токеном или вебхуком был вызван метод, не хватает прав
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	Манифест недоступен
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	Запрос требует более высоких привилегий, чем предоставляет токен вебхука
`401`	`expired_token` The access token provided has expired	Предоставленный access-токен доступа истек
`403`	`user_access_error` The user does not have access to the application	Пользователь не имеет доступа к приложению. Это означает, что приложение установлено, но администратор портала разрешил доступ к этому приложению только конкретным пользователям
`500`	`PORTAL_DELETED` Portal was deleted	Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

Продолжите изучение

Удалить внешнюю линию

Зарегистрировать начало звонка

Найти клиента в CRM по номеру телефона telephony.externalCall.searchCrmEntities

Параметры методаПараметры метода

Примеры кодаПримеры кода

Обработка ответаОбработка ответа

Возвращаемые данныеВозвращаемые данные

Объект ASSIGNED_BYОбъект ASSIGNED_BY

Обработка ошибокОбработка ошибок

Возможные коды ошибокВозможные коды ошибок

Статусы и коды системных ошибокСтатусы и коды системных ошибок

Продолжите изучениеПродолжите изучение