info@botvsem.ru

База знаний CleverApp ⤵

Теги

GET Получить список тегов бота

https://app.botvsem.ru/api/v1/getBotTags

!Как правильно сформировать запрос?! Смотрим в основах

Этот метод позволяет получить список всех тегов для определенного бота.

Request
Response

Path Parameters

bot_id

REQUIRED

string

ID бота

200: OK

Запрос успешно обработан.

"data": [
{
"id": 3,
"name": "Одежда"
},
{
"id": 2,
"name": "Акция"
},
{
"id": 1,
"name": "Горячий"
}
}

GET Получить список тегов контакта

https://app.botvsem.ru/api/v1/getContactTags

Этот метод позволяет получить список тегов контакта.

Request
Response

Path Parameters

contact_id

REQUIRED

string

ID контакта.

200: OK

Запрос успешно обработан.

{
"data": [
{
"id": 1,
"name": "Горячий"
},
{
"id": 2,
"name": "Ботинки"
}
]}

! Так же теги возможно получить со списком контактов, подробнее.

POST Привязать тег к контакту

https://app.botvsem.ru/api/v1/attachTagToContact

Этот метод позволяет привязать тег к контакту по id или имени тега.

Request
Response

Form Data Parameters

contact_id

REQUIRED

integer

ID контакта.

tag_id

OPTIONAL

integer

ID тега, если namе не указан.

name

OPTIONAL

string

Имя тега, если tag_id не указан. Если тега с таким именем не существует, то будет создан новый тег с таким именем.

204: No Content

Запрос успешно обработан.

POST Отвязать тег от контакта

https://app.botvsem.ru/api/v1/detachTagFromContact

Этот метод позволяет отвязать тег от контакта по id или имени тега.

Request
Response

Form Data Parameters

contact_id

REQUIRED

string

ID контакта.

tag_id

OPTIONAL

string

ID тега, если name не указан.

name

OPTIONAL

string

Имя тега, если tag_id не указан.

204: No Content

Запрос успешно обработан.

Оглавление