Get a list of chat integrations

GET/api/crm/v2/integration_chatsv2

operationId: integrationChats.default

Returns chat services. For each service, the settings fields, website and wiki links, and the webhook URL created for the branch are provided. The branch_id parameter is required.

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobjectrequired

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

settingsobject

idintegerrequired

Example: 1

namestringrequired

Example: google

chat_enabledboolean

Example: true

listarray of object

idintegerrequired

Example: 1

namestringrequired

Example: Google

system_namestring

Example: Google

sitestringrequired

Example: https://developer.tech.yandex.ru

wikistring

Example: https://wiki.foodsoul.pro/i/97

fieldsarray of objectrequired

encryptedbooleanrequired

Encrypted field; use a password-type input field

Example: true

namestringrequired

Example: api_key

valuestring

Example: secretkey

webhookstringrequired

Example: 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' => 'en', '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": "en", "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": "en", "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" } ] } }