SMS-Dienst-Einstellungen abrufen

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Gibt die Einstellungen der SMS-Dienste zurück. Verschlüsselte Verbindungsfelder werden maskiert zurückgegeben.

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

namestring

Beispiel: google

service_enabledboolean

Beispiel: true

order_creation_notifications_channelstring

Werte:botdisabledexternal_smsinternal_sms

Beispiel: internal_sms

order_status_change_notifications_platformstring

Werte:alldisabledsite

Beispiel: site

authorization_force_code_enabledboolean

Beispiel: true

price_smsnumber

Preis einer einzelnen SMS, festgelegt von FoodSoul; schreibgeschützt, nicht im Einstellungsformular enthalten

Beispiel: 3.5

listarray of object

idintegererforderlich

Beispiel: 1

namestringerforderlich

Beispiel: SMSRU

sitestring

Beispiel: https://paradox.am

wikistring

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

fieldsarray of object

encryptedbooleanerforderlich

Verschlüsseltes Feld; verwenden Sie ein Passwortfeld für die Eingabe

Beispiel: true

namestringerforderlich

Beispiel: source_number

valuestring

Beispiel: secretkey

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

const response = await fetch("https://foodsoul.pro/api/crm/v2/integration_sms", { 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.pro/api/crm/v2/integration_sms", 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", "service_enabled": true, "order_creation_notifications_channel": "internal_sms", "order_status_change_notifications_platform": "site", "authorization_force_code_enabled": true }, "price_sms": 3.5, "list": [ { "id": 1, "name": "SMSRU", "site": "https://paradox.am", "wiki": "https://wiki.foodsoul.pro/i/513", "fields": [ { "encrypted": true, "name": "source_number", "value": "secretkey" } ] } ] } }