Získat nastavení SMS služeb

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Vrací nastavení SMS služeb. Šifrované hodnoty připojovacích polí jsou vráceny zamaskované.

Autorizace

api-token + language + role

Parametry dotazu

branch_idinteger

Příklad: 1

Odpovědi

object

statusstringpovinné

Hodnoty:successerror

Příklad: success

dataobject

filtersobjectpovinné

branch_idobject (FilterSelectInteger)

valueinteger

Příklad: 8920

typestringpovinné

Příklad: select

optionarray of object

valueintegerpovinné

Příklad: 8920

namestringpovinné

Příklad: Green Basket | Kaliningrad

modestring (FilterMode)

Jak rozhraní zpracovává filtr; běžný filtr nemá mode. force_shown — vždy zobrazen, nelze skrýt. value_required — vstupní bod do sekce: vždy zobrazen, nemůže mít prázdnou hodnotu (dokud není vybrána hodnota, seznam je prázdný; varianta „vše“ není k dispozici), globální reset jej nevymaže.

Hodnoty:force_shownvalue_required

Příklad: value_required

settingsobject

idintegerpovinné

Příklad: 1

namestring

Příklad: google

service_enabledboolean

Příklad: true

order_creation_notifications_channelstring

Hodnoty:botdisabledexternal_smsinternal_sms

Příklad: internal_sms

order_status_change_notifications_platformstring

Hodnoty:alldisabledsite

Příklad: site

authorization_force_code_enabledboolean

Příklad: true

price_smsnumber

Cena jedné SMS, nastavená v FoodSoul; pouze pro čtení, není součástí konfiguračního formuláře

Příklad: 3.5

listarray of object

idintegerpovinné

Příklad: 1

namestringpovinné

Příklad: SMSRU

sitestring

Příklad: https://paradox.am

wikistring

Příklad: https://wiki.foodsoul.pro/i/513

fieldsarray of object

encryptedbooleanpovinné

Šifrované pole; pro zadání použijte pole typu „heslo“

Příklad: true

namestringpovinné

Příklad: source_number

valuestring

Příklad: secretkey

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

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

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