Теги

Теги в API Radist.Online: создание, изменение и удаление тегов компании, цвет и описание, фильтрация контактов по тегам.

Общее

Swagger: https://api.radist.online/v2/docs#/Tags

Необходимые права доступа (scopes) для работы с API: messaging

Тег — метка компании, которую можно проставить контакту: короткое название, описание и цвет. Теги общие на всю компанию, у одного контакта их может быть сколько угодно.

Поля тега:

• name — название, от 1 до 15 символов. Уникально в пределах компании и регистрозависимо: VIP и vip — два разных тега.
• description — описание, до 256 символов. Необязательное, по умолчанию пустая строка.
• background_color — цвет фона в формате #rrggbb, например #ff8800. По умолчанию #eeeeee.

Проставить теги контакту можно методом PUT /companies/{company_id}/contacts/{contact_id}/tags/, отфильтровать контакты по тегам — параметром tags в списке контактов.

Список тегов

TagsListTags (GET /companies/{company_id}/tags/)

Все теги компании, отсортированные по id. Параметры offset и limit (от 1 до 100, по умолчанию 100) — для постраничного вывода.

Один тег можно получить методом TagsGetTag (GET /companies/{company_id}/tags/{tag_id}). Если тега с таким id в компании нет, методы вернут 404 с ошибкой 3000 (TAG_NOT_FOUND).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19

GET /companies/{company_id}/tags/

Response
[
  {
    "id": 12,
    "company_id": 5,
    "name": "VIP",
    "description": "Постоянный клиент",
    "background_color": "#eeeeee"
  },
  {
    "id": 13,
    "company_id": 5,
    "name": "Не дозвонились",
    "description": "",
    "background_color": "#ff8800"
  }
]

Создание тега

TagsCreateTag (POST /companies/{company_id}/tags/)

Обязательно только name. Если тег с таким названием в компании уже есть, метод вернёт 409 с ошибкой 3001 (TAG_ALREADY_EXISTS).

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16

POST /companies/{company_id}/tags/
{
  "name": "Не дозвонились",
  "description": "",
  "background_color": "#ff8800"
}


Response
{
  "id": 13,
  "company_id": 5,
  "name": "Не дозвонились",
  "description": "",
  "background_color": "#ff8800"
}

Изменение тега

TagsUpdateTag (PUT /companies/{company_id}/tags/{tag_id})

Все три поля — name, description и background_color — обязательны: тег перезаписывается целиком. Чтобы изменить только цвет, передайте вместе с ним текущие название и описание.

Проверка на уникальность названия та же, что и при создании: конфликт вернётся как 409 с ошибкой 3001 (TAG_ALREADY_EXISTS).

Удаление тега

TagsDeleteTag (DELETE /companies/{company_id}/tags/{tag_id})

Удаляет тег и снимает его со всех контактов компании. В ответ приходит 204 No Content.