Ottenere le impostazioni dei servizi SMS

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Restituisce le impostazioni dei servizi SMS. I valori crittografati dei campi di connessione vengono restituiti mascherati.

Autorizzazione

api-token + language + role

Parametri della richiesta

branch_idinteger

Esempio: 1

Risposte

object

statusstringobbligatorio

Valori:successerror

Esempio: success

dataobject

filtersobjectobbligatorio

branch_idobject (FilterSelectInteger)

valueinteger

Esempio: 8920

typestringobbligatorio

Esempio: select

optionarray of object

valueintegerobbligatorio

Esempio: 8920

namestringobbligatorio

Esempio: Green Basket | Kaliningrad

modestring (FilterMode)

Come l'interfaccia gestisce il filtro; un filtro normale non ha mode.
force_shown — sempre visibile, non può essere nascosto.
value_required — punto di ingresso nella sezione: sempre visibile, non può avere valore vuoto (finché non viene selezionato un valore, la lista è vuota; non esiste l'opzione "tutti"), il reset generale non lo azzera.

Valori:force_shownvalue_required

Esempio: value_required

settingsobject

idintegerobbligatorio

Esempio: 1

namestring

Esempio: google

service_enabledboolean

Esempio: true

order_creation_notifications_channelstring

Valori:botdisabledexternal_smsinternal_sms

Esempio: internal_sms

order_status_change_notifications_platformstring

Valori:alldisabledsite

Esempio: site

authorization_force_code_enabledboolean

Esempio: true

price_smsnumber

Prezzo di un singolo SMS impostato da FoodSoul; sola lettura, non incluso nel modulo delle impostazioni

Esempio: 3.5

listarray of object

idintegerobbligatorio

Esempio: 1

namestringobbligatorio

Esempio: SMSRU

sitestring

Esempio: https://paradox.am

wikistring

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

fieldsarray of object

encryptedbooleanobbligatorio

Campo crittografato; per l'inserimento utilizzare un campo di tipo "password"

Esempio: true

namestringobbligatorio

Esempio: source_number

valuestring

Esempio: 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' => 'it', '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": "it", "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": "it", "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" } ] } ] } }