Mendapatkan pengaturan layanan SMS

GET/api/crm/v2/integration_smsv2

operationId: integrationSms.default

Mengembalikan pengaturan layanan SMS. Nilai terenkripsi dari field koneksi dikembalikan dalam bentuk yang disamarkan.

Otorisasi

api-token + language + role

Parameter permintaan

branch_idinteger

Contoh: 1

Tanggapan

object

statusstringwajib

Nilai:successerror

Contoh: success

dataobject

filtersobjectwajib

branch_idobject (FilterSelectInteger)

valueinteger

Contoh: 8920

typestringwajib

Contoh: select

optionarray of object

valueintegerwajib

Contoh: 8920

namestringwajib

Contoh: Green Basket | Kaliningrad

modestring (FilterMode)

Bagaimana antarmuka memproses filter; filter biasa tidak memiliki mode. force_shown — selalu ditampilkan, tidak bisa disembunyikan. value_required — titik masuk ke bagian: selalu ditampilkan, tidak memiliki nilai kosong (selama nilai belum dipilih, daftar kosong; tidak ada opsi "semua"), reset umum tidak menghapusnya.

Nilai:force_shownvalue_required

Contoh: value_required

settingsobject

idintegerwajib

Contoh: 1

namestring

Contoh: google

service_enabledboolean

Contoh: true

order_creation_notifications_channelstring

Nilai:botdisabledexternal_smsinternal_sms

Contoh: internal_sms

order_status_change_notifications_platformstring

Nilai:alldisabledsite

Contoh: site

authorization_force_code_enabledboolean

Contoh: true

price_smsnumber

Harga satu SMS yang ditetapkan oleh FoodSoul; hanya untuk dibaca, tidak termasuk dalam formulir pengaturan

Contoh: 3.5

listarray of object

idintegerwajib

Contoh: 1

namestringwajib

Contoh: SMSRU

sitestring

Contoh: https://paradox.am

wikistring

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

fieldsarray of object

encryptedbooleanwajib

Field terenkripsi; gunakan field tipe "kata sandi" untuk input

Contoh: true

namestringwajib

Contoh: source_number

valuestring

Contoh: 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' => 'id', '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": "id", "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": "id", "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" } ] } ] } }