Envoyer un modèle WhatsApp

Les modèles sont les seuls messages que WhatsApp accepte hors de la fenêtre de 24 heures. Ils sont créés et approuvés dans le tableau de bord, voir Modèles WhatsApp.

1. Trouver le modèle

GET /templates?channel_id={identifiant du canal WhatsApp}&status=APPROVED liste les modèles qu’un numéro peut envoyer :

{
  "id": "t4Hd6sFe",
  "name": "order_update",
  "language": "fr",
  "status": "APPROVED",
  "category": "UTILITY",
  "channels": ["532867649916076"],
  "header": { "type": "NONE", "text": null, "variables": [], "media_url": null },
  "body": { "text": "Bonjour {{name}}, votre commande {{order}} est prête.", "variables": ["name", "order"] },
  "footer": null,
  "buttons": []
}

body.variables (et header.variables pour un en-tête texte) sont les valeurs que vous devez fournir.

2. L’envoyer

Utilisez message.type template, le name et la language du modèle, et les variables par nom :

curl -X POST https://shortext.ny-corp.io/api/v2.0/conversations \
  -H "Authorization: Bearer $SHORTEXT_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "channel": "whatsapp",
    "channel_id": "532867649916076",
    "contact": {
      "identifier": "237699999999",
      "profile": { "firstname": "Brice", "lastname": "Mbarga", "preferred_language": "fr" }
    },
    "message": {
      "type": "template",
      "content": {
        "template_name": "order_update",
        "language": "fr",
        "body": { "name": "Brice", "order": "A-1042" }
      }
    }
  }'

<?php
$response = (new GuzzleHttp\Client())->post('https://shortext.ny-corp.io/api/v2.0/conversations', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('SHORTEXT_API_KEY'),
        'Accept'        => 'application/json',
    ],
    'json' => [
        'channel'    => 'whatsapp',
        'channel_id' => '532867649916076',
        'contact'    => [
            'identifier' => '237699999999',
            'profile'    => ['firstname' => 'Brice', 'lastname' => 'Mbarga', 'preferred_language' => 'fr'],
        ],
        'message'    => [
            'type'    => 'template',
            'content' => [
                'template_name' => 'order_update',
                'language'      => 'fr',
                'body'          => ['name' => 'Brice', 'order' => 'A-1042'],
            ],
        ],
    ],
]);

$result = json_decode((string) $response->getBody(), true);
if (!$result['success']) {
    throw new RuntimeException("Shortext error {$result['code']}: {$result['message']}");
}
$conversationId = $result['body']['conversation']['id'];

const response = await fetch("https://shortext.ny-corp.io/api/v2.0/conversations", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.SHORTEXT_API_KEY}`,
    Accept: "application/json",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    channel: "whatsapp",
    channel_id: "532867649916076",
    contact: {
      identifier: "237699999999",
      profile: { firstname: "Brice", lastname: "Mbarga", preferred_language: "fr" },
    },
    message: {
      type: "template",
      content: {
        template_name: "order_update",
        language: "fr",
        body: { name: "Brice", order: "A-1042" },
      },
    },
  }),
});

const result = await response.json();
if (!result.success) {
  throw new Error(`Shortext error ${result.code}: ${result.message}`);
}
const conversationId = result.body.conversation.id;

import os
import requests

response = requests.post(
    "https://shortext.ny-corp.io/api/v2.0/conversations",
    headers={
        "Authorization": f"Bearer {os.environ['SHORTEXT_API_KEY']}",
        "Accept": "application/json",
    },
    json={
        "channel": "whatsapp",
        "channel_id": "532867649916076",
        "contact": {
            "identifier": "237699999999",
            "profile": {"firstname": "Brice", "lastname": "Mbarga", "preferred_language": "fr"},
        },
        "message": {
            "type": "template",
            "content": {
                "template_name": "order_update",
                "language": "fr",
                "body": {"name": "Brice", "order": "A-1042"},
            },
        },
    },
)

result = response.json()
if not result["success"]:
    raise RuntimeError(f"Shortext error {result['code']}: {result['message']}")
conversation_id = result["body"]["conversation"]["id"]

Pour envoyer un modèle dans une conversation existante, postez le même message sur POST /conversations/{id}/messages.

En-tête média

Pour un modèle avec un en-tête image, vidéo ou document, donnez son URL :

"header": { "url": "https://cdn.example.com/parcels/A-1042.jpg" }

Sans url, le média enregistré avec le modèle est utilisé. Un document accepte aussi un filename.

Erreurs

Shortext vérifie le modèle avant de l’envoyer et répond code 1002 avec un message exploitable :

Message	Correction
`Template order_update not found for this WhatsApp number`	Vérifiez le nom, et que le modèle appartient au compte WhatsApp Business de ce numéro.
`Template order_update has no en version: fr`	Utilisez l’une des langues indiquées.
`Template order_update (fr) is PENDING: only approved templates can be sent`	Attendez l’approbation de Meta.
`Missing body variables: order`	Fournissez chaque variable ; `body.missing` les liste.
`Template ... has a image header: give message.content.header.url`	Fournissez l’URL du média.

Démarrer

Formats

Intégrations

Guides

Endpoints

Envoyer un modèle WhatsApp

1. Trouver le modèle

2. L’envoyer

En-tête média

Erreurs

​1. Trouver le modèle

​2. L’envoyer

​En-tête média

​Erreurs

1. Trouver le modèle

2. L’envoyer

En-tête média

Erreurs