Vérifie si les numéros indiqués figurent sur la blacklist. Renvoie un tableau associatif numéro → `true`/`false`.

## URL de l'API

URL à laquelle envoyer les requêtes HTTP :

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

> [!NOTE]
> Si la requête n'atteint pas sa destination, renvoyez-la sur le [serveur de secours](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/serveur-de-secours/) `backup1.bulkgate.com`.

## Méthodes HTTP prises en charge

- `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]
> L'API est soumise à un quota de `20` requêtes par minute.

## Tableau des paramètres

| NOM DU PARAMÈTRE  | VALEUR | OBLIGATOIRE | VALEUR PAR DÉFAUT |
|:------------------|:-------|:------------|:------------------|
| application_id    | [Application ID](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/administration-api/) | **Oui** | - |
| application_token | [Token d'authentification de l'application](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/tokens-d-api/) | **Oui** | - |
| numbers           | Numéros à vérifier — un tableau, ou une chaîne séparée par des virgules | **Oui** | - |
| wallet            | Portefeuille sur lequel vérifier les numéros | Non | Portefeuille par défaut |
| route             | La route pour laquelle le blocage est évalué — `promotional`, `transactional` ou `all` | Non | `promotional` |

## Exemple de requête

```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"
}
```

## Réponse

**En cas de succès :**

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

Où :

- la **clé** est le numéro de téléphone que vous avez envoyé
- la **valeur** est `true` si le numéro figure sur la blacklist, sinon `false`

Les numéros invalides ne renvoient pas d'erreur — ils figurent dans la réponse avec la valeur `false`.

**En cas d'erreur :**

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

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

Où :

- **type** et **error** (description de l'erreur) figurent dans le [tableau des types d'erreurs](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/types-d-erreurs-api/)
- **code** est le code d'erreur HTTP
- **detail** contient des informations complémentaires sur l'erreur

### Types d'erreurs de l'API Blacklist

En plus des [types généraux](https://www.bulkgate.com/fr/documentation/administration-api-et-tokens/types-d-erreurs-api/), l'API Blacklist renvoie ses propres types :

| TYPE                    | QUAND CELA SE PRODUIT                                   |
|:------------------------|:--------------------------------------------------------|
| `invalid_wallet`        | Le portefeuille indiqué n'existe pas ou vous n'y avez pas accès. |
| `minute_quota_exceeded` | Le quota de 20 requêtes par minute est épuisé. |