# Vorlagen

> Genehmigte WhatsApp-Nachrichtenvorlagen auflisten und senden

- Seite: https://tbit.app/de/docs/api/templates
- Basis-URL: `https://rest-api.tbit.app/v1`
- Authentifizierung: Header `X-API-Key` mit deinem Schlüssel in jeder Anfrage (die Beispiele lesen ihn aus der Umgebungsvariable `TBIT_API_KEY`)

## Überblick

Vorlagen sind vorab genehmigte WhatsApp-Nachrichtenformate, die du brauchst, um Gespräche außerhalb des 24-Stunden-Fensters zu beginnen. Nur Vorlagen mit dem Status „von Meta genehmigt“ können gesendet werden.

## Endpoints

| Methode | Pfad | Beschreibung |
| --- | --- | --- |
| `GET` | `/v1/templates` | Genehmigte WhatsApp-Vorlagen auflisten |
| `GET` | `/v1/templates/:id` | Vorlage im Detail abrufen |
| `POST` | `/v1/templates/:id/send` | Vorlage an einen Kontakt senden |
| `GET` | `/v1/channels/:channel_id/templates` | Genehmigte Vorlagen einer WhatsApp-Nummer |
| `GET` | `/v1/campaigns/:key/executions` | Zustellstatus pro Empfänger (Versand mit Kampagnen-Schlüssel) |

## Vorlagen auflisten

`GET /v1/templates`

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

## Vorlage im Detail abrufen

`GET /v1/templates/tpl_abc123`

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

## Vorlagen pro WhatsApp-Nummer

Eine Vorlage wird in genau einem WhatsApp-Business-Konto genehmigt, ein Agent mit mehreren Nummern hat also pro Nummer eigene Vorlagen. GET /v1/templates mischt alle Nummern (jedes Element bringt seine channel_id mit); nutze diesen Endpoint, um nur aufzulisten, was eine Nummer senden darf. Die Kanal-ID ist die, die du unter Plattform → Kanäle siehst.

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

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

## Vorlage senden

Hinweis zum Senden

Das Komponenten-Array folgt dem Format der WhatsApp Business API. Füge Header-, Body- und Button-Komponenten hinzu, so wie deine Vorlage sie verlangt.

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

## Zustellstatus

Die Antwort auf den Versand bedeutet nur, dass Meta die Nachricht ANGENOMMEN hat; zugestellt / gelesen / fehlgeschlagen kommen Minuten später über Meta-Webhooks. Um sie zu lesen, gib beim Versand `campaign` {key, name} im Body mit (der Versand wird unter diesem Schlüssel erfasst, sichtbar auch unter Plattform → Kampagnen) und frag diesen Endpoint ab. `status` ist sent, delivered, read oder failed; `message_id` ist die wamid, die der Versand zurückgibt (sie steht auch in der Antwort auf den Versand).

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

Antwort:

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

## Antwortformat

Ein Vorlagen-Objekt:

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

## Antwort auf den Versand

Ein erfolgreicher Versand liefert die ID der Nachricht:

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