SMS xidmətlərinin ayarlarını əldə et

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

SMS xidmətlərinin parametrlərini qaytarır. Şifrələnmiş qoşulma sahələrinin dəyərləri maskalanmış şəkildə qaytarılır.

Avtorizasiya

api-token + language + role

Sorğu parametrləri

branch_idinteger

Nümunə: 1

Cavablar

object

statusstringmütləq

Dəyərlər:successerror

Nümunə: success

dataobject

filtersobjectmütləq

branch_idobject (FilterSelectInteger)

valueinteger

Nümunə: 8920

typestringmütləq

Nümunə: select

optionarray of object

valueintegermütləq

Nümunə: 8920

namestringmütləq

Nümunə: Green Basket | Kaliningrad

modestring (FilterMode)

İnterfeys filtrin işlənməsini belə idarə edir: adi filtrdə mode yoxdur. force_shown — həmişə göstərilir, gizlədilə bilməz. value_required — bölməyə giriş nöqtəsidir: həmişə göstərilir, boş dəyəri olmur (dəyər seçilməyənə qədər siyahı boşdur; "hamısı" seçimi yoxdur), ümumi sıfırlama onu təmizləmir.

Dəyərlər:force_shownvalue_required

Nümunə: value_required

settingsobject

idintegermütləq

Nümunə: 1

namestring

Nümunə: google

service_enabledboolean

Nümunə: true

order_creation_notifications_channelstring

Dəyərlər:botdisabledexternal_smsinternal_sms

Nümunə: internal_sms

order_status_change_notifications_platformstring

Dəyərlər:alldisabledsite

Nümunə: site

authorization_force_code_enabledboolean

Nümunə: true

price_smsnumber

Bir SMS-in FoodSoul tərəfindən təyin olunan qiyməti; yalnız oxumaq üçün, tənzimləmə formasına daxil deyil

Nümunə: 3.5

listarray of object

idintegermütləq

Nümunə: 1

namestringmütləq

Nümunə: SMSRU

sitestring

Nümunə: https://paradox.am

wikistring

Nümunə: https://wiki.foodsoul.pro/i/513

fieldsarray of object

encryptedbooleanmütləq

Şifrələnmiş sahə; daxil etmək üçün "parol" tipli sahədən istifadə edin

Nümunə: true

namestringmütləq

Nümunə: source_number

valuestring

Nümunə: 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' => 'az', '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": "az", "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": "az", "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" } ] } ] } }