Obtener la configuración de los servicios SMS

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Devuelve la configuración de los servicios SMS. Los valores cifrados de los campos de conexión se muestran enmascarados.

Autorización

api-token + language + role

Parámetros de consulta

branch_idinteger

Ejemplo: 1

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobjectobligatorio

branch_idobject (FilterSelectInteger)

valueinteger

Ejemplo: 8920

typestringobligatorio

Ejemplo: select

optionarray of object

valueintegerobligatorio

Ejemplo: 8920

namestringobligatorio

Ejemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Cómo la interfaz maneja el filtro; el filtro estándar no tiene mode.
force_shown: siempre visible, no se puede ocultar.
value_required: punto de entrada a la sección; siempre visible, no puede estar vacío (mientras no se seleccione un valor, la lista está vacía; no hay opción "todos"), el reinicio general no lo limpia.

Valores:force_shownvalue_required

Ejemplo: value_required

settingsobject

idintegerobligatorio

Ejemplo: 1

namestring

Ejemplo: google

service_enabledboolean

Ejemplo: true

order_creation_notifications_channelstring

Valores:botdisabledexternal_smsinternal_sms

Ejemplo: internal_sms

order_status_change_notifications_platformstring

Valores:alldisabledsite

Ejemplo: site

authorization_force_code_enabledboolean

Ejemplo: true

price_smsnumber

Precio de un SMS, establecido por FoodSoul; solo lectura, no incluido en el formulario de configuración

Ejemplo: 3.5

listarray of object

idintegerobligatorio

Ejemplo: 1

namestringobligatorio

Ejemplo: SMSRU

sitestring

Ejemplo: https://paradox.am

wikistring

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

fieldsarray of object

encryptedbooleanobligatorio

Campo cifrado; para la entrada, utilice un campo de tipo "contraseña"

Ejemplo: true

namestringobligatorio

Ejemplo: source_number

valuestring

Ejemplo: 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' => 'es', '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": "es", "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": "es", "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" } ] } ] } }