Список шаблонів WhatsApp

Повертає шаблони WhatsApp, якими можна надсилати просто зараз, — лише погоджені, — разом із кількістю значень і тим, що ще потрібно кожному шаблону. Шаблони створюються в особистому кабінеті й проходять модерацію Meta.

URI: https://alphasms.ua/api/json.php

Усі запити до API надсилаються у форматі JSON за допомогою методу POST.

Параметри заголовків

У запитах обов'язково має бути заголовок Content-Type: application/json, інакше запит буде вважатися некоректним навіть при валідному JSON у ньому.

Параметри запиту

authstringобов'язковий Ваш API-ключ, який можна отримати в особистому кабінеті

datalist[object]обов'язковий Список об'єктів з параметрами запиту typestringобов'язковий Тип запиту: template/whatsapp/list signaturestring Ім'я відправника: лише його шаблони. Без нього повертаються шаблони всіх ваших відправників

Приклад запиту

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "template/whatsapp/list",
            "signature": "WhatsAppTest"
        }
    ]
}

cURL

curl -X POST 'https://alphasms.ua/api/json.php' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "template/whatsapp/list",
      "signature": "WhatsAppTest"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'template/whatsapp/list',
            'signature' => 'WhatsAppTest',
        ],
    ],
], JSON_UNESCAPED_UNICODE);

$ch = curl_init('https://alphasms.ua/api/json.php');
curl_setopt_array($ch, [
    CURLOPT_POST => true,
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
    CURLOPT_POSTFIELDS => $payload,
]);

$response = curl_exec($ch);
curl_close($ch);

echo $response;

Python

import requests

payload = {
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "template/whatsapp/list",
            "signature": "WhatsAppTest",
        },
    ],
}

response = requests.post(
    "https://alphasms.ua/api/json.php",
    json=payload,
    timeout=30,
)

print(response.json())

Node.js

const payload = {
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "template/whatsapp/list",
      "signature": "WhatsAppTest"
    }
  ]
};

const response = await fetch("https://alphasms.ua/api/json.php", {
  method: "POST",
  headers: { "Content-Type": "application/json" },
  body: JSON.stringify(payload),
});

console.log(await response.json());

Параметри відповіді

successboolean Результат виконання запиту

errorstring Текст помилки, що повертається, якщо success=false

datalist[object] Список об'єктів з результатами виконання запиту successboolean Результат виконання запиту повернутий у пакеті даних datalist[object] Шаблони idnumber Ідентифікатор шаблону namestring Ім'я шаблону, передається в whatsapp_template languagestring Мова шаблону, передається в whatsapp_language categorystring Категорія, яку Meta присвоїла шаблону: marketing, utility або authentication. Від неї залежить ціна повідомлення templatestring Текст шаблону з підстановками {{1}}, {{2}}… paramsnumber Скільки значень має бути в whatsapp_var shapeobject Що потрібно шаблону, окрім значень, — див. Відправка повідомлення WhatsApp headerstring | null Формат шапки: text, image, video, document, location або null для шаблону без шапки header_varboolean true, якщо в текстовій шапці є {{1}}, — тоді обов'язковий whatsapp_header url_buttonboolean true, якщо в кнопці-посиланні є {{1}}, — тоді обов'язковий whatsapp_button_var; крім шаблонів підтвердження: їм потрібен лише whatsapp_code copy_codeboolean true, якщо в шаблоні є кнопка копіювання коду, — тоді обов'язковий whatsapp_coupon authenticationboolean true для шаблону підтвердження — він надсилається з whatsapp_code statusstring Статус модерації: approved

Приклади відповіді

Успішний

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": [
                {
                    "id": 17,
                    "name": "order_ready",
                    "language": "en",
                    "category": "utility",
                    "template": "Hello {{1}}, your order {{2}} is ready for pickup.",
                    "params": 2,
                    "shape": {
                        "header": "image",
                        "header_var": false,
                        "url_button": false,
                        "copy_code": false,
                        "authentication": false
                    },
                    "status": "approved"
                },
                {
                    "id": 18,
                    "name": "login_code",
                    "language": "en",
                    "category": "authentication",
                    "template": "*{{1}}* is your verification code.",
                    "params": 1,
                    "shape": {
                        "header": null,
                        "header_var": false,
                        "url_button": true,
                        "copy_code": false,
                        "authentication": true
                    },
                    "status": "approved"
                }
            ]
        }
    ]
}

Доступ заборонено

HTTP Status Code: 200
Content Type: JSON application/json

{
    "success": false,
    "error": "Access denied"
}