Скилл WhatsApp API для ИИ агентаЕщё
1msg official logo

WhatsApp Business API для уведомления о завершении этапа

Сценарий отправляет клиенту персонализированный шаблон WhatsApp, когда клиент завершает этап многошагового процесса.

Обзор сценария

Сценарий отправляет клиенту персонализированный шаблон WhatsApp, когда он завершает этап в многоступенчатом процессе. Сообщение включает имя клиента, завершённый этап и дальнейшие шаги. Кнопка со статическим URL открывает портал или страницу статуса.

Пример шаблона

Здравствуйте, {{1}}! Этап «{{2}}» успешно завершён. Переходим к следующему шагу: {{3}} Если вам нужна помощь — мы здесь.

Открыть портал
  • {{1}}
    имя клиента
  • {{2}}
    завершённый этап (например, загрузка документов, проверка личности, оплата)
  • {{3}}
    следующий шаг или этап (например, рассмотрение менеджером в течение 2 рабочих дней)
  • “Открыть портал”
    кнопка — исправлено в шаблоне Meta
WhatsApp Business API for stage completion notification

Когда использовать

Используйте этот сценарий, когда клиент завершает этап в многошаговом процессе — онбординг, подача заявки на кредит, выполнение заказа — и вам нужно подтвердить достижение этого этапа, а также объяснить, что будет дальше, но при этом нет открытого чата в WhatsApp. Это подходит для онбординга в SaaS и потоков KYC, B2B-процессов, где только что завершён этап проверки документа, и агентств, которые передают события о завершении этапов из CRM, BPM или пользовательского движка Workflow.

Меньше потерь в долгих процессах
Три переменные в теле содержат имя клиента, метку завершённого этапа и следующий шаг, так что точка этапа попадёт в WhatsApp, где они уже общаются, вместо того чтобы ждать на электронной почте, которую они могут так и не открыть.
Меньше запросов в поддержку статуса
Шаблон указывает, какой этап пройден и что будет дальше, так что клиенту не нужно звонить в поддержку или искать в Инбоксе, чтобы узнать, где они находятся в процессе.
Без ручного обновления прогресса
Workflow запускает шаблон, когда отмечает этап завершённым и определяет телефон получателя, чтобы никто не перепечатывал названия этапов или текст следующего шага для каждого клиента.
Доступ к порталу из чата
Кнопка с фиксированным статическим URL в шаблоне Meta открывает портал или страницу статуса, при этом через API отправляются только три переменные тела.

Как это работает

  1. Спусковой механизм

    «Как это работает» отмечает этап завершённым и запускает событие завершения этапа.

    event · triggered

  2. Захватить событие

    Система обрабатывает поля с номером телефона получателя и стадией.

    phone: "+…"

  3. Собрать и отправить

    Персонализированный шаблон сообщения создаётся с тремя переменными в теле и статической кнопкой с URL.

    POST /sendTemplate

  4. Доставлено

    Клиент получает уведомление WhatsApp с описанием этапа и следующим шагом.

    delivered

  5. Статус отслеживается

    Результат доставки сохраняется в журнале; ошибки обрабатываются по правилам платформы.

    status: "read"

WhatsApp Business API for stage completion notification

Техническая реализация

Предварительные требования

  1. Ключ API 1MSG · Как получить API-ключ
  2. Аккаунт WhatsApp Business · Как подключить WABA
  3. Шаблон WhatsApp · Как утвердить шаблон WABA
  4. Согласие клиента на получение сообщений · Как управлять согласием клиентов

Примеры кода

#!/usr/bin/env bash
set -euo pipefail

# === Configuration (replace "___" placeholders) ===

API_BASE_URL="https://api.1msg.io"        # production 1MSG API base URL
CHANNEL_ID="___"                           # channel ID from 1MSG dashboard
API_TOKEN="___"                            # channel JWT token (Bearer)

TEMPLATE_NAME="___"                        # approved template name
TEMPLATE_NAMESPACE="___"                   # template namespace (required — send fails without it)
TEMPLATE_LANGUAGE="___"                    # template language code, e.g. "en"



# === Test data ===
TEST_PHONE="___"                 # client phone in international format
TEST_CUSTOMERNAME="___"         # {{1}} customer name
TEST_STAGE="___"         # {{2}} stage name
TEST_NEXTSTEP="___"         # {{3}} next step

PHONE_NORM="$(printf '%s' "$TEST_PHONE" | tr -cd '0-9')"

for pair in "CHANNEL_ID=$CHANNEL_ID" "API_TOKEN=$API_TOKEN" \
            "TEMPLATE_NAME=$TEMPLATE_NAME" "TEMPLATE_NAMESPACE=$TEMPLATE_NAMESPACE" \
            "TEMPLATE_LANGUAGE=$TEMPLATE_LANGUAGE" "TEST_PHONE=$TEST_PHONE" \
            "TEST_CUSTOMERNAME=$TEST_CUSTOMERNAME" \
            "TEST_STAGE=$TEST_STAGE" \
            "TEST_NEXTSTEP=$TEST_NEXTSTEP"; do
    val="${pair#*=}"
    if [ -z "$val" ] || [ "$val" = "___" ]; then
        echo "Missing configuration value: ${pair%%=*}" >&2
        exit 1
    fi
done

if [ -z "$PHONE_NORM" ]; then
    echo "Error: phone number has no digits after normalization" >&2
    exit 1
fi

URL="${API_BASE_URL%/}/${CHANNEL_ID}/sendTemplate"

# params carries body ONLY. Button text is fixed in the Meta template — no button param.

# {{1}} customer name → ${TEST_CUSTOMERNAME}
# {{2}} stage name → ${TEST_STAGE}
# {{3}} next step → ${TEST_NEXTSTEP}
read -r -d '' PAYLOAD <<JSON || true
{
  "phone": "${PHONE_NORM}",
  "template": "${TEMPLATE_NAME}",
  "namespace": "${TEMPLATE_NAMESPACE}",
  "language": { "policy": "deterministic", "code": "${TEMPLATE_LANGUAGE}" },
  "params": [
    {
      "type": "body",
      "parameters": [
        { "type": "text", "text": "${TEST_CUSTOMERNAME}" },
        { "type": "text", "text": "${TEST_STAGE}" },
        { "type": "text", "text": "${TEST_NEXTSTEP}" }
      ]
    }

  ]
}
JSON

RESPONSE="$(curl -s -w '\n%{http_code}' -X POST "$URL" \
    -H "Content-Type: application/json" \
    -H "Authorization: Bearer ${API_TOKEN}" \
    -d "$PAYLOAD")"

HTTP_CODE="$(printf '%s' "$RESPONSE" | tail -n1)"
BODY="$(printf '%s' "$RESPONSE" | sed '$d')"

case "$BODY" in
    *'"sent":true'*) ok=1 ;;
    *) ok=0 ;;
esac

if [ "$HTTP_CODE" -ge 200 ] && [ "$HTTP_CODE" -lt 300 ] && [ "$ok" -eq 1 ]; then
    echo "Message sent to client."
    echo "API response: $BODY"
else
    echo "Send failed. HTTP status: $HTTP_CODE" >&2
    echo "$BODY" >&2
    exit 1
fi

Статус ответа и доставки

HTTP 2xx и JSON "sent": trueозначают, что 1MSG принял сообщение для отправки, но не что оно уже доставлено на телефон клиента. Сохраните idполе (внешне похоже на wamid.…) для сопоставления статусов доставки.

200 OKОтвет
{
  "sent": true,
  "id": "wamid.HBgLMzgwNjM5...",
  "message": "Message accepted for delivery"
}
  • sent

    Принято для отправки — ещё не доставлено на телефон клиента

  • id

    Храните его — обратные вызовы доставки и hookInfo используют его в качестве ключа

Доставка поступает позже отдельным обратным вызовом. Зарегистрируйте вебхук (POST …/webhook), и 1MSG будет отправлять обновления статуса на ваш HTTPS-эндпоинт в hooks[]пакете верхнего уровня.

200 OKВебхук статуса доставки — данные, которые вы получаете
{
  "hooks": [
    {
      "id": "gBGGeSaGViBfAgnlzOSHEwK9O6F",
      "type": "message",
      "status": "sent",
      "timestamp": "1654864094",
      "recipient_id": "556123122026"
    }
  ]
}
  • status

    sent, delivered, read — или статус ошибки, если это уместно

  • id

    Соотносит обратный вызов с idвозвращённым вызовом отправки

  • timestamp

    Секунды Unix в виде строки

Если вы предпочитаете не получать обратные вызовы, используйте опрос GET {base}/{channel}/hookInfo?messageId=<id>. На практике доставка часто завершается за считанные секунды, но это не гарантируется в контракте API, поэтому не блокируйте поток в ожидании её завершения.

Распространённые ошибки

СтатусОтветПричина
200Message was not sent: template is not definednamespace, template or language missing from the request body.
200template name (…) does not exist in <language>The template is approved in a different language than the one requested.
200Message was not sent: provide chatId, phone, bsuid, or usernameNo recipient the channel could resolve.
403access deniedThe token is wrong, or belongs to a different channel than the URL.
429too many requests. please try laterThe channel is over its send rate.

ЧАСТО ЗАДАВАЕМЫЕ ВОПРОСЫ

Да, для холодных сообщений в WhatsApp нужен одобренный Meta шаблон.

Связанные

Интегрируйте WhatsApp за часы
без проблем с инфраструктурой