Получить набор контактов, связанных с указанной компанией crm.company.contact.items.get

Scope: crm

Кто может выполнять метод: пользователь с правом «Чтение» компаний

Метод crm.company.contact.items.get возвращает набор контактов, связанных с указанной компанией.

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

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

Название
тип

Описание

id*
integer

Идентификатор компании.

Идентификатор можно получить с помощью методов crm.company.list или crm.company.add

Примеры кода

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

curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":32}' \
        https://**put_your_bitrix24_address**/rest/**put_your_user_id_here**/**put_your_webhook_here**/crm.company.contact.items.get
        
curl -X POST \
        -H "Content-Type: application/json" \
        -H "Accept: application/json" \
        -d '{"id":32,"auth":"**put_access_token_here**"}' \
        https://**put_your_bitrix24_address**/rest/crm.company.contact.items.get
        
try
        {
        	const response = await $b24.callMethod(
        		'crm.company.contact.items.get',
        		{
        			id: 32,
        		}
        	);
        	
        	const result = response.getData().result;
        	result.error()
        		? console.error(result.error())
        		: console.info(result)
        	;
        }
        catch( error )
        {
        	console.error('Error:', error);
        }
        
try {
            $response = $b24Service
                ->core
                ->call(
                    'crm.company.contact.items.get',
                    [
                        'id' => 32,
                    ]
                );
        
            $result = $response
                ->getResponseData()
                ->getResult();
        
            if ($result->error()) {
                echo 'Error: ' . $result->error();
            } else {
                echo 'Data: ' . print_r($result->data(), true);
            }
        
        } catch (Throwable $e) {
            error_log($e->getMessage());
            echo 'Error getting company contact items: ' . $e->getMessage();
        }
        
BX24.callMethod(
            'crm.company.contact.items.get',
            {
                id: 32,
            },
            (result) => {
                result.error()
                    ? console.error(result.error())
                    : console.info(result.data())
                ;
            },
        );
        
require_once('crest.php');
        
        $result = CRest::call(
            'crm.company.contact.items.get',
            [
                'id' => 32
            ]
        );
        
        echo '<PRE>';
        print_r($result);
        echo '</PRE>';

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

HTTP-статус: 200

{
            "result": [
                {
                "CONTACT_ID": 7,
                "SORT": 100,
                "ROLE_ID": 0,
                "IS_PRIMARY": "Y"
                },
                {
                "CONTACT_ID": 8,
                "SORT": 110,
                "ROLE_ID": 0,
                "IS_PRIMARY": "N"
                },
                {
                "CONTACT_ID": 9,
                "SORT": 120,
                "ROLE_ID": 0,
                "IS_PRIMARY": "N"
                }
            ],
            "time": {
                "start": 1724078791.470108,
                "finish": 1724078791.969407,
                "duration": 0.4992990493774414,
                "processing": 0.19150400161743164,
                "date_start": "2024-08-19T16:46:31+02:00",
                "date_finish": "2024-08-19T16:46:31+02:00"
            }
        }

Возвращаемые данные

Название
тип

Описание

result
company_contact_binding[]

Корневой элемент ответа. Содержит массив с информацией о привязанных к компании контактах

time
time

Информация о времени выполнения запроса

Параметр company_contact_binding

Название
тип

Описание

CONTACT_ID
integer

Идентификатор контакта

SORT
integer

Индекс сортировки

ROLE_ID
integer

Идентификатор роли, служебное поле

IS_PRIMARY
char

Является ли привязка первичной. Возможные значения:

  • Y — да
  • N — нет

Обработка ошибок

HTTP-статус: 400

{
            "error": "",
            "error_description": "The parameter ownerEntityID is invalid or not defined."
        }

Название
тип

Описание

error
string

Строковый код ошибки. Может состоять из цифр, латинских букв и знака подчеркивания

error_description
error_description

Текстовое описание ошибки. Описание не предназначено для показа конечному пользователю в необработанном виде

Возможные коды ошибок

Код

Описание

Значение

-

The parameter ownerEntityID is invalid or not defined

Передан id меньше или равен 0 или не передан вовсе

ACCESS_DENIED

Access denied!

У пользователя нет прав на чтение компаний

Статусы и коды системных ошибок

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

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

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

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

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

Предыдущая
Очистить набор контактов
Следующая
Установить набор контактов