Отправка 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());