KiT Docs Portal

Сообщение со всеми параметрами

POSThttps://kazinfoteh.orh/wasender/sendwamsg

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

Если запрос принят к исполнению, сервер возвращает ответ с кодом 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

requestId

string

optional

Ваш индификтор запроса

Example:

test-01

string

required

Номер телефона абонента в формате 7XXXXXXXXXX

>= 11 characters<= 15 characters

Example:

77771234567

content

object

required

whatsappContent

object

required

{
  "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

Responses

OK(200)

Unauthorized(401)

Bad Request(400)

Record Not Found(404)

HTTP Code: 200

Content Type : JSONapplication/json

status

string

required

Статус запроса

ok - первичная проверка прошла успешно, сообщение отпарвленно в WhatsApp (финальные статус доставлено, не доставлено, ошибка) вы получите на ваш webhook

requestId

string

required

ID запроса

{
  "status": "ok",
  "requestId": "43"
}

Last modified: 3 months ago