KiT Docs Portal
  1. WhatsApp API
  2. Шаблонные сообщения
KiT Docs Portal
  • KiT Docs Portal
  • Личный кабинет
  • WhatsApp API
    • Типы сообщений
    • Форматирование в текстовых сообщениях
    • Форматы WhatsApp Media
    • Коды ошибок платформы WABA
    • Шаблонные сообщения
      • Категории шаблонов
      • Типы заголовков в шаблонных сообщениях
      • Тело шаблонного сообщения
      • Кнопки в шаблонных сообщениях
      • Общее описание запроса
        POST
      • Сообщение со всеми параметрами - заголовок изображение
        POST
      • Сообщение со всеми параметрами - заголовок текст
        POST
      • Сообщение изображение и текст
        POST
      • Сообщение изображение, текст и подпись сообщения
        POST
      • Сообщение изображение, текст и 2 кнопки - переход на сайт и позвонить
        POST
      • Сообщение изображение, текст и 3 кнопки быстрого ответа
        POST
      • Сообщение местоположение и текст
        POST
      • Сообщение динамиечский текст тело сообщения
        POST
      • Сообщение динамиечский текст тело сообщения и заголовка сообщения
        POST
      • Сообщение статичный текст
        POST
      • Получить имена всех шаблонов - gettemplate
        POST
    • Авторизационныe сообщения
      • Авторизационное сообщение
    • Чат сообщения
      • Сообщение текстовое
      • Сообщение с изображением
      • Сообщение аудиозапись
      • Сообщение с документом
      • Сообщение с видео
      • Сообщение со стикерам
      • Сообщение с списками
      • Сообщение с кнопками ответа
      • Сообщение с кнопкой перехода на URL
      • Сообщение с местоположением
      • Сообщение запрос местоположения
    • Входящие сообщения от абонента
      • Входящие сообщения от абонента
      • Текстовое входящее сообщение
      • Медиа (изображение, аудио, видео, документ, стикер) - входящее сообщение
      • Местоположение - входящее сообщение
      • Нажатие на кнопку быстрого ответа
      • Нажатие на кнопку из списка (из листа)
    • Установить WebHook - setwebhook
      POST
    • Статусы сообщений на WebHook
      POST
  • HTTP SMS API
    • sendMessage
    • getMessageByID
    • reporturl
  • JSON SMS API
    • send
    • sendBulk
    • reportByID
    • reportByExtraID
    • reportByBulkID
    • reportByPeriod
    • getSenders
    • notify_url
  • SOAP SMS API
    • sendMessage
    • sendBulkMessage
    • getInfoByID
    • getBulkInfoByID
    • getAbonents
    • getReport
    • getSenders
  • XML SMS API
    • sendMessage
    • sendBulkMessage
    • getInfoByID
  • MobiCheck SMS API. OTP/2FA
    • sendRequest
    • verifyPin
    • verifyRequest
  • SMPP SMS API
    • SMPP 3.4
  1. WhatsApp API
  2. Шаблонные сообщения

Общее описание запроса

POST
https://kazinfoteh.orh/wasender/sendwamsg

Общее описание структуры пакета.#

Запрос выглядит следующий образом
{
    "requestId": "test-001",
    "to": "77771234567",
    "content": {
        "whatsappContent": {
            "contentType": "TEMPLATE",
            "name": "myTemplate",
            "bodyParameters": {
                "param1": "Алекс",
                "param2": "20",
                "param3": "20.06.2024",
                "param4": "1ERTB3",
                "param5": "myLogin",
                "param7": "онлайн",
                "param8": "24 марта",
                "param9": "7 777 123-24-1233"
            },
            "header": {
                "type": "image",
                "url": "https://kazinfoteh.kz/img/display.png"
            },
            "keyboard": {
                "rows": {
                    "buttons": [
                        {
                            "type": "QUICK_REPLY",
                            "payload": "1"
                        },
                        {
                            "type": "QUICK_REPLY",
                            "payload": "2"
                        }
                    ]
                }
            }
        }
    }
}
"requestId": - необязательный параметр. Ваше id сообщение в вашей системе, мы будем передавать его вам в отчете о статусах сообщений и других ответах. Так же после отправки запроса, мы вернем наш ID сообщения, его мы так же будем передавать вам в отчетах и других ответах
"to": - Номер получателя, в международном формате, например 7XXXXXXXXXX
"whatsappContent": {} - содержит всю информации о контенте сообщения
"contentType": "TEMPLATE" - тип отпарвляемого сообщения, для шаблонные сообщений TEMPLATE
"name": "myTemplate" - название шаблона
"bodyParameters": {} - тело сообщения. Заполняется только в том случаи, если вы зарегистрировали шаблон с индивидуальными переменными для каждого абонента, например: Привет, Абай. Твоя скидка 20%. То необходимо указать текст для каждой переменной (в примере, param1=Абай, param2=20%). Необходимо соблюдать количество переменных, например если шаблон зарегистрирован с тремя переменными то в запросе необходимо указать три переменных. Максимальное количество переменных 9. Если текст статичный то структура не указывается, текст берется из шаблона.
"header": {} - Заголовок сообщения. Заполняется в том случаи если это медиа элемент (изображение, видео, аудио и т.п.) и необходимо передать URL на медиа элемент или текст, но с индивидуальной переменной для каждого абонента. Если заголовок статичный текст (например, Здравствуйте) или заголовок отсутствует то структура не заполняется
"keyboard": {} - Структура кнопок, заполняется только в том случае если у вас в шаблоне есть кнопки быстрого ответа, то вам необходимо укзать коды этих кнопок. Коды нужны для того, что если абонент нажмет на кнопку, к вам придет код этой кноки и вы поняли, на какую кнопку нажал абонент. Название кнопок задаются на момент регистрации шаблона и менять их нельзя. Так же если у вас в шаблоне есть кнопка Копировать промо код, в данной структуре вы можете задать персональный код для каждого абонента. Если в вашем шаблоне отсутствуют кнопки, то структуру заполнять не надо. Если в вашем шаблоне есть кнопки перехода на URL или позвонить, то название кнопок, URL и номер телефона задаются на момент регистрации шаблона, изменять их нельзя и структура не заполняется
Если запрос принят к исполнению, сервер возвращает ответ с кодом 200, содержащий JSON-объект с идентификатором запроса, который присвоила система. Если первичная проверка запроса окончилась ошибкой, то возвращается ответ с кодом ошибки.
 
Информация о результате отправки сообщения адресату придет на установленный вами вебхук.
 
INFO
| Адрес |
| https://kazinfoteh.org/wasender/sendwamsg |
INFO
Для отправки запросов Вам потребуется X-API-KEY выданный Вашим менеджером.
INFO
В примере рассматривается зарегистированный шаблон
Имя шаблона - myTemplate. Для получаения имен шаблонов используйте метод gettemplate
Заголовок - Изображение
Текст тело - Привет {{1}}, для тебя скидка {{2}}, только до {{3}}. Твой промокод {{4}} и логин {{5}}
Подпись - Ваш любимый магазин
Две кнопки быстрого ответа:
Название кнопки: Интересует
Название кнопки: Хочу отписаться
INFO
Пояснение
Заголовок - URL изображение указывается в запросе
Текст тело - Переменные {{1}}, {{2}}, {{3}}, {{4}}, {{5}} указываеются в запросе. (весь текст не указывается, только переменные)
Подпись - (береться из шаблона, в запросе не указывается)
Две кнопки быстрого ответа - название кнопок берется из шаблона, в запросе указывается только payload (ваш индификатор кнопок, вы его получите в входящем сообщении если абонент нажмет на кнопку)
CAUTION
Для получению статусов и входящих сообщений от абонента, Вам необходимо реализовать "приемущик" (webhook) на своей стороне, разместить на своем сервере и задать его методом SetWebhook
INFO
Для получаения имен шаблонов и примеров текста, которые вы подавали на регистрацию используйте метод gettemplate
CHECK
"contentType": "TEMPLATE"

Request

Header Params
X-API-KEY
string 
required
Example:
123
Body Params application/json
requestId
string 
optional
Ваш индификтор запроса
Example:
test-01
to
string 
required
Номер телефона абонента в формате 7XXXXXXXXXX
>= 11 characters<= 15 characters
Example:
77771234567
content
object 
required
whatsappContent
object 
required
Example
{
  "requestId": "test-001",
  "to": "77771234567",
  "content": {
    "whatsappContent": {
      "contentType": "TEMPLATE",
      "name": "myTemplate",
      "bodyParameters": {
        "param1": "Алекс",
        "param2": "20",
        "param3": "20.06.2024",
        "param4": "1ERTB3",
        "param5": "myLogin"
      },
      "header": {
        "type": "image",
        "url": "https://kazinfoteh.kz/img/display.png"
      },
      "keyboard": {
        "rows": {
          "buttons": [
            {
              "type": "QUICK_REPLY",
              "payload": "1"
            },
            {
              "type": "QUICK_REPLY",
              "payload": "2"
            }
          ]
        }
      }
    }
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://kazinfoteh.orh/wasender/sendwamsg' \
--header 'X-API-KEY: 123' \
--header 'Content-Type: application/json' \
--data-raw '{
    "requestId": "test-001",
    "to": "77771234567",
    "content": {
        "whatsappContent": {
            "contentType": "TEMPLATE",
            "name": "myTemplate",
            "bodyParameters": {
                "param1": "Алекс",
                "param2": "20",
                "param3": "20.06.2024",
                "param4": "1ERTB3",
                "param5": "myLogin"
            },
            "header": {
                "type": "image",
                "url": "https://kazinfoteh.kz/img/display.png"
            },
            "keyboard": {
                "rows": {
                    "buttons": [
                        {
                            "type": "QUICK_REPLY",
                            "payload": "1"
                        },
                        {
                            "type": "QUICK_REPLY",
                            "payload": "2"
                        }
                    ]
                }
            }
        }
    }
}'

Responses

🟢200OK
application/json
Body
status
string 
required
Статус запроса
ok - первичная проверка прошла успешно, сообщение отпарвленно в WhatsApp (финальные статус доставлено, не доставлено, ошибка) вы получите на ваш webhook
requestId
string 
required
ID запроса
Example
{
  "status": "ok",
  "requestId": "43"
}
🟠401Unauthorized
🟠400Bad Request
🟠404Record Not Found
Modified at 2025-03-21 08:00:15
Previous
Кнопки в шаблонных сообщениях
Next
Сообщение со всеми параметрами - заголовок изображение
Built with