SendTemplate#

Метод предназначен для отправки шаблонного сообщения из официального API. Удобен для массовых рассылок. Для отправки данного сообщения необходимо иметь или предварительно создать шаблон сообщения. Если у вас нет своего шаблона, то мы можем помочь, для этого свяжитесь с нами через почту support@green-api.com или другим удобным способом.

Запрос#

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

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

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

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

Параметр	Тип	Обязательный	Описание
`chatId`	string	Да	Идентификатор чата
`namespace`	string	Да	имя пространства имен из официального API
`namespace`	string	Да	имя шаблона сообщения
`languageCode`	string	Да	Код языка локализации шаблона сообщения
`params`	array	Нет	Массив параметров, используемых в шаблоне. Обязательный, если шаблон использует параметры
`quotedMessageId`	string	Нет	Идентификатор цитируемого сообщения,если указан то сообщение отправится с цитированием указанного сообщения чата

Поля массива params

Параметр	Тип	Описание
`default`	string	значение параметра default

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

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

{
    "chatId": "11001234567@c.us",
    "namespace": "not_existing_namespace",
    "name": "not_existing_template",
    "languageCode": "ru",
    "params": [
        {"default": "Dear customer"}
    ]
}

Ответ#

Поля ответа#

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

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

{
    "idMessage": "3EB0C767D097B7C7C030"
}

Ошибки SendTemplate#

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

Пример кода на curl#

```
curl --location --request POST '{{APIUrl}}/waInstance{{idInstance}}/sendTemplate/{{apiTokenInstance}}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "chatId": "11001234567@c.us",
    "namespace": "not_existing_namespace",
    "name": "not_existing_template",
    "languageCode": "ru",
    "params": [
        {"default": "Dear customer"}
    ]
}'
```