Find a Client in CRM by Phone Number telephony.externalCall.searchCrmEntities
If you are developing integrations for Bitrix24 using AI tools (Codex, Claude Code, Cursor), connect to the MCP server so that the assistant can utilize the official REST documentation.
Scope:
telephonyWho can execute the method: any user
The method telephony.externalCall.searchCrmEntities returns CRM entities based on the client's phone number and the details of the responsible employee.
Method Parameters
Required parameters are marked with *
|
Name |
Description |
|
PHONE_NUMBER* |
The client's phone number |
Code Examples
How to Use Examples in Documentation
curl -X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"PHONE_NUMBER":"19062195047"}' \
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":"19062195047","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 object 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>
try {
$response = $b24Service
->core
->call(
'telephony.externalCall.searchCrmEntities',
[
'PHONE_NUMBER' => '19062195047'
]
);
$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: '19062195047'
},
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' => '19062195047'
]
);
echo '<PRE>';
print_r($result);
echo '</PRE>';
Response Handling
HTTP Status: 200
{
"result": [
{
"CRM_ENTITY_TYPE": "CONTACT",
"CRM_ENTITY_ID": 651,
"ASSIGNED_BY_ID": 99,
"NAME": "John Doe",
"ASSIGNED_BY": {
"ID": "99",
"TIMEMAN_STATUS": "CLOSED",
"USER_PHONE_INNER": null,
"WORK_PHONE": null,
"PERSONAL_PHONE": null,
"PERSONAL_MOBILE": "19062195047"
}
},
{
"CRM_ENTITY_TYPE": "COMPANY",
"CRM_ENTITY_ID": 643,
"ASSIGNED_BY_ID": 99,
"NAME": "Daisy LLC",
"ASSIGNED_BY": {
"ID": "99",
"TIMEMAN_STATUS": "CLOSED",
"USER_PHONE_INNER": null,
"WORK_PHONE": null,
"PERSONAL_PHONE": null,
"PERSONAL_MOBILE": "19062195047"
}
}
],
"time": {
"start": 1772808159,
"finish": 1772808159.397228,
"duration": 0.3972280025482178,
"processing": 0,
"date_start": "2026-03-06T17:42:39+02:00",
"date_finish": "2026-03-06T17:42:39+02:00",
"operating_reset_at": 1772808759,
"operating": 0.25037074089050293
}
}
Returned Data
|
Name |
Description |
|
result |
An array of found CRM entities |
|
CRM_ENTITY_TYPE |
Type of the CRM object. Possible values:
|
|
CRM_ENTITY_ID |
Identifier of the CRM object |
|
ASSIGNED_BY_ID |
Identifier of the responsible employee |
|
NAME |
Name or full name of the found CRM object |
|
ASSIGNED_BY |
Data of the responsible employee |
|
time |
Information about the request execution time |
ASSIGNED_BY Object
|
Name |
Description |
|
ID |
Identifier of the employee |
|
TIMEMAN_STATUS |
Status of the employee's working time. Possible values:
|
|
USER_PHONE_INNER |
Employee's internal number |
|
WORK_PHONE |
Employee's work phone |
|
PERSONAL_PHONE |
Employee's personal phone |
|
PERSONAL_MOBILE |
Employee's mobile phone |
Error Handling
HTTP Status: 400
{
"error": "ERROR_CORE",
"error_description": "PHONE_NUMBER is empty"
}
|
Name |
Description |
|
error |
String error code. It may consist of digits, Latin letters, and underscores |
|
error_description |
Textual description of the error. The description is not intended to be shown to the end user in its raw form |
Possible Error Codes
|
Code |
Description |
Value |
|
|
PHONE_NUMBER is empty |
The required parameter |
|
|
CRM is not installed. |
The CRM module is not installed on the account |
Statuses and System Error Codes
HTTP Status: 20x, 40x, 50x
The errors described below may occur when calling any method.
|
Status |
Code |
Description |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
An internal server error has occurred. Please contact the server administrator or Bitrix24 technical support |
|
|
|
The request intensity limit has been exceeded |
|
|
|
The current method is not permitted for calls using batch |
|
|
|
The maximum length of parameters passed to the batch method has been exceeded |
|
|
|
Invalid access token or webhook code |
|
|
|
The HTTPS protocol is required for method calls |
|
|
|
The REST API is blocked due to overload. This is a manual individual block; please contact Bitrix24 technical support to lift it |
|
|
|
The REST API is only available on commercial plans |
|
|
|
The user associated with the access token or webhook used to call the method lacks the necessary permissions |
|
|
|
The manifest is not available |
|
|
|
The request requires higher privileges than those provided by the webhook token |
|
|
|
The provided access token has expired |
|
|
|
The user does not have access to the application. This means that the application is installed, but the portal administrator has restricted access to this application to specific users only |
|
|
|
The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the "Temporary closure of the public part of the site" option. Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site |