Obtenir les paramètres des services SMS

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Retourne les paramètres des services SMS. Les valeurs chiffrées des champs de connexion sont renvoyées masquées.

Autorisation

api-token + language + role

Paramètres de requête

branch_idinteger

Exemple: 1

Réponses

object

statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject

filtersobjectobligatoire

branch_idobject (FilterSelectInteger)

valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object

valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

settingsobject

idintegerobligatoire

Exemple: 1

namestring

Exemple: google

service_enabledboolean

Exemple: true

order_creation_notifications_channelstring

Valeurs:botdisabledexternal_smsinternal_sms

Exemple: internal_sms

order_status_change_notifications_platformstring

Valeurs:alldisabledsite

Exemple: site

authorization_force_code_enabledboolean

Exemple: true

price_smsnumber

Prix d’un SMS défini par FoodSoul ; en lecture seule, non inclus dans le formulaire de configuration

Exemple: 3.5

listarray of object

idintegerobligatoire

Exemple: 1

namestringobligatoire

Exemple: SMSRU

sitestring

Exemple: https://paradox.am

wikistring

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

fieldsarray of object

encryptedbooleanobligatoire

Champ chiffré ; utilisez un champ de type « mot de passe » pour la saisie

Exemple: true

namestringobligatoire

Exemple: source_number

valuestring

Exemple: 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' => 'fr', '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": "fr", "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": "fr", "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" } ] } ] } }