Find a Client in CRM by Phone Number telephony.externalCall.searchCrmEntities

Scope: telephony

Who 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 `type`	Description
PHONE_NUMBER* `string`	The client's phone number

Code Examples

How to Use Examples in Documentation

cURL (Webhook)

cURL (OAuth)

PHP

BX24.js

PHP CRest

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

try
        {
            const response = await $b24.callMethod(
                'telephony.externalCall.searchCrmEntities',
                {
                    PHONE_NUMBER: '19062195047'
                }
            );
            
            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' => '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 `type`	Description
result `array`	An array of found CRM entities
CRM_ENTITY_TYPE `string`	Type of the CRM entity. Possible values: `CONTACT` — contact `LEAD` — lead `COMPANY` — company
CRM_ENTITY_ID `integer`	Identifier of the CRM entity
ASSIGNED_BY_ID `integer`	Identifier of the responsible employee
NAME `string`	Name or full name of the found CRM entity
ASSIGNED_BY `object`	Data of the responsible employee
time `time`	Information about the request execution time

ASSIGNED_BY Object

Name `type`	Description
ID `integer`	Identifier of the employee
TIMEMAN_STATUS `string`	Status of the employee's working time. Possible values: `OPENED` — workday started `CLOSED` — workday ended `PAUSED` — break `EXPIRED` — workday expired `UNAVAILABLE` — time tracking is disabled for the employee `NOT_INSTALLED` — time tracking module is not installed
USER_PHONE_INNER `string`	Employee's internal number
WORK_PHONE `string`	Employee's work phone
PERSONAL_PHONE `string`	Employee's personal phone
PERSONAL_MOBILE `string`	Employee's mobile phone

Error Handling

HTTP Status: 400

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

Name `type`	Description
error `string`	String error code. It may consist of digits, Latin letters, and underscores
error_description `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
`ERROR_CORE`	PHONE_NUMBER is empty	The required parameter `PHONE_NUMBER` was not provided
`ERROR_CORE`	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 Error Message	Description
`500`	`INTERNAL_SERVER_ERROR` Internal server error	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`500`	`ERROR_UNEXPECTED_ANSWER` Server returned an unexpected response	An internal server error has occurred, please contact the server administrator or Bitrix24 technical support
`503`	`QUERY_LIMIT_EXCEEDED` Too many requests	The request intensity limit has been exceeded
`405`	`ERROR_BATCH_METHOD_NOT_ALLOWED` Method is not allowed for batch usage	The current method is not allowed to be called using batch
`400`	`ERROR_BATCH_LENGTH_EXCEEDED` Max batch length exceeded	The maximum length of parameters passed to the batch method has been exceeded
`401`	`NO_AUTH_FOUND` Wrong authorization data	Invalid access token or webhook code
`400`	`INVALID_REQUEST` Https required	The methods must be called using the HTTPS protocol
`503`	`OVERLOAD_LIMIT` REST API is blocked due to overload	The REST API is blocked due to overload. This is a manual individual block, to remove it you need to contact Bitrix24 technical support
`403`	`ACCESS_DENIED` REST API is available only on commercial plans	The REST API is available only on commercial plans
`403`	`INVALID_CREDENTIALS` Invalid request credentials	The user whose access token or webhook was used to call the method lacks permissions
`404`	`ERROR_MANIFEST_IS_NOT_AVAILABLE` Manifest is not available	The manifest is not available
`403`	`insufficient_scope` The request requires higher privileges than provided by the webhook token	The request requires higher privileges than those provided by the webhook token
`401`	`expired_token` The access token provided has expired	The provided access token has expired
`403`	`user_access_error` The user does not have access to the application	The user does not have access to the application. This means that the application is installed, but the account administrator has allowed access to this application only for specific users
`500`	`PORTAL_DELETED` Portal was deleted	The public part of the site is closed. To open the public part of the site on an on-premise installation, disable the option "Temporary closure of the public part of the site". Path to the setting: Desktop > Settings > Product Settings > Module Settings > Main Module > Temporary closure of the public part of the site

Continue Learning

Delete an External Line

Find a Client in CRM by Phone Number telephony.externalCall.searchCrmEntities

Method ParametersMethod Parameters

Code ExamplesCode Examples

Response HandlingResponse Handling

Returned DataReturned Data

ASSIGNED_BY ObjectASSIGNED_BY Object

Error HandlingError Handling

Possible Error CodesPossible Error Codes

Statuses and System Error CodesStatuses and System Error Codes

Continue LearningContinue Learning