Démarrage rapide de l'API

Ce démarrage rapide vous mène d’une intégration vide à un premier message WhatsApp envoyé par l’API. Il vous faut une entreprise Shortext avec au moins un numéro WhatsApp connecté.

Créez une clé API

Dans le tableau de bord, ouvrez Développeur > API Keys et créez une clé. Donnez-lui un nom (par exemple « Intégration CRM ») et choisissez ses permissions. Pour suivre ce guide, gardez Envoyer des messages cochée ; ajoutez Gérer les intégrations si votre intégration gère aussi des agents, des canaux ou des webhooks.La clé n’est affichée qu’une fois. Stockez-la dans un gestionnaire de secrets ou une variable d’environnement, par exemple SHORTEXT_API_KEY.

Une clé API donne accès aux données de votre entreprise. Ne la mettez jamais dans une application mobile, une page web ou un dépôt public.

Vérifiez la clé avec GET /me

Chaque requête envoie la clé comme jeton bearer. GET /me indique l’entreprise et la clé que vous utilisez.

curl https://shortext.ny-corp.io/api/v2.0/me \
  -H "Authorization: Bearer $SHORTEXT_API_KEY" \
  -H "Accept: application/json"

<?php
$response = (new GuzzleHttp\Client())->get('https://shortext.ny-corp.io/api/v2.0/me', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('SHORTEXT_API_KEY'),
        'Accept'        => 'application/json',
    ],
]);

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

const response = await fetch("https://shortext.ny-corp.io/api/v2.0/me", {
  headers: {
    Authorization: `Bearer ${process.env.SHORTEXT_API_KEY}`,
    Accept: "application/json",
  },
});

const result = await response.json();
if (!result.success) {
  throw new Error(`Shortext error ${result.code}: ${result.message}`);
}
console.log(result.body.company.name);

import os
import requests

response = requests.get(
    "https://shortext.ny-corp.io/api/v2.0/me",
    headers={
        "Authorization": f"Bearer {os.environ['SHORTEXT_API_KEY']}",
        "Accept": "application/json",
    },
)

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

Réponse

{
  "success": true,
  "message": "Request success.",
  "code": 1000,
  "body": {
    "company": { "id": "CMP-XXXXX", "name": "Acme" },
    "user": null,
    "token": {
      "name": "Intégration CRM",
      "abilities": ["permissions.send_messages", "permissions.view_messages"],
      "last_used_at": "2026-10-24T09:12:44.000000Z",
      "expires_at": null
    },
    "api_version": "v2.0"
  }
}

Le statut HTTP est toujours 200 : lisez success et code pour connaître le résultat. Voir Introduction à l’API.

Trouvez votre canal et un modèle

GET /channels?type=whatsapp liste vos numéros WhatsApp. L’id d’un canal est le channel_id depuis lequel vous envoyez les messages.WhatsApp ne laisse une entreprise écrire en premier qu’avec un modèle approuvé. GET /templates?channel_id={id}&status=APPROVED liste les modèles que ce numéro peut envoyer, avec leurs variables.

Envoyez votre premier message

POST /conversations envoie un premier message à un contact et ouvre (ou poursuit) la conversation.

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

La réponse contient la conversation et le message envoyé. Gardez conversation.id : il sert à répondre, à prendre la conversation en main ou à lire ses messages.

Recevez les réponses

Quand le contact répond, l’agent rattaché au canal répond automatiquement. Pour suivre la conversation depuis votre système, créez un endpoint webhook abonné à message.*.

Étapes suivantes

Authentification

Les clés API et leurs permissions.

Format des messages

Texte, modèles, messages interactifs et médias.

Webhooks

Recevez des événements signés en temps réel.

La règle des 24 heures

Quand WhatsApp accepte du texte libre, et quand il exige un modèle.

Introduction

Premiers pas

Agents

Canaux

Boîte de réception

Démarrage rapide de l'API

Étapes suivantes

Authentification

Format des messages

Webhooks

La règle des 24 heures

​Étapes suivantes

Authentification

Format des messages

Webhooks

La règle des 24 heures

Étapes suivantes