Overí, či sú zadané čísla v blackliste. Vracia mapu číslo → `true`/`false`.

## API URL

Adresa URL používaná na odosielanie HTTP požiadaviek:

```url
https://portal.bulkgate.com/api/1.0/black-list/is-black-listed
```

> [!NOTE]
> Ak sa požiadavka nedostane k cieľu, zopakujte ju na [záložnom serveri](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/zalozny-server/) `backup1.bulkgate.com`.

## Podporované HTTP metódy

- `POST` - `application/json`

```http
POST /api/1.0/black-list/is-black-listed HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json
```

> [!NOTE]
> API má nastavenú kvótu `20` požiadaviek za minútu.

## Tabuľka s parametrami

| NÁZOV PARAMETRA   | HODNOTA                                                | POVINNÝ | PREDVOLENÁ HODNOTA   |
|:------------------|:-------------------------------------------------------|:--------|:------------------|
| application_id    | [Aplikačný identifikátor](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/administracia-api/) | **Áno** | -                 | 
| application_token | [Aplikačný overovací token](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/api-tokeny/)	      | **Áno** | -                 |
| numbers           | Čísla na kontrolu — pole alebo reťazec oddelený čiarkami | **Áno** | -                 |
| wallet            | Peňaženka, v ktorej sa čísla skontrolujú               | Nie      | Predvolená peňaženka |
| route             | Routa, pre ktorú sa blokovanie vyhodnotí — `promotional`, `transactional` alebo `all` | Nie | `promotional` |

## Príklad požiadavky

```http-json
POST /api/1.0/black-list/is-black-listed HTTP/1.1
Host: portal.bulkgate.com
Content-Type: application/json

{
  "application_id": 451,
  "application_token": "NKN02TWE6NfBkfl-your-secret-token-Wf05GaqLIWLW4aBj",
  "numbers": ["420123456789", "420987654321"],
  "wallet": "bg1905014138000023"
}
```

## Odpoveď

**V prípade úspechu:**

```json
{
    "data": {
        "420123456789": true,
        "420987654321": false
    }
}
```

Kde:

- **kľúč** je zadané telefónne číslo
- **hodnota** je `true`, ak je číslo v blackliste, inak `false`

Neplatné čísla nevracajú chybu — sú v odpovedi s hodnotou `false`.

**V prípade chyby:**

```json
{
    "type": "invalid_wallet",
    "code": 400,
    "error": "Invalid wallet",
    "detail": null
}
```

```json
{
    "type": "minute_quota_exceeded",
    "code": 400,
    "error": "Minute quota exceeded",
    "detail": null
}
```

Kde:

- **type** a **error** (popis chyby) nájdete v [tabuľke typov chýb](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/)
- **code** je HTTP kód chyby
- **detail** je doplňujúca informácia o chybe

### Typy chýb Blacklist API

Okrem [všeobecných typov](https://www.bulkgate.com/sk/dokumentacia/api-administracia-a-tokeny/typy-chyb-api/) vracia Blacklist API vlastné:

| TYP                     | KEDY NASTANE                                          |
|:------------------------|:--------------------------------------------------------|
| `invalid_wallet`        | Zadaná peňaženka neexistuje alebo k nej nemáte prístup. |
| `minute_quota_exceeded` | Vyčerpaná kvóta 20 požiadaviek za minútu.               |