# Modèles

> Listez et envoyez des modèles de messages WhatsApp approuvés

- Page: https://tbit.app/fr/docs/api/templates
- URL de base: `https://rest-api.tbit.app/v1`
- Authentification: en-tête `X-API-Key` avec votre clé dans chaque requête (les exemples la lisent depuis la variable d'environnement `TBIT_API_KEY`)

## Vue d'ensemble

Les modèles sont des formats de messages WhatsApp pré-approuvés, obligatoires pour ouvrir une conversation en dehors de la fenêtre de messagerie de 24 heures. Seuls les modèles approuvés par Meta peuvent être envoyés.

## Endpoints

| Méthode | Chemin | Description |
| --- | --- | --- |
| `GET` | `/v1/templates` | Lister les modèles WhatsApp approuvés |
| `GET` | `/v1/templates/:id` | Obtenir le détail d'un modèle |
| `POST` | `/v1/templates/:id/send` | Envoyer un modèle à un contact |
| `GET` | `/v1/channels/:channel_id/templates` | Modèles approuvés d'une ligne WhatsApp |
| `GET` | `/v1/campaigns/:key/executions` | Statut de distribution par destinataire (envois faits avec une clé de campagne) |

## Lister les modèles

`GET /v1/templates`

```bash
curl "https://rest-api.tbit.app/v1/templates" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Obtenir le détail d'un modèle

`GET /v1/templates/tpl_abc123`

```bash
curl "https://rest-api.tbit.app/v1/templates/tpl_abc123" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Modèles par ligne WhatsApp

Un modèle est approuvé sur un seul compte WhatsApp Business : un agent avec plusieurs lignes a donc un jeu de modèles par ligne. GET /v1/templates mélange toutes les lignes (chaque élément porte son channel_id) ; utilisez cet endpoint pour lister uniquement ce qu'une ligne peut envoyer. L'id du canal est celui affiché dans Plateforme → Canaux.

`GET /v1/channels/6a7268abec6ecaf999a6c0ba/templates`

```bash
curl "https://rest-api.tbit.app/v1/channels/6a7268abec6ecaf999a6c0ba/templates" \
  -H "X-API-Key: $TBIT_API_KEY"
```

## Envoyer un modèle

Note sur l'envoi

Le tableau de composants suit le format de l'API WhatsApp Business. Incluez les composants d'en-tête, de corps et de boutons selon ce que demande votre modèle.

`POST /v1/templates/tpl_abc123/send`

```bash
curl -X POST "https://rest-api.tbit.app/v1/templates/tpl_abc123/send" \
  -H "X-API-Key: $TBIT_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "573001234567",
    "components": [
      {
        "type": "body",
        "parameters": [
          {
            "type": "text",
            "text": "John"
          },
          {
            "type": "text",
            "text": "your order #1234"
          }
        ]
      }
    ]
  }'
```

## Statut de distribution

La réponse de l'envoi signifie seulement que Meta a ACCEPTÉ le message ; délivré / lu / échoué arrivent quelques minutes plus tard via les webhooks de Meta. Pour les lire, passez `campaign` {key, name} dans le body de l'envoi (l'envoi est enregistré sous cette clé, visible aussi dans Plateforme → Campagnes) et interrogez cet endpoint. `status` vaut sent, delivered, read ou failed ; `message_id` est le wamid renvoyé par l'envoi (il figure aussi dans la réponse de l'envoi).

`GET /v1/campaigns/my-app/executions`

```bash
curl "https://rest-api.tbit.app/v1/campaigns/my-app/executions?since=2026-08-27T00:00:00Z&limit=100" \
  -H "X-API-Key: $TBIT_API_KEY"
```

Réponse:

```json
{
  "data": [
    {
      "id": "6a90ea1f...",
      "to": "573001234567",
      "template_id": "tpl_abc123",
      "message_id": "wamid.HBgLNTcz...",
      "status": "failed",
      "error_message": "This message was not delivered to maintain healthy ecosystem engagement.",
      "sent_at": "2026-08-28T02:17:59.494Z",
      "delivered_at": null,
      "read_at": null
    }
  ]
}
```

## Format de réponse

Un objet modèle :

```json
{
  "data": [
    {
      "id": "tpl_abc123",
      "name": "order_confirmation",
      "language": "es",
      "status": "APPROVED",
      "category": "UTILITY",
      "channel_id": "6a7268abec6ecaf999a6c0ba",
      "components": [
        {
          "type": "BODY",
          "text": "Hola {{1}}, {{2}} ha sido confirmado."
        }
      ],
      "created_at": "2024-08-15T10:00:00Z"
    }
  ]
}
```

## Réponse d'envoi

Un envoi réussi renvoie l'ID du message :

```json
{
  "data": {
    "message_sent": true,
    "message_id": "wamid.HBgLNTczMDAxMjM0NTY3FQIAERgSMUY2RUZGM0Y3RTJCRTQ5AA==",
    "parsed_message": "Hola John, your order #1234 ha sido confirmado."
  }
}
```