API

Obtenir la liste noire

GET/api/crm/v2/black_listv2
operationId: blackList.default

Autorisation

api-token + language + role

Paramètres de requête

page_numberinteger

Exemple: 1

phone_format_idinteger

Exemple: 1

phone_numberstring

Exemple: (707) 712-51-19

Réponses

OK

object
statusstringobligatoire

Valeurs:successerror

Exemple: success

dataobject
filtersobject
phone_format_idobject (FilterSelectInteger)
valueinteger

Exemple: 8920

typestringobligatoire

Exemple: select

optionarray of object
valueintegerobligatoire

Exemple: 8920

namestringobligatoire

Exemple: Green Basket | Kaliningrad

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

phone_numberobject (FilterInput)
valuestring

Exemple: example

typestringobligatoire

Exemple: integer or string

placeholderstring

Exemple: string

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

idobject (FilterId)
valueany

Exemple: 0

typestringobligatoire

Exemple: integer

placeholderstring

Exemple: integer

modestring (FilterMode)

Comment l’interface gère le filtre ; un filtre classique n’a pas de champ mode.
force_shown — toujours affiché, ne peut pas être masqué.
value_required — point d’entrée dans la section : toujours affiché, ne peut pas être vide (tant qu’aucune valeur n’est sélectionnée, la liste est vide ; il n’y a pas d’option « tout »), la réinitialisation générale ne l’efface pas.

Valeurs:force_shownvalue_required

Exemple: value_required

listarray of object
idintegerobligatoire

Exemple: 82348

datestring (DataTimeFormat) obligatoire

Exemple: 17:45 06/05/2024

chain_idintegerobligatoire

Exemple: 7143

client_account_idinteger

Exemple: 0

client_branch_profile_idinteger

Exemple: 0

phone_format_idinteger

Exemple: 4

phone_numberstring

Exemple: 7077125119

blockedbooleanobligatoire

Exemple: true

client_namestring

Exemple: example

paginationobject (Pagination)
max_countintegerobligatoire

Nombre d'éléments par page

Exemple: 30

page_numberintegerobligatoire

Numéro de la page actuelle ; limité pour que le décalage ne dépasse pas 1000

Exemple: 1

has_nextbooleanobligatoire

Indique s'il existe une page suivante

Exemple: true

has_previousbooleanobligatoire

Y a-t-il une page précédente

Exemple: false