Obter a lista de integrações com chats

GET/api/crm/v2/integration_chatsv2

operationId: integrationChats.default

Retorna os serviços de chat. Para cada serviço, são fornecidos os campos de configuração, links para o site e wiki, e a URL do webhook criada para a filial. O parâmetro branch_id é obrigatório.

Autorização

api-token + language + role

Parâmetros de consulta

branch_idinteger

Exemplo: 1

Respostas

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

namestringobrigatório

Exemplo: google

chat_enabledboolean

Exemplo: true

listarray of object

idintegerobrigatório

Exemplo: 1

namestringobrigatório

Exemplo: Google

system_namestring

Exemplo: Google

sitestringobrigatório

Exemplo: https://developer.tech.yandex.ru

wikistring

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

fieldsarray of objectobrigatório

encryptedbooleanobrigatório

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

Exemplo: true

namestringobrigatório

Exemplo: api_key

valuestring

Exemplo: secretkey

webhookstringobrigatório

Exemplo: https://ru.foodsoul.test/webhook/chat/verbox/?token=f20138c54eaaad6c00ac77d27b2f4cb4

<?php $client = new \GuzzleHttp\Client(); $response = $client->request('GET', 'https://foodsoul.pro/api/crm/v2/integration_chats', [ 'headers' => [ 'Authorization' => 'Bearer fs_api_YOUR_TOKEN', 'language' => 'pt', 'role' => 'partner', ], ]); $data = json_decode((string) $response->getBody(), true);

const response = await fetch("https://foodsoul.pro/api/crm/v2/integration_chats", { method: "GET", headers: { "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pt", "role": "partner" }, }) const data = await response.json()

import requests response = requests.request( "GET", "https://foodsoul.pro/api/crm/v2/integration_chats", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "pt", "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", "chat_enabled": true }, "list": [ { "id": 1, "name": "Google", "system_name": "Google", "site": "https://developer.tech.yandex.ru", "wiki": "https://wiki.foodsoul.pro/i/97", "fields": [ { "encrypted": true, "name": "api_key", "value": "secretkey" } ], "webhook": "https://ru.foodsoul.test/webhook/chat/verbox/?token=f20138c54eaaad6c00ac77d27b2f4cb4" } ] } }