Liste der Chat-Integrationen abrufen

GET/api/crm/v2/integration_chatsv2

operationId: integrationChats.default

Gibt Chat-Services zurück. Für jeden Service werden die Einstellungsfelder, Links zur Website und Wiki sowie die für die Filiale erstellte Webhook-URL bereitgestellt. Der Parameter branch_id ist erforderlich.

Autorisierung

api-token + language + role

Abfrageparameter

branch_idinteger

Beispiel: 1

Antworten

object

statusstringerforderlich

Werte:successerror

Beispiel: success

dataobject

filtersobjecterforderlich

branch_idobject (FilterSelectInteger)

valueinteger

Beispiel: 8920

typestringerforderlich

Beispiel: select

optionarray of object

valueintegererforderlich

Beispiel: 8920

namestringerforderlich

Beispiel: Green Basket | Kaliningrad

modestring (FilterMode)

Wie das Interface den Filter verarbeitet; ein gewöhnlicher Filter hat kein mode.
force_shown — immer angezeigt, kann nicht ausgeblendet werden.
value_required — Einstiegspunkt in den Bereich: immer angezeigt, hat keinen leeren Wert (solange kein Wert ausgewählt ist, bleibt die Liste leer; es gibt keine „Alle“-Option), ein globales Zurücksetzen löscht ihn nicht.

Werte:force_shownvalue_required

Beispiel: value_required

settingsobject

idintegererforderlich

Beispiel: 1

namestringerforderlich

Beispiel: google

chat_enabledboolean

Beispiel: true

listarray of object

idintegererforderlich

Beispiel: 1

namestringerforderlich

Beispiel: Google

system_namestring

Beispiel: Google

sitestringerforderlich

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

wikistring

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

fieldsarray of objecterforderlich

encryptedbooleanerforderlich

Verschlüsseltes Feld; verwenden Sie für die Eingabe ein Feld vom Typ „Passwort“

Beispiel: true

namestringerforderlich

Beispiel: api_key

valuestring

Beispiel: secretkey

webhookstringerforderlich

Beispiel: https://ru.foodsoul.test/webhook/chat/verbox/?token=f20138c54eaaad6c00ac77d27b2f4cb4

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

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

import requests response = requests.request( "GET", "https://foodsoul.ru/api/crm/v2/integration_chats", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "de", "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" } ] } }