Отримати налаштування SMS-сервісів

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Повертає налаштування SMS-сервісів. Зашифровані значення полів підключення повертаються замаскованими.

Авторизація

api-token + language + role

Параметри запиту

branch_idinteger

Приклад: 1

Відповіді

object

statusstringобов’язковий

Значення:successerror

Приклад: success

dataobject

filtersobjectобов’язковий

branch_idobject (FilterSelectInteger)

valueinteger

Приклад: 8920

typestringобов’язковий

Приклад: select

optionarray of object

valueintegerобов’язковий

Приклад: 8920

namestringобов’язковий

Приклад: Green Basket | Kaliningrad

modestring (FilterMode)

Як інтерфейс обробляє фільтр; у звичайного фільтра mode немає. force_shown — завжди відображається, приховати не можна. value_required — точка входу в розділ: завжди відображається, не має порожнього значення (поки значення не вибрано, список порожній; варіанту «всі» немає), загальне скидання його не очищає.

Значення:force_shownvalue_required

Приклад: value_required

settingsobject

idintegerобов’язковий

Приклад: 1

namestring

Приклад: google

service_enabledboolean

Приклад: true

order_creation_notifications_channelstring

Значення:botdisabledexternal_smsinternal_sms

Приклад: internal_sms

order_status_change_notifications_platformstring

Значення:alldisabledsite

Приклад: site

authorization_force_code_enabledboolean

Приклад: true

price_smsnumber

Ціна одного SMS, встановлена FoodSoul; лише для читання, не входить у форму налаштувань

Приклад: 3.5

listarray of object

idintegerобов’язковий

Приклад: 1

namestringобов’язковий

Приклад: SMSRU

sitestring

Приклад: https://paradox.am

wikistring

Приклад: https://wiki.foodsoul.pro/i/513

fieldsarray of object

encryptedbooleanобов’язковий

Зашифроване поле; для введення використовуйте поле типу «пароль»

Приклад: true

namestringобов’язковий

Приклад: source_number

valuestring

Приклад: 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' => 'uk', '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": "uk", "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": "uk", "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" } ] } ] } }