Список шаблонов 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"
}