Hangi SMS-teenuste seaded

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Tagastab SMS-teenuste seaded. Krüpteeritud ühenduseväljade väärtused tagastatakse maskeeritult.

Autoriseerimine

api-token + language + role

Päringu parameetrid

branch_idinteger

Näide: 1

Vastused

object

statusstringkohustuslik

Väärtused:successerror

Näide: success

dataobject

filtersobjectkohustuslik

branch_idobject (FilterSelectInteger)

valueinteger

Näide: 8920

typestringkohustuslik

Näide: select

optionarray of object

valueintegerkohustuslik

Näide: 8920

namestringkohustuslik

Näide: Green Basket | Kaliningrad

modestring (FilterMode)

Kuidas liides töötleb filtrit; tavalisel filtril pole mode. force_shown — alati kuvatud, peita ei saa. value_required — sektsiooni sisenemispunkt: alati kuvatud, ei saa olla tühja väärtust (kuni väärtus pole valitud, loend on tühi; valikut „kõik” pole), üldine lähtestamine seda ei tühjenda.

Väärtused:force_shownvalue_required

Näide: value_required

settingsobject

idintegerkohustuslik

Näide: 1

namestring

Näide: google

service_enabledboolean

Näide: true

order_creation_notifications_channelstring

Väärtused:botdisabledexternal_smsinternal_sms

Näide: internal_sms

order_status_change_notifications_platformstring

Väärtused:alldisabledsite

Näide: site

authorization_force_code_enabledboolean

Näide: true

price_smsnumber

Ühe SMS-i hind, mille määrab FoodSoul; ainult lugemiseks, ei kuulu seadete vormi

Näide: 3.5

listarray of object

idintegerkohustuslik

Näide: 1

namestringkohustuslik

Näide: SMSRU

sitestring

Näide: https://paradox.am

wikistring

Näide: https://wiki.foodsoul.pro/i/513

fieldsarray of object

encryptedbooleankohustuslik

Krüpteeritud väli; sisestamiseks kasutage parooli tüüpi välja

Näide: true

namestringkohustuslik

Näide: source_number

valuestring

Näide: 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' => 'et', '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": "et", "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": "et", "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" } ] } ] } }