telephony.externalCall.searchCrmEntities
Найти клиента в CRM по номеру телефона
Описание
Метод 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
Информация о времени выполнения запроса
Обработка ошибок
HTTP-статус: 400
{
"error": "ERROR_CORE",
"error_description": "PHONE_NUMBER is empty"
}
| Код | Описание | Значение |
|---|---|---|
ERROR_CORE |
PHONE_NUMBER is empty | Не передан обязательный параметр PHONE_NUMBER |
ERROR_CORE |
CRM is not installed. | На портале не установлен модуль CRM |

