Метод getTags

Получение списка тегов для сущности AmoCRM

Реализуемый метод API

GET /api/v4/{entity_type:leads|contacts|companies|customers}/tags

Официальная документация метода

Описание

Метод позволяет получить список тегов для сущности в аккаунте.
Справочник тегов разделен по сущностям, то есть тег с одним названием будет иметь различные ID в разных типах сущностей
Цвет тегов доступен только для тегов сделок
Цвет тегов доступен только с обновления Весна 2022
Функционал тегов доступен для следующих сущностей: сделки, контакты, компании и покупатели

Ограничения

Метод доступен в соответствии с правами пользователя.
Метод возвращает за раз максимум 250 тегов. Учитывайте это, если в Вашей AmoCRM больше 250 тегов.

Параметры

Name	Type	Description
`$entity_type`	string	Тип сущности, для которой запрашиваются теги. Возможные значения leads contacts companies customers Значение по умолчанию - leads.
`$data`	array	GET параметры запроса согласно официальной документации метода. `page` int Страница выборки `limit` int Количество возвращаемых сущностей за один запрос (Максимум – 250) `filter` object Фильтр `filter[name]` string Фильтр по точному названию тега. Можно передать только одно название `filter[id]` int\|array Фильтр по ID тега. Можно передать как один ID, так и массив из нескольких ID `query` string Позволяет осуществить полнотекстовый поиск по названию тега

Возвращаемые значения

HTTP 200 Успешный ответ

Возвращаемое значение соответствует документации AmoCRM для этого метода.

Пример ответа

Пример ответа AmoCRM на запрос списка тегов для сущности сделки:

stdClass Object
(
    [_page] => 1
    [_links] => stdClass Object
        (
            [self] => stdClass Object
                (
                    [href] => https://yoursubdomain.amocrm.ru/api/v4/leads/tags/?limit=50&page=1
                )

        )

    [_embedded] => stdClass Object
        (
            [tags] => Array
                (
                    [0] => stdClass Object
                        (
                            [id] => 221687
                            [name] => тест
                            [color] => 
                        )

                    [1] => stdClass Object
                        (
                            [id] => 221689
                            [name] => тест 2 
                            [color] => 
                        )

                    [2] => stdClass Object
                        (
                            [id] => 221691
                            [name] => тест 43
                            [color] => 
                        )

                )

        )

)

HTTP 40x Неудачный ответ

Официальная документация говорит о возможном коде ответа 401 Пользователь не авторизован. Библиотека WT Amocrm возвращает объект ошибки следующей структуры:

stdClass Object
(
    [error_code] => 404
    [error_message] => getTags function: Error while trying to get tag(s) from Amo CRM. Amo CRM API response: <b>title</b>: Not Found
<b>type</b>: https://httpstatus.es/404
<b>status</b>: 404
<b>detail</b>: Cannot GET https://infowebtolkru.amocrm.ru/leadss/tags?limit%5B0%5D=250!

)

Пример использования в коде

use Webtolk\Amocrm\Amocrm;	

$limit = 78;
$requset_options = [
	'limit' = (((int) $limit > 250) ? 250 : $limit)
];

$amocrm = new Amocrm();
$result_amo_crm = $amocrm->getTags('leads',$requset_options);