Gauti SMS paslaugų nustatymus

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Grąžina SMS paslaugų nustatymus. Užšifruotų prisijungimo laukų reikšmės grąžinamos užmaskuotos.

Autorizacija

api-token + language + role

Užklausos parametrai

branch_idinteger

Pavyzdys: 1

Atsakymai

object

statusstringprivalomas

Reikšmės:successerror

Pavyzdys: success

dataobject

filtersobjectprivalomas

branch_idobject (FilterSelectInteger)

valueinteger

Pavyzdys: 8920

typestringprivalomas

Pavyzdys: select

optionarray of object

valueintegerprivalomas

Pavyzdys: 8920

namestringprivalomas

Pavyzdys: Green Basket | Kaliningrad

modestring (FilterMode)

Kaip sąsaja apdoroja filtrą; paprastam filtrui mode nėra. force_shown — visada rodomas, paslėpti negalima. value_required — įėjimo taškas į skyrių: visada rodomas, neturi tuščios reikšmės (kol reikšmė nepasirinkta, sąrašas tuščias; varianto „visi“ nėra), bendras atstatymas jo neišvalo.

Reikšmės:force_shownvalue_required

Pavyzdys: value_required

settingsobject

idintegerprivalomas

Pavyzdys: 1

namestring

Pavyzdys: google

service_enabledboolean

Pavyzdys: true

order_creation_notifications_channelstring

Reikšmės:botdisabledexternal_smsinternal_sms

Pavyzdys: internal_sms

order_status_change_notifications_platformstring

Reikšmės:alldisabledsite

Pavyzdys: site

authorization_force_code_enabledboolean

Pavyzdys: true

price_smsnumber

Vienos SMS kaina, nustatyta FoodSoul; tik skaitymui, nėra nustatymų formoje

Pavyzdys: 3.5

listarray of object

idintegerprivalomas

Pavyzdys: 1

namestringprivalomas

Pavyzdys: SMSRU

sitestring

Pavyzdys: https://paradox.am

wikistring

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

fieldsarray of object

encryptedbooleanprivalomas

Užšifruotas laukas; įvedimui naudokite „slaptažodžio“ tipo lauką

Pavyzdys: true

namestringprivalomas

Pavyzdys: source_number

valuestring

Pavyzdys: 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' => 'lt', '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": "lt", "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": "lt", "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" } ] } ] } }