Відправка OTP коду (WhatsApp)

Одноразовий код надсилається у WhatsApp шаблоном підтвердження. Його текст пише сама Meta — «1234 is your verification code» мовою шаблону, — а код заповнює і текст, і кнопку копіювання. Створіть такий шаблон в особистому кабінеті з категорією Authentication.

Вільний текст із кодом доходить до абонента лише протягом 24 годин після його останнього повідомлення, тому код надсилається шаблоном. Запит pipeline з етапом whatsapp надсилає вільний текст — він працює лише всередині цього вікна, див. Багатоканальна доставка повідомлень.

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

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

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

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

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

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

datalist[object]обов'язковий Список об'єктів з параметрами запиту typestringобов'язковий Тип запиту: whatsapp або whatsapp+sms — надіслати SMS, якщо код не доставлено у WhatsApp idnumberобов'язковий Унікальний ідентифікатор повідомлення в системі клієнта phonenumberобов'язковий Номер телефону одержувача, лише цифри, у міжнародному форматі whatsapp_signaturestringобов'язковий Ім'я відправника, підключене до WhatsApp у вашому акаунті whatsapp_templatestringобов'язковий Ім'я погодженого шаблону підтвердження whatsapp_codestring Одноразовий код, до 15 символів Обов'язковий, якщо код не передано єдиним значенням whatsapp_var whatsapp_varlist[string] Альтернатива whatsapp_code: список з одного значення — коду whatsapp_languagestring Код мови шаблону, наприклад en whatsapp_lifetimenumber Скільки намагатися доставити код, у секундах Від 60 до 86400 sms_signaturestring Ім'я відправника запасної SMS. Обов'язкове для whatsapp+sms sms_messagestring Текст запасної SMS з кодом. Обов'язковий для whatsapp+sms hookstring URL-адреса скрипта, куди буде відправлено статус доставки повідомлення

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

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "whatsapp",
            "id": 100500,
            "phone": 380971234567,
            "whatsapp_signature": "WhatsAppTest",
            "whatsapp_template": "login_code",
            "whatsapp_code": "481516",
            "hook": "https://example.org/webhook/url.php"
        }
    ]
}

cURL

curl -X POST 'https://alphasms.net/api/json.php' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "whatsapp",
      "id": 100500,
      "phone": 380971234567,
      "whatsapp_signature": "WhatsAppTest",
      "whatsapp_template": "login_code",
      "whatsapp_code": "481516",
      "hook": "https://example.org/webhook/url.php"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'whatsapp',
            'id' => 100500,
            'phone' => 380971234567,
            'whatsapp_signature' => 'WhatsAppTest',
            'whatsapp_template' => 'login_code',
            'whatsapp_code' => '481516',
            'hook' => 'https://example.org/webhook/url.php',
        ],
    ],
], JSON_UNESCAPED_UNICODE);

$ch = curl_init('https://alphasms.net/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": "whatsapp",
            "id": 100500,
            "phone": 380971234567,
            "whatsapp_signature": "WhatsAppTest",
            "whatsapp_template": "login_code",
            "whatsapp_code": "481516",
            "hook": "https://example.org/webhook/url.php",
        },
    ],
}

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

print(response.json())

Node.js

const payload = {
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "whatsapp",
      "id": 100500,
      "phone": 380971234567,
      "whatsapp_signature": "WhatsAppTest",
      "whatsapp_template": "login_code",
      "whatsapp_code": "481516",
      "hook": "https://example.org/webhook/url.php"
    }
  ]
};

const response = await fetch("https://alphasms.net/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 Результат виконання запиту повернутий у пакеті даних errorstring Текст помилки, що повертається, якщо data.success=false dataobject Результат виконання запиту idnumber Унікальний ідентифікатор повідомлення в системі клієнта msg_idnumber Ідентифікатор повідомлення, присвоєний шлюзом datanumber Опис partsnumber Кількість повідомлень, використаних для надсилання вказаного тексту

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

Успішний

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

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "id": 100500,
                "msg_id": 123456789,
                "data": 1,
                "parts": 1
            }
        }
    ]
}

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

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

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

Немає коду

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

{
    "success": true,
    "data": [
        {
            "success": false,
            "error": "WhatsApp authentication template needs a code",
            "data": {
                "id": 100500
            }
        }
    ]
}

Код із запасною SMS

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "whatsapp+sms",
            "id": 100501,
            "phone": 380971234567,
            "whatsapp_signature": "WhatsAppTest",
            "whatsapp_template": "login_code",
            "whatsapp_code": "481516",
            "sms_signature": "SMSTest",
            "sms_message": "Your code is 481516",
            "hook": "https://example.org/webhook/url.php"
        }
    ]
}

cURL

curl -X POST 'https://alphasms.net/api/json.php' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "whatsapp+sms",
      "id": 100501,
      "phone": 380971234567,
      "whatsapp_signature": "WhatsAppTest",
      "whatsapp_template": "login_code",
      "whatsapp_code": "481516",
      "sms_signature": "SMSTest",
      "sms_message": "Your code is 481516",
      "hook": "https://example.org/webhook/url.php"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'whatsapp+sms',
            'id' => 100501,
            'phone' => 380971234567,
            'whatsapp_signature' => 'WhatsAppTest',
            'whatsapp_template' => 'login_code',
            'whatsapp_code' => '481516',
            'sms_signature' => 'SMSTest',
            'sms_message' => 'Your code is 481516',
            'hook' => 'https://example.org/webhook/url.php',
        ],
    ],
], JSON_UNESCAPED_UNICODE);

$ch = curl_init('https://alphasms.net/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": "whatsapp+sms",
            "id": 100501,
            "phone": 380971234567,
            "whatsapp_signature": "WhatsAppTest",
            "whatsapp_template": "login_code",
            "whatsapp_code": "481516",
            "sms_signature": "SMSTest",
            "sms_message": "Your code is 481516",
            "hook": "https://example.org/webhook/url.php",
        },
    ],
}

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

print(response.json())

Node.js

const payload = {
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "whatsapp+sms",
      "id": 100501,
      "phone": 380971234567,
      "whatsapp_signature": "WhatsAppTest",
      "whatsapp_template": "login_code",
      "whatsapp_code": "481516",
      "sms_signature": "SMSTest",
      "sms_message": "Your code is 481516",
      "hook": "https://example.org/webhook/url.php"
    }
  ]
};

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

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