Obtener la lista negra

GET/api/crm/v2/black_listv2

operationId: blackList.default

Autorización

api-token + language + role

Parámetros de consulta

page_numberinteger

Ejemplo: 1

phone_format_idinteger

Ejemplo: 1

phone_numberstring

Ejemplo: (707) 712-51-19

Respuestas

object

statusstringobligatorio

Valores:successerror

Ejemplo: success

dataobject

filtersobject

phone_format_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

phone_numberobject (FilterInput)

valuestring

Ejemplo: example

typestringobligatorio

Ejemplo: integer or string

placeholderstring

Ejemplo: string

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

idobject (FilterId)

valueany

Ejemplo: 0

typestringobligatorio

Ejemplo: integer

placeholderstring

Ejemplo: integer

modestring (FilterMode)

Valores:force_shownvalue_required

Ejemplo: value_required

listarray of object

idintegerobligatorio

Ejemplo: 82348

datestring (DataTimeFormat) obligatorio

Ejemplo: 17:45 06/05/2024

chain_idintegerobligatorio

Ejemplo: 7143

client_account_idinteger

Ejemplo: 0

client_branch_profile_idinteger

Ejemplo: 0

phone_format_idinteger

Ejemplo: 4

phone_numberstring

Ejemplo: 7077125119

blockedbooleanobligatorio

Ejemplo: true

client_namestring

Ejemplo: example

paginationobject (Pagination)

max_countintegerobligatorio

Cantidad de elementos por página

Ejemplo: 30

page_numberintegerobligatorio

Número de la página actual; limitado para que el desplazamiento no supere 1000

Ejemplo: 1

has_nextbooleanobligatorio

¿Hay una página siguiente?

Ejemplo: true

has_previousbooleanobligatorio

¿Hay una página anterior?

Ejemplo: false

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

const response = await fetch("https://foodsoul.ru/api/crm/v2/black_list", { 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.ru/api/crm/v2/black_list", headers={ "Authorization": "Bearer fs_api_YOUR_TOKEN", "language": "es", "role": "partner", }, ) data = response.json()

{ "status": "success", "data": { "filters": { "phone_format_id": { "value": 8920, "type": "select", "option": [ { "value": 8920, "name": "Green Basket | Kaliningrad" } ], "mode": "value_required" }, "phone_number": { "value": "example", "type": "integer or string", "placeholder": "string", "mode": "value_required" }, "id": { "value": 0, "type": "integer", "placeholder": "integer", "mode": "value_required" } }, "list": [ { "id": 82348, "date": "17:45 06/05/2024", "chain_id": 7143, "client_account_id": 0, "client_branch_profile_id": 0, "phone_format_id": 4, "phone_number": "7077125119", "blocked": true, "client_name": "example" } ], "pagination": { "max_count": 30, "page_number": 1, "has_next": true, "has_previous": false } } }