Как создать шаблон сообщения в Multi API

Коротко: шаблон — это готовое сообщение, которое можно использовать многократно. Создаётся в разделе «Активы» → «Шаблоны сообщений».

Кому подходит

• Роль: Клиент, Разработчик
• Уровень: Новичок

Что это

Шаблон сообщения — заранее подготовленное содержимое, которое можно многократно использовать при отправке через API.

Шаблоны создаются в разделе Активы → Шаблоны сообщений.

Возможности шаблона

Перед началом

• У вас есть имя отправителя со статусом Активно для нужного канала.
• Вы работаете в разделе Активы → Шаблоны сообщений.
• Вы определили канал и содержимое шаблона.

Шаги

Как использовать шаблон в API

Для отправки сообщения по шаблону используйте параметр template вместо payload.

Пример отправки шаблона через RCS:

curl --location 'https://web.multiapi.ru/api/v1/messages' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "contact": "<dnis>",
    "webhook": "<webhookURL>",
    "channel": 2,
    "senderId": "<senderID>",
    "template": {
      "id": <templateID>,
      "params": {
        "attribute.phoneNumber": "112332",
        "attribute.name": "test-name"
      }
    }
  }'

Формат успешного ответа:

{
  "error": false,
  "data": {
    "channel": 2,
    "transactionId": "95e3e0da-9684-4ba4-88a3-e9207ddeca05",
    "messageId": "6719b5f4-36af-4fba-b111-49ff07f4f96b"
  }
}

Переменные в шаблоне

В шаблон можно добавить переменные — данные из профиля контакта, которые подставляются в сообщение автоматически при отправке.

Каждое сообщение становится персональным: вместо {{attribute.name}} получатель видит своё имя, вместо {{attribute.phoneNumber}} — свой номер и так далее.

Как добавить переменную

1. При настройке содержимого шаблона в ЛК нажмите кнопку персонализации.
2. Выберите атрибут из списка — например, Имя, Фамилия, Телефон, Город.
3. Переменная вставится в текст в виде {{attribute.name}}.

Примеры для разных каналов

SMS:

{{attribute.name}}, у нас скидки на все торты!

Получатель с именем «Александр» увидит: «Александр, у нас скидки на все торты!»

RCS:

{{attribute.name}}, у нас скидка 50% на все пирожные.

TTS:

Ваш код подтверждения: {{attribute.code}}. Повторяю: {{attribute.code}}.

Email — тема:

{{attribute.name}}, ваш заказ готов

Как данные подставляются автоматически

"params": {
  "attribute.name": "Александр",
  "attribute.phoneNumber": "79123456789"
}

Передача переменных через API

curl --location 'https://web.multiapi.ru/api/v1/messages' \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <ваш-ключ>' \
  --data-raw '{
    "contact": "79123456789",
    "channel": 1,
    "senderId": "<senderID>",
    "template": {
      "id": 624,
      "params": {
        "attribute.name": "Александр",
        "attribute.phoneNumber": "79123456789"
      }
    }
  }'

Что здесь что:

Как получить ID шаблона

ID шаблона можно получить двумя способами.

Способ 1. В личном кабинете:

Откройте Активы → Шаблоны сообщений. В таблице — колонка ID.

Способ 2. Через API:

curl --location 'https://web.multiapi.ru/api/v1/templates' \
  --header 'X-API-Key: <ваш-ключ>'

Формат ответа:

{
  "data": [
    {
      "id": 624,
      "name": "wa_test",
      "channel": 4,
      "content": "{...}",
      "created_at": "2025-01-23T18:31:35.587814Z",
      "updated_at": "2025-01-23T18:31:35.587823Z"
    }
  ],
  "error": false,
  "size": 135
}

Поля ответа:

Справочные эндпоинты →

Что в таблице шаблонов

Шаблон сообщения и шаблон рассылки — разные сущности

Результат

Шаблон создан и доступен для использования в API через параметр template.

• Как создать шаблон WhatsApp →
• Как загрузить медиафайл →
• OMNI API — отправка →

Частые проблемы

См. также

Нужна помощь?

• Multi API: support@multiapi.ru