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

SendTemplate#

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

Если у вас нет своего шаблона, то мы можем помочь, для этого свяжитесь с нами через почту support@green-api.com или другим удобным способом.

Запрос#

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

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

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

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

Параметр Тип Обязательный Описание
chatId string Да Идентификатор чата
templateId string Да Идентификатор ранее созданного, существующего шаблона Используйте метод GetTemplates чтобы узнать id.
params array Да Массив параметров, используемых в шаблоне. Обязательный, если шаблон использует параметры
message object Нет Дополнительные данные для шаблона. Используется для медиа-шаблонов с типом IMAGE, VIDEO, DOCUMENT, LOCATION, CAROUSEL
postbackTexts array Нет Список объектов, содержащих информацию о постбэке

Структура объекта message для шаблона с типом IMAGE#

Параметр Тип Описание Пример
type string Тип сообщения image
image object Объект изображения, содержащий идентификатор или ссылку. Подробную структуру см. ниже

Структура объекта image#

Параметр Тип Описание Пример
link string Ссылка на изображение

Структура объекта message для шаблона с типом VIDEO#

Параметр Тип Описание Пример
type string Тип сообщения video
video object Объект видео, содержащий ссылку. Подробную структуру см. ниже

Структура объекта video#

Параметр Тип Описание Пример
link string Ссылка на видео

Структура объекта message для шаблона с типом DOCUMENT#

Параметр Тип Описание Пример
type string Тип сообщения document
document object Объект документ, содержащий ссылку. Подробную структуру см. ниже

Структура объекта document#

Параметр Тип Описание Пример
link string Ссылка на документ
filename string Имя файла документа

Структура объекта message для шаблона с типом LOCATION#

Параметр Тип Описание Пример
type string Тип сообщения location
location object Объект геолокации, содержащий идентификатор или ссылку. Подробную структуру см. ниже

Структура объекта location#

Параметр Тип Описание Пример
longitude string Долгота местоположения -79.0896492
latitude string Широта местоположения 42.5950661
name string Текст, который появится под картой Miles Morales
address string Адрес местоположения, который появится под картой New York 10019
Параметр Тип Описание Пример
type string Тип сообщения carousel
cardHeaderType string Тип заголовка IMAGE / VIDEO
cards array Список карточек в карусели Подробную структуру смотрите ниже

Структура объекта cards#

Параметр Тип Описание Пример
link string URL-адрес изображения или видео
postbackTexts array Список объектов, содержащих информацию о постбэке Подробную структуру смотрите ниже

Структура объекта postbackTexts#

Параметр Тип Описание Пример
index number Индекс кнопки (нумерация начинается с 0) 0
text string Текст обратной связи для кнопки hello

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

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

{
    "chatId": "11001234567@c.us",
    "templateId": "2522g44c-c2e4-4416-b506-4bghdd456e5g",
    "params": ["Иван", "15", "14.02.2024", "GW-r4-aB"],
    "message": {
        "type": "image",
        "image": {
            "link": "https://green-api.com/docs/news/2024/09/tech_solution_day.jpg"  
        }
    }
}

Ответ#

Поля ответа#

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

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

{
    "idMessage": "3EB0C767D097B7C7C030"
}

Ошибки SendTemplate#

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

Пример кода#

curl --location 'https://api.green-api.com/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"]},
    "message": {
        "type": "image",
        "image": {
            "link": "https://green-api.com/docs/news/2024/09/tech_solution_day.jpg"
        }
    }
}'