Linework Developers
FR
Obtenir l'accès

Guide · chat:write

Bot de support client dans le chat

Répondez aux personnes qui écrivent à votre compte : questions sur les commandes, horaires d'ouverture, FAQ. Passez la main à un humain si nécessaire.

Scopes : chat:read, chat:write (facultatif : orders:read pour consulter les commandes).

La règle anti-spam#

Un bot ne peut écrire que là où l'autre personne a déjà écrit, ou aux personnes qui suivent le compte. Tout le reste échoue avec 403 CHAT_NOT_ALLOWED. Les blocages s'appliquent toujours (403 CHAT_BLOCKED). Les bots de support sont ainsi simples à créer et la prospection à froid impossible — c'est voulu.

Les endpoints#

EndpointUsage
GET /conversationsVos conversations, de l'activité la plus récente à la plus ancienne (paginé).
GET /conversations/{id}/messagesMessages d'une conversation, du plus récent au plus ancien (paginé).
POST /conversations/{id}/messagesRépondre dans une conversation existante.
POST /messagesÉcrire à un utilisateur à partir de son identifiant (ouvre la conversation si nécessaire). Soumis à la règle anti-spam.

1. Trouver les conversations auxquelles répondre#

curl "https://api.linework.app/open/v1/conversations?limit=20" \
  -H "Authorization: Bearer $LINEWORK_API_KEY"

Pour chaque conversation présentant une nouvelle activité, lisez les derniers messages et vérifiez qui a écrit en dernier : si ce n'est pas vous, le bot a peut-être quelque chose à répondre.

curl "https://api.linework.app/open/v1/conversations/c_3391/messages?limit=10" \
  -H "Authorization: Bearer $LINEWORK_API_KEY"

2. Répondre#

curl https://api.linework.app/open/v1/conversations/c_3391/messages \
  -H "Authorization: Bearer $LINEWORK_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "text": "Hi! We are open Monday to Saturday, 9:00–19:00." }'

3. Un bot de polling complet#

const API = "https://api.linework.app/open/v1";
const headers = { Authorization: `Bearer ${process.env.LINEWORK_API_KEY}`, "Content-Type": "application/json" };
const get = (p) => fetch(API + p, { headers }).then((r) => r.json());

const me = await get("/me");
const answered = new Set(); // in production: a database

async function tick() {
  const convs = await get("/conversations?limit=20");
  for (const conv of convs.data) {
    const msgs = await get(`/conversations/${conv.id}/messages?limit=5`);
    const last = msgs.data[0]; // newest first
    if (!last || last.senderId === me.id || answered.has(last.id)) continue;

    const reply = answer(last.text);
    answered.add(last.id);
    if (!reply) continue; // a human will answer

    const res = await fetch(`${API}/conversations/${conv.id}/messages`, {
      method: "POST", headers, body: JSON.stringify({ text: reply }),
    });
    if (res.status === 429) return; // quota or rate limit: try again later
  }
}

function answer(text = "") {
  if (/hours|open|orari/i.test(text)) return "We are open Monday to Saturday, 9:00–19:00.";
  if (/order|ordine/i.test(text)) return "Send me your order number and I will check it for you.";
  return null;
}

setInterval(() => tick().catch(console.error), 30_000);
import os, re, time, requests

API = "https://api.linework.app/open/v1"
s = requests.Session()
s.headers["Authorization"] = f"Bearer {os.environ['LINEWORK_API_KEY']}"

me = s.get(API + "/me", timeout=30).json()
answered = set()  # in production: a database

def answer(text):
    if re.search(r"hours|open|orari", text or "", re.I):
        return "We are open Monday to Saturday, 9:00–19:00."
    if re.search(r"order|ordine", text or "", re.I):
        return "Send me your order number and I will check it for you."
    return None

def tick():
    convs = s.get(API + "/conversations", params={"limit": 20}, timeout=30).json()
    for conv in convs["data"]:
        msgs = s.get(f"{API}/conversations/{conv['id']}/messages", params={"limit": 5}, timeout=30).json()
        last = msgs["data"][0] if msgs["data"] else None  # newest first
        if not last or last["senderId"] == me["id"] or last["id"] in answered:
            continue
        answered.add(last["id"])
        reply = answer(last.get("text"))
        if not reply:
            continue  # a human will answer
        r = s.post(f"{API}/conversations/{conv['id']}/messages", json={"text": reply}, timeout=30)
        if r.status_code == 429:
            return  # quota or rate limit: try again later

while True:
    tick()
    time.sleep(30)

Les noms de champs tels que senderId sont donnés à titre d'illustration : vérifiez le schéma des messages dans la Référence de l'API.

Un polling respectueux#

  • Interrogez l'API toutes les 15 à 60 secondes. Un appel à /conversations plus quelques lectures de messages par cycle restent bien en dessous de 120 requêtes par minute.
  • N'ouvrez que les conversations dont la dernière activité a changé depuis le cycle précédent.
  • Le quota journalier est de 500 messages par compte.

Soyez un bon bot#

  • Indiquez qu'il s'agit d'un bot dès la première réponse et expliquez comment joindre un humain.
  • N'envoyez jamais de promotions à des personnes qui n'ont rien demandé, et n'envoyez jamais le même message à de nombreuses personnes.
  • Ne demandez pas de mots de passe, de coordonnées de paiement ni de codes dans le chat.
  • Arrêtez-vous lorsqu'on vous le demande.