Перейти к содержанию

SendTemplate#

Метод предназначен для отправки шаблонного сообщения. Для отправки данного сообщения необходимо иметь или предварительно создать шаблон сообщения. Создать шаблон сообщения можно с помощью метода CreateTemplate. Сообщение будет добавлено в очередь на отправку. Сообщение на отправку хранится 24 часа в очереди и будет отправлено сразу же после авторизации телефона.

Запрос#

Для отправки шаблонного сообщения требуется выполнить запрос по адресу:

POST {{apiUrl}}/waInstance{{idInstance}}/sendTemplate/{{apiTokenInstance}}

Для получения параметров запроса idInstance, apiTokenInstance и apiUrl обратитесь к разделу Перед началом работы.

Параметры запроса#

Параметр Тип Обязательный Описание
chatId string Да Идентификатор чата
templateId string Да Индетификатор ранее созданного, существующего шаблона. Используйте метод GetTemplates чтобы узнать id.
params array Нет Массив параметров, используемых в шаблоне. Обязательный, если шаблон использует параметры

Пример тела запроса#

Отправка сообщения в личный чат: 

{
    "chatId": "11001234567@c.us",
    "templateId": "2522g44c-c2e4-4416-b506-4bghdd456e5g",
    "params": ["Иван", "15", "14.02.2024", "GW-r4-aB"]
}

Ответ#

Поля ответа#

Поле Тип Описание
idMessage string Идентификатор отправленного сообщения

Пример тела ответа#

{
    "idMessage": "3EB0C767D097B7C7C030"
}

Ошибки SendTemplate#

Перечень общих для всех методов ошибок смотрите в разделе Стандартные ошибки

Пример кода#

```curl
curl --location '{{apiUrl}}/waInstance{{idInstance}}/sendTemplate/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "templateId": "2522g44c-c2e4-4416-b506-4bghdd456e5g",
    "params": ["Иван", "15", "14.02.2024", "GW-r4-aB"]
    }'
```