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

Выберите инструмент для разработки с AI-агентом:

  • используйте Битрикс24 Вайбкод, чтобы создать приложение для Битрикс24 по описанию задачи без знания языков программирования. Агент напишет код и разместит приложение на сервере без ручной настройки хостинга
  • используйте MCP-сервер, чтобы разрабатывать интеграцию через REST API в своем проекте. Агент будет обращаться к официальной REST-документации

Scope: telephony

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

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

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

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

Название
тип

Описание

PHONE_NUMBER*
string

Номер телефона клиента

Примеры кода

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

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
// 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 } from '@bitrix24/b24jssdk'

declare const $b24: B24Frame

// Shape of each CRM entity returned in result[]
type CrmEntityResult = {
  CRM_ENTITY_TYPE: string
  CRM_ENTITY_ID: number
  ASSIGNED_BY_ID: number
  NAME: string
  ASSIGNED_BY: {
    ID: string
    TIMEMAN_STATUS: string
    USER_PHONE_INNER: string | null
    WORK_PHONE: string | null
    PERSONAL_PHONE: string | null
    PERSONAL_MOBILE: string | null
  }
}

try {
  const response = await $b24.actions.v2.call.make<CrmEntityResult[]>({
    method: 'telephony.externalCall.searchCrmEntities',
    params: {
      PHONE_NUMBER: '79062195047',
    },
    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('CRM entities found:', 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 searchCrmEntities() {
    try {
      // Initialize the SDK inside a Bitrix24 frame
      const $b24 = await B24Js.initializeB24Frame()

      const response = await $b24.actions.v2.call.make({
        method: 'telephony.externalCall.searchCrmEntities',
        params: {
          PHONE_NUMBER: '79062195047',
        },
        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('CRM entities found:', result.length, result)
    } catch (error) {
      // Thrown on transport or SDK failures (AjaxError, SdkError, etc.)
      console.error(error)
    }
  }

  document.addEventListener('DOMContentLoaded', searchCrmEntities)
</script>
from b24pysdk.errors import BitrixAPIError, BitrixSDKException

try:
    bitrix_response = client.telephony.external_call.search_crm_entities(
        phone_number="79062195047",
    ).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}")
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>';
// client и ctx уже созданы — см. раздел «SDK для Go»
res, err := client.Core().Call(ctx, "telephony.externalCall.searchCrmEntities", b24.Params{
	"PHONE_NUMBER": "79062195047",
})
if err != nil {
	return fmt.Errorf("telephony.externalCall.searchCrmEntities: %w", err)
}

var items []struct {
	CRMEntityType string `json:"CRM_ENTITY_TYPE"`
	CRMEntityID   b24.ID `json:"CRM_ENTITY_ID"`
	AssignedByID  b24.ID `json:"ASSIGNED_BY_ID"`
	Name          string `json:"NAME"`
}
if err := json.Unmarshal(res.Result, &items); err != nil {
	return fmt.Errorf("разбор ответа: %w", err)
}
for _, it := range items {
	fmt.Println(it.CRMEntityType, it.CRMEntityID)
}

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

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

Превышен лимит на интенсивность запросов

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

Метод заблокирован из-за превышения лимита на ресурсоемкость запросов. Блокировка снимается автоматически через 10 минут

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

Публичная часть сайта закрыта. Чтобы открыть публичную часть сайта на коробочной установке отключите опцию «Временное закрытие публичной части сайта». Путь к настройке: Рабочий стол > Настройки > Настройки продукта > Настройки модулей > Главный модуль > Временное закрытие публичной части сайта

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