Get SMS service settings

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Returns SMS service settings. Encrypted connection field values are returned masked.

Authorization

api-token + language + role

Query parameters

branch_idinteger

Example: 1

Responses

object

statusstringrequired

Values:successerror

Example: success

dataobject

filtersobjectrequired

branch_idobject (FilterSelectInteger)

valueinteger

Example: 8920

typestringrequired

Example: select

optionarray of object

valueintegerrequired

Example: 8920

namestringrequired

Example: Green Basket | Kaliningrad

modestring (FilterMode)

How the interface handles the filter; a regular filter does not have mode.
force_shown — always displayed, cannot be hidden.
value_required — entry point to the section: always displayed, cannot have an empty value (until a value is selected, the list is empty; there is no "all" option), global reset does not clear it.

Values:force_shownvalue_required

Example: value_required

settingsobject

idintegerrequired

Example: 1

namestring

Example: google

service_enabledboolean

Example: true

order_creation_notifications_channelstring

Values:botdisabledexternal_smsinternal_sms

Example: internal_sms

order_status_change_notifications_platformstring

Values:alldisabledsite

Example: site

authorization_force_code_enabledboolean

Example: true

price_smsnumber

The price of a single SMS set by FoodSoul; read-only, not included in the settings form

Example: 3.5

listarray of object

idintegerrequired

Example: 1

namestringrequired

Example: SMSRU

sitestring

Example: https://paradox.am

wikistring

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

fieldsarray of object

encryptedbooleanrequired

Encrypted field; use a password-type input field for entry

Example: true

namestringrequired

Example: source_number

valuestring

Example: 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' => 'en', '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": "en", "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": "en", "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" } ] } ] } }