KiT Docs Portal
  1. Шаблонные сообщения
KiT Docs Portal
  • KiT Docs Portal
  • Личный кабинет
  • WhatsApp API
    • Типы сообщений
    • Форматирование в текстовых сообщениях
    • Форматы WhatsApp Media
    • Коды ошибок платформы WABA
    • Шаблонные сообщения
      • Категории шаблонов
      • Типы заголовков в шаблонных сообщениях
      • Тело шаблонного сообщения
      • Кнопки в шаблонных сообщениях
      • Общее описание запроса
        POST
      • Сообщение со всеми параметрами - заголовок изображение
        POST
      • Сообщение со всеми параметрами - заголовок текст
        POST
      • Сообщение изображение и текст
        POST
      • Сообщение изображение, текст и подпись сообщения
        POST
      • Сообщение изображение, текст и 2 кнопки - переход на сайт и позвонить
        POST
      • Сообщение изображение, текст и 3 кнопки быстрого ответа
        POST
      • Сообщение с кнопками содержащие динамическое дополнение к основному URL
        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. Шаблонные сообщения

Сообщение с кнопками содержащие динамическое дополнение к основному URL

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

Используйте этот метод для отправки шаблонных сообщений по каналу WhatsApp.#

Если запрос принят к исполнению, сервер возвращает ответ с кодом 200, содержащий JSON-объект с идентификатором запроса, который присвоила система. Если первичная проверка запроса окончилась ошибкой, то возвращается ответ с кодом ошибки.
 
Информация о результате отправки сообщения адресату придет на установленный вами вебхук.
 
INFO
| Адрес |
| https://kazinfoteh.org/wasender/sendwamsg |
INFO
Для отправки запросов Вам потребуется X-API-KEY выданный Вашим менеджером.
INFO
В примере рассматривается зарегистированный шаблон
Имя шаблона - myTemplate. Для получаения имен шаблонов используйте метод gettemplate
Заголовок - Нет
Статический текст тело - Привет, а у нас открытие нового магазина
2 кнопки содержащие динамическое дополнение к основному URL
INFO
Пояснение
Статический текст тело - в запросе не указывается, береться из шаблона
Название кнопок берутся из шаблона, основной адрес URL берется из шаблона, его изменить нельзя, вы можете задавать только динамическое дополнение
CAUTION
Основной URL задается на момент регистрации шаблона и его изменить нельзя.
Например, при регистарции шаблона мы указали
Кпопка 1 Название - "Перейти на сайт" и его основной URL https://kazinfoteh.kz/
Кпопка 2 Название "Ваш купон" и его основной URL https://kazinfoteh.kz/
В запросе вы можете указать дополнение к нему, например.
К кнопке 1 - waba.html
К кнопке 2 - get.php?code=12345&userId=120
В итоге по нажатию на
кнопку 1 абонент перейдет https://kazinfoteh.kz/waba.html
кнопку 2 абонент перейдет https://kazinfoteh.kz/get.php?code=12345&userId=120
💡
Перед указанием дополенение, проверьте как вы зарегистировали шаблон и как передаете дополенение, чтобы получился правильный URL
Например, вы при регистарции шаблона указали основной URL как https://kazinfoteh.kz/
а параметр передаете /waba.html
В итоге получиться https://kazinfoteh.kz//waba.html
что приведет к неверному URL
📌
URL-BTN1 - первая кнопка в зарегистрированном шаблоне с "типом кнопка действия", если считать сверху
CHECK
"contentType": "TEMPLATE"

Request

Header Params
X-API-KEY
string 
required
Example:
123
Body Params application/json
requestId
string 
required
Ваш индификтор запроса
Example:
test-01
to
string 
required
Номер телефона абонента в формате 7XXXXXXXXXX
Example:
77771234567
content
object 
required
whatsappContent
object 
required
Example
{
    "requestId": "test-001",
    "to": "77771234567",
    "content": {
        "whatsappContent": {
            "contentType": "TEMPLATE",
            "name": "myTemplate",
            "keyboard": {
                "rows": {
                    "buttons": [
                        {
                            "type": "URL-BTN1",
                            "url": "code=1234"
                        },
                        {
                            "type": "URL-BTN2",
                            "url": "code=345"
                        }
                    ]
                }
            }
        }
    }
}

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",
            "keyboard": {
                "rows": {
                    "buttons": [
                        {
                            "type": "URL-BTN1",
                            "url": "code=1234"
                        },
                        {
                            "type": "URL-BTN2",
                            "url": "code=345"
                        }
                    ]
                }
            }
        }
    }
}'

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
Previous
Сообщение изображение, текст и 3 кнопки быстрого ответа
Next
Сообщение местоположение и текст
Built with