💬 Командный WhatsApp-Инбокс на новой ПлатформеЕщё
1msg official logo

WhatsApp Business API для подтверждения получения документов

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

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

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

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

Здравствуйте, {{1}}! Мы получили ваши документы для {{2}}. {{3}} Благодарим за предоставление — будем держать вас в курсе хода работы.

Проверить статус
  • {{1}}
    имя клиента
  • {{2}}
    процесс верификации или работы с документами (например, верификация KYC, документы для онбординга, вложения в тикеты службы поддержки)
  • {{3}}
    следующий шаг или ожидаемые сроки (например, проверка в течение 2 рабочих дней, мы сообщим вам о завершении)
  • “Проверить статус”
    кнопка — исправлено в шаблоне Meta
WhatsApp Business API for documents received confirmation

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

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

Меньше звонков с вопросом «получили ли вы мои документы?»
Три переменные в теле содержат имя клиента, процесс проверки или верификации и следующий этап проверки, чтобы у клиента было подтверждение в WhatsApp без обращения в поддержку или повторной отправки файлов.
Проверка статуса в один клик
Кнопка со статическим URL с надписью «Проверить статус» открывает портал или страницу аккаунта — ссылка зафиксирована в утверждённом шаблоне Meta, а через API отправляется только текст тела.
Связывайтесь с клиентами за пределами 24-часового окна
Поскольку активного разговора нет, отправка происходит с использованием одобренного шаблона WhatsApp через API 1MSG — это единственный канал, который может подтвердить получение документа, когда клиент не написал первым.
Не требуется вручную подтверждать каждую загрузку
Когда срабатывает триггер о получении документов от онбординга, KYC или службы поддержки, система определяет номер телефона и отправляет шаблон на это событие вместо того, чтобы кто-то вручную копировал текст подтверждения.
Доставка зафиксирована для проверки «Как это работает»
Результат доставки фиксируется после отправки, чтобы команды CRM или комплаенс видели, кто был уведомлён, и обрабатывали ошибки согласно правилам платформы.

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

  1. Триггер

    Клиент загружает нужные документы через портал, приложение или канал поддержки.

    event · triggered

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

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

    delivered

  3. Создать и отправить

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

    POST /sendTemplate

  4. Действия клиента

    Клиент получает подтверждение в WhatsApp с описанием процесса и дальнейшими шагами.

    user action

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

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

    status: "read"

WhatsApp Business API for documents received confirmation

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

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

  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_PROCESS="___"         # {{2}} process 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_PROCESS=$TEST_PROCESS" \
            "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}} process name → ${TEST_PROCESS}
# {{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_PROCESS}" },
        { "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возвращаемым вызовом send

  • 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 Business API для уточнения данных для верификации
Сценарий отправляет клиенту персонализированный шаблон WhatsApp, когда подтверждение личности или KYC не удаётся завершить без уточнения конкретных данных.
Обслуживание клиентов
WhatsApp Business API для уведомления о повторной активации аккаунта
Сценарий отправляет владельцу аккаунта персонализированный шаблон WhatsApp, когда завершён анализ или перепроверка аккаунта и доступ восстановлен.
Обслуживание клиентов
WhatsApp Business API для запроса подписи или подтверждения данных
Сценарий отправляет клиенту персонализированный шаблон WhatsApp, когда надо подписать документ или подтвердить переданные данные для продолжения.
Обслуживание клиентов
WhatsApp Business API для уведомления об отказе в верификации
Сценарий отправляет клиенту персонализированный шаблон WhatsApp, когда его eKYC или проверка личности отклонены.
Обслуживание клиентов
WhatsApp Business API для подтверждения успешного завершения проверки
Сценарий отправляет клиенту персонализированный шаблон WhatsApp, когда его идентификацию или верификацию eKYC одобрили.
Обслуживание клиентов
WhatsApp Business API для уведомления о статусе проверки
Сценарий отправляет клиенту персонализированный шаблон WhatsApp при изменении статуса проверки или eKYC.
Обслуживание клиентов
WhatsApp Business API для запроса загрузки документа
Сценарий отправляет клиенту персонализированный шаблон WhatsApp, когда отсутствует необходимый документ, который нужно загрузить для продолжения.
Обслуживание клиентов
WhatsApp Business API для запроса дополнительных сведений по тикету
Сценарий отправляет клиенту персонализированный шаблон WhatsApp, когда для решения тикета нужна дополнительная информация, а сеансовое окно не открыто.

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