Получить список интеграций с чатами

GET/api/crm/v2/integration_chatsv2

operationId: integrationChats.default

Возвращает сервисы чатов. Для каждого сервиса передаются поля настроек, ссылки на сайт и вики и URL вебхука, созданный для филиала. Параметр branch_id обязателен.

Авторизация

api-token + language + role

Параметры запроса

branch_idinteger

Пример: 1

Ответы

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

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/integration_chats', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'ru', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/integration_chats", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/integration_chats", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "ru", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "branch_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" } }, "settings": { "id": 1, "name": "google", "chat_enabled": true }, "list": [ { "id": 1, "name": "Google", "system_name": "Google", "site": "https://developer.tech.yandex.ru", "wiki": "https://wiki.foodsoul.pro/i/97", "fields": [ { "encrypted": true, "name": "api_key", "value": "secretkey" } ], "webhook": "https://ru.foodsoul.test/webhook/chat/verbox/?token=f20138c54eaaad6c00ac77d27b2f4cb4" } ] } }