# Templates

> Bekijk en verstuur goedgekeurde WhatsApp-berichttemplates

- Pagina: https://tbit.app/nl/docs/api/templates
- Basis-URL: `https://rest-api.tbit.app/v1`
- Authenticatie: header `X-API-Key` met je sleutel bij elk verzoek (de voorbeelden lezen hem uit de omgevingsvariabele `TBIT_API_KEY`)

## Overzicht

Templates zijn vooraf goedgekeurde WhatsApp-berichtformaten die je nodig hebt om gesprekken te starten buiten het berichtvenster van 24 uur. Alleen templates met de status goedgekeurd door Meta kunnen worden verstuurd.

## Endpoints

| Methode | Pad | Beschrijving |
| --- | --- | --- |
| `GET` | `/v1/templates` | Goedgekeurde WhatsApp-templates opvragen |
| `GET` | `/v1/templates/:id` | Details van een template |
| `POST` | `/v1/templates/:id/send` | Template naar een contact sturen |
| `GET` | `/v1/channels/:channel_id/templates` | Goedgekeurde templates van één WhatsApp-lijn |
| `GET` | `/v1/campaigns/:key/executions` | Bezorgstatus per ontvanger (verzendingen met een campagnesleutel) |

## Templates opvragen

`GET /v1/templates`

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

## Details van een template opvragen

`GET /v1/templates/tpl_abc123`

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

## Templates per WhatsApp-lijn

Een template wordt goedgekeurd op één WhatsApp Business-account, dus een agent met meerdere lijnen heeft per lijn een eigen set templates. GET /v1/templates mengt alle lijnen (elk item heeft zijn channel_id); gebruik dit endpoint om alleen op te vragen wat één lijn kan versturen. De kanaal-ID is de ID die je ziet in Platform → Kanalen.

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

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

## Template versturen

Opmerking over versturen

De array met componenten volgt het formaat van de WhatsApp Business API. Voeg header-, body- en knopcomponenten toe zoals je template dat vraagt.

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

## Bezorgstatus

De response van het versturen betekent alleen dat Meta het bericht HEEFT GEACCEPTEERD; bezorgd / gelezen / mislukt komen een paar minuten later binnen via de webhooks van Meta. Om ze te lezen geef je `campaign` {key, name} mee in de body van de verzending (de verzending wordt onder die sleutel vastgelegd, ook zichtbaar in Platform → Campagnes) en vraag je dit endpoint op. `status` is sent, delivered, read of failed; `message_id` is de wamid die de verzending teruggeeft (die staat ook in de response van de verzending).

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

Response:

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

## Responseformaat

Een templateobject:

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

## Response bij versturen

Een geslaagde verzending geeft de bericht-ID terug:

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