Saņemt SMS pakalpojumu iestatījumus

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Atgriež SMS pakalpojumu iestatījumus. Šifrētie pieslēguma lauku vērtības tiek atgrieztas maskētā veidā.

Autorizācija

api-token + language + role

Vaicājuma parametri

branch_idinteger

Piemērs: 1

Atbildes

object

statusstringobligāts

Vērtības:successerror

Piemērs: success

dataobject

filtersobjectobligāts

branch_idobject (FilterSelectInteger)

valueinteger

Piemērs: 8920

typestringobligāts

Piemērs: select

optionarray of object

valueintegerobligāts

Piemērs: 8920

namestringobligāts

Piemērs: Green Basket | Kaliningrad

modestring (FilterMode)

Kā interfeiss apstrādā filtru; parastam filtram nav mode. force_shown — vienmēr tiek rādīts, nevar paslēpt. value_required — sadaļas ieejas punkts: vienmēr tiek rādīts, nevar būt tukša vērtība (kamēr vērtība nav izvēlēta, saraksts ir tukšs; nav varianta "visi"), kopējā atiestatīšana to neiztīra.

Vērtības:force_shownvalue_required

Piemērs: value_required

settingsobject

idintegerobligāts

Piemērs: 1

namestring

Piemērs: google

service_enabledboolean

Piemērs: true

order_creation_notifications_channelstring

Vērtības:botdisabledexternal_smsinternal_sms

Piemērs: internal_sms

order_status_change_notifications_platformstring

Vērtības:alldisabledsite

Piemērs: site

authorization_force_code_enabledboolean

Piemērs: true

price_smsnumber

Vienas SMS cena, ko nosaka FoodSoul; tikai lasīšanai, nav iekļauta iestatījumu formā

Piemērs: 3.5

listarray of object

idintegerobligāts

Piemērs: 1

namestringobligāts

Piemērs: SMSRU

sitestring

Piemērs: https://paradox.am

wikistring

Piemērs: https://wiki.foodsoul.pro/i/513

fieldsarray of object

encryptedbooleanobligāts

Šifrēts lauks; ievadei izmantojiet lauku ar “paroles” tipu

Piemērs: true

namestringobligāts

Piemērs: source_number

valuestring

Piemērs: 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' => 'lv', '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": "lv", "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": "lv", "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" } ] } ] } }