API

Obter configurações dos serviços SMS

GET/api/crm/v2/integration_smsv2
operationId: integrationSms.default

Retorna as configurações dos serviços de SMS. Os valores criptografados dos campos de conexão são retornados mascarados.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

Respostas

OK

object
statusstringobrigatório

Valores:successerror

Exemplo: success

dataobject
filtersobjectobrigatório
branch_idobject (FilterSelectInteger)
valueinteger

Exemplo: 8920

typestringobrigatório

Exemplo: select

optionarray of object
valueintegerobrigatório

Exemplo: 8920

namestringobrigatório

Exemplo: Green Basket | Kaliningrad

modestring (FilterMode)

Como a interface processa o filtro; filtros comuns não possuem mode. force_shown — sempre exibido, não pode ser ocultado. value_required — ponto de entrada para a seção: sempre exibido, não pode ter valor vazio (enquanto o valor não for selecionado, a lista permanece vazia; não há opção "todos"), a limpeza geral não o redefine.

Valores:force_shownvalue_required

Exemplo: value_required

settingsobject
idintegerobrigatório

Exemplo: 1

namestring

Exemplo: google

service_enabledboolean

Exemplo: true

order_creation_notifications_channelstring

Valores:botdisabledexternal_smsinternal_sms

Exemplo: internal_sms

order_status_change_notifications_platformstring

Valores:alldisabledsite

Exemplo: site

authorization_force_code_enabledboolean

Exemplo: true

price_smsnumber

Preço de um SMS definido pelo FoodSoul; somente leitura, não incluído no formulário de configurações

Exemplo: 3.5

listarray of object
idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: SMSRU

sitestring

Exemplo: https://paradox.am

wikistring

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

fieldsarray of object
encryptedbooleanobrigatório

Campo criptografado; use um campo do tipo "senha" para entrada

Exemplo: true

namestringobrigatório

Exemplo: source_number

valuestring

Exemplo: secretkey