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

Приклад запиту для отримання списку шаблонів для надсилання повідомлень користувача

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

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

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

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

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

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

datalist[object]обов'язковий Список об'єктів з параметрами запиту typestringобов'язковий Тип запиту

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

JSON

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

cURL

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

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'template/list',
        ],
    ],
], 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/list",
        },
    ],
}

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/list"
    }
  ]
};

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());

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

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

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

datalist[object] Список об'єктів з результатами виконання запиту successboolean Результат виконання запиту повернутий у пакеті даних datalist[object] Результат виконання запиту idinteger Ідентифікатор шаблону namestring Ім'я шаблону templatestring Текст шаблону countstring Кількість знаків / кількість повідомлень datetimestring Дата і час створення шаблону

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

Успішний

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

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": [
                {
                    "id": 1,
                    "name": "First"
                    "template": "Template text",
                    "count": "13 / 1",
                    "datetime": "2022-05-03T14:21:17+03:00",
                }
            ]
        }
    ]
}

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

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

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