API

Отримати список інтеграцій з чатами

GET/api/crm/v2/integration_chatsv2
operationId: integrationChats.default

Повертає сервіси чатів. Для кожного сервісу передаються поля налаштувань, посилання на сайт і вікі, а також URL вебхука, створений для філії. Параметр branch_id обов’язковий.

Авторизація

api-token + language + role

Параметри запиту

branch_idinteger

Приклад: 1

Відповіді

OK

object
statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject
filtersobjectобов’язковий
branch_idobject (FilterSelectInteger)
valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object
valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

settingsobject
idintegerобов’язковий

Приклад: 1

namestringобов’язковий

Приклад: google

chat_enabledboolean

Приклад: true

listarray of object
idintegerобов’язковий

Приклад: 1

namestringобов’язковий

Приклад: Google

system_namestring

Приклад: Google

sitestringобов’язковий

Приклад: https://developer.tech.yandex.ru

wikistring

Приклад: https://wiki.foodsoul.pro/i/97

fieldsarray of objectобов’язковий
encryptedbooleanобов’язковий

Зашифроване поле; для введення використовуйте поле типу «пароль»

Приклад: true

namestringобов’язковий

Приклад: api_key

valuestring

Приклад: secretkey

webhookstringобов’язковий

Приклад: https://ru.foodsoul.test/webhook/chat/verbox/?token=f20138c54eaaad6c00ac77d27b2f4cb4