Руководство · chat:write

Чат-бот поддержки клиентов

Отвечайте тем, кто пишет вашему аккаунту: вопросы о заказах, часы работы, частые вопросы. При необходимости передавайте разговор человеку.

Scopes: chat:read, chat:write (необязательно: orders:read для поиска заказов).

Правило антиспама#

Бот может писать только там, где собеседник уже написал, или тем, кто подписан на аккаунт. Всё остальное завершается ошибкой 403 CHAT_NOT_ALLOWED. Блокировки действуют всегда (403 CHAT_BLOCKED). Благодаря этому ботам поддержки работать легко, а «холодные» рассылки невозможны — так задумано.

Endpoint#

Endpoint	Назначение
GET `/conversations`	Ваши переписки, сначала с самой свежей активностью (с пагинацией).
GET `/conversations/{id}/messages`	Сообщения переписки, начиная с самых новых (с пагинацией).
POST `/conversations/{id}/messages`	Ответить в существующей переписке.
POST `/messages`	Написать пользователю по id (при необходимости открывает переписку). Подчиняется правилу антиспама.

1. Найдите переписки, требующие ответа#

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

Для каждой переписки с новой активностью прочитайте последние сообщения и проверьте, кто написал последним: если не вы, возможно, боту есть что ответить.

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

2. Ответьте#

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. Полноценный бот с опросом#

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)

Имена полей, такие как senderId, приведены для иллюстрации: сверьтесь со схемой сообщения в справочнике API.

Вежливый опрос#

Выполняйте опрос каждые 15–60 секунд. Один вызов /conversations и несколько чтений сообщений за цикл — это намного меньше 120 запросов в минуту.
Открывайте только те переписки, последняя активность в которых изменилась с предыдущего цикла.
Дневная квота — 500 сообщений на аккаунт.

Будьте хорошим ботом#

В первом ответе сообщите, что вы бот, и расскажите, как связаться с человеком.
Никогда не отправляйте рекламу тем, кто о ней не просил, и никогда не рассылайте одно и то же сообщение множеству людей.
Не запрашивайте в чате пароли, платёжные данные или коды.
Прекращайте писать, когда вас об этом просят.