Pobierz ustawienia usług SMS

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Zwraca ustawienia serwisów SMS. Zaszyfrowane wartości pól połączenia są zwracane w postaci zamaskowanej.

Autoryzacja

api-token + language + role

Parametry zapytania

branch_idinteger

Przykład: 1

Odpowiedzi

object

statusstringwymagane

Wartości:successerror

Przykład: success

dataobject

filtersobjectwymagane

branch_idobject (FilterSelectInteger)

valueinteger

Przykład: 8920

typestringwymagane

Przykład: select

optionarray of object

valueintegerwymagane

Przykład: 8920

namestringwymagane

Przykład: Green Basket | Kaliningrad

modestring (FilterMode)

Jak interfejs obsługuje filtr; zwykły filtr nie ma mode. force_shown — zawsze widoczny, nie można ukryć. value_required — punkt wejścia do sekcji: zawsze widoczny, nie może mieć pustej wartości (dopóki wartość nie zostanie wybrana, lista jest pusta; nie ma opcji „wszystko”), ogólne resetowanie go nie czyści.

Wartości:force_shownvalue_required

Przykład: value_required

settingsobject

idintegerwymagane

Przykład: 1

namestring

Przykład: google

service_enabledboolean

Przykład: true

order_creation_notifications_channelstring

Wartości:botdisabledexternal_smsinternal_sms

Przykład: internal_sms

order_status_change_notifications_platformstring

Wartości:alldisabledsite

Przykład: site

authorization_force_code_enabledboolean

Przykład: true

price_smsnumber

Cena jednej wiadomości SMS, ustawiona przez FoodSoul; tylko do odczytu, nie jest częścią formularza ustawień

Przykład: 3.5

listarray of object

idintegerwymagane

Przykład: 1

namestringwymagane

Przykład: SMSRU

sitestring

Przykład: https://paradox.am

wikistring

Przykład: https://wiki.foodsoul.pro/i/513

fieldsarray of object

encryptedbooleanwymagane

Zaszyfrowane pole; do wprowadzania użyj pola typu „hasło”

Przykład: true

namestringwymagane

Przykład: source_number

valuestring

Przykład: 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' => 'pl', '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": "pl", "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": "pl", "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" } ] } ] } }