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

Choose a tool for developing with an AI agent:

  • use Alaio Vibecode to build an app for Bitrix24 from a task description without knowing any programming language. The agent writes the code and deploys the app to a server, with no manual hosting setup
  • use the MCP server to develop a REST API integration in your own project. The agent refers to the official REST documentation

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 -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>
        
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 error",
                f"error: {error.error}",
                f"error_description: {error.error_description}",
                sep="\n",
            )
        except BitrixSDKException as error:
            print(f"Bitrix SDK error: {error.message}")
        except Exception as error:
            print(f"Unexpected 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>';
        
// client and ctx are already created — see the Go SDK section
        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("parse response: %w", err)
        }
        for _, it := range items {
        	fmt.Println(it.CRMEntityType, it.CRMEntityID)
        }
        

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 object.

Possible values:

  • CONTACT — contact
  • LEAD — lead
  • COMPANY — company

CRM_ENTITY_ID
integer

Identifier of the CRM object

ASSIGNED_BY_ID
integer

Identifier of the responsible employee

NAME
string

Name or full name of the found CRM object

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 consists of digits, Latin letters, and underscores. It may arrive empty — in that case only error_description shows the reason

error_description
string

Error message for the developer. Do not show it to the end user without processing

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: 4xx, 5xx

The errors described below are returned by the REST API itself, not by the logic of a specific method. They can arrive in response to any method.

Status

Code
Error Message

Description

500

INTERNAL_SERVER_ERROR
Internal server error

An internal server error has occurred. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

500

ERROR_UNEXPECTED_ANSWER
Server returned an unexpected response

The server returned an unexpected response. Retry the call, and if the error persists, contact the server administrator or Bitrix24 technical support

503

QUERY_LIMIT_EXCEEDED
Too many requests

The request intensity limit has been exceeded

429

OPERATION_TIME_LIMIT
Method is blocked due to operation time limit

The method is blocked because the request resource intensity limit has been exceeded. The block is lifted automatically once the accumulated execution time of the method no longer exceeds the limit

401

NO_AUTH_FOUND
Wrong authorization data

The request contains no authorization data: neither an access token nor a webhook code was passed

401

INVALID_REQUEST
Https required

Methods are called over the HTTPS protocol only

401

OVERLOAD_LIMIT
REST API is blocked due to overload

The REST API is blocked due to overload. This is a manual individual block. To have it lifted, contact Bitrix24 technical support

401

ACCESS_DENIED
REST is available only on commercial plans

REST API access is not active for this account. In Bitrix24 Cloud, check the current plan or trial status: Vibe+ plans include REST API access, while Essentials plans do not. A webhook receives a different error message — REST is available only by subscription

401

INVALID_CREDENTIALS
Invalid request credentials

No active webhook with the specified user identifier and secret code was found

404

ERROR_METHOD_NOT_FOUND
Method not found!

No method with this name was found. The name is misspelled, the method does not exist in the REST API, or it is unavailable without the required scope

401

insufficient_scope
The request requires higher privileges than provided by the webhook token

The request requires broader permissions than the token has: for a webhook these are the permissions granted to it, for an application it is the scope. For an application, the error message ends with provided by the access token

401

expired_token
The access token provided has expired

The access token has expired

401

user_access_error
The user does not have access to the application

The application is installed, but the Bitrix24 administrator has granted access to it only to specific users

403

PORTAL_DELETED
Portal was deleted

The public part of the site is closed. To open it 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

Continue Learning