Отправка OTP кода (WhatsApp)

Пример запроса для отправки одноразового пароля (OTP) через WhatsApp.

warning

WhatsApp не является отдельным типом сообщения. Запрос с type: whatsapp отклоняется с ошибкой Invalid message type.

WhatsApp существует только как этап пайплайна: вы отправляете запрос с type: pipeline и перечисляете whatsapp среди его этапов. Всё остальное — адрес, ключ, формат ответа — такое же, как у любого другого метода JSON API.

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

Все запросы к API отправляются в формате JSON с помощью метода POST.

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

В запросах обязательно должен быть заголовок Content-Type: application/json, иначе запрос будет считаться некорректным даже при валидном JSON в нем

Параметры запроса

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

datalist[object]обязательный Список объектов с параметрами запроса typestringобязательный Тип запроса. Для WhatsApp это всегда pipeline pipelinelist[string]обязательный Каналы в том порядке, в котором они пробуются. Только WhatsApp — ["whatsapp"] Значения не должны повторяться idnumber Уникальный идентификатор сообщения в системе клиента phonenumberобязательный Номер телефона получателя сообщения Только цифры, без + whatsappobjectобязательный Параметры этапа WhatsApp signaturestringобязательный Зарегистрированное имя отправителя messagestringобязательный Сообщение с одноразовым паролем

Пример запроса

Sync

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "pipeline",
            "pipeline": [
                "whatsapp"
            ],
            "id": 100500,
            "phone": 380971234567,
            "whatsapp": {
                "signature": "SenderID",
                "message": "Ваш код 1234"
            }
        }
    ]
}

cURL

curl -X POST 'https://alphasms.ua/api/json.php' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "pipeline",
      "pipeline": [
        "whatsapp"
      ],
      "id": 100500,
      "phone": 380971234567,
      "whatsapp": {
        "signature": "SenderID",
        "message": "Ваш код 1234"
      }
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'pipeline',
            'pipeline' => [
                'whatsapp',
            ],
            'id' => 100500,
            'phone' => 380971234567,
            'whatsapp' => [
                'signature' => 'SenderID',
                'message' => 'Ваш код 1234',
            ],
        ],
    ],
], 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": "pipeline",
            "pipeline": [
                "whatsapp",
            ],
            "id": 100500,
            "phone": 380971234567,
            "whatsapp": {
                "signature": "SenderID",
                "message": "Ваш код 1234",
            },
        },
    ],
}

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": "pipeline",
      "pipeline": [
        "whatsapp"
      ],
      "id": 100500,
      "phone": 380971234567,
      "whatsapp": {
        "signature": "SenderID",
        "message": "Ваш код 1234"
      }
    }
  ]
};

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

Async

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "pipeline",
            "pipeline": [
                "whatsapp"
            ],
            "id": 100500,
            "phone": 380971234567,
            "whatsapp": {
                "signature": "SenderID",
                "message": "Ваш код 1234"
            }
        }
    ]
}

cURL

curl -X POST 'https://api-async.alphasms.ua/v1/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "pipeline",
      "pipeline": [
        "whatsapp"
      ],
      "id": 100500,
      "phone": 380971234567,
      "whatsapp": {
        "signature": "SenderID",
        "message": "Ваш код 1234"
      }
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'pipeline',
            'pipeline' => [
                'whatsapp',
            ],
            'id' => 100500,
            'phone' => 380971234567,
            'whatsapp' => [
                'signature' => 'SenderID',
                'message' => 'Ваш код 1234',
            ],
        ],
    ],
], JSON_UNESCAPED_UNICODE);

$ch = curl_init('https://api-async.alphasms.ua/v1/json');
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": "pipeline",
            "pipeline": [
                "whatsapp",
            ],
            "id": 100500,
            "phone": 380971234567,
            "whatsapp": {
                "signature": "SenderID",
                "message": "Ваш код 1234",
            },
        },
    ],
}

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

print(response.json())

Node.js

const payload = {
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "pipeline",
      "pipeline": [
        "whatsapp"
      ],
      "id": 100500,
      "phone": 380971234567,
      "whatsapp": {
        "signature": "SenderID",
        "message": "Ваш код 1234"
      }
    }
  ]
};

const response = await fetch("https://api-async.alphasms.ua/v1/json", {
  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 Результат выполнения запроса msg_idnumber Идентификатор сообщения, присвоенный шлюзом ⚠️ Запрос pipeline отвечает только msg_id — отправленный вами id в ответе не возвращается

Примеры ответа

Успешно

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

{
    "success": true,
    "data": [
        {
            "success": true,
            "data": {
                "msg_id": 123456789
            }
        }
    ]
}

Нет маршрута

WhatsApp не включён в вашем маршруте либо для оператора этого номера маршрута нет.

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

{
    "success": true,
    "data": [
        {
            "success": false,
            "error": "No route"
        }
    ]
}

Неверный тип

Ответ на type: whatsapp. WhatsApp — этап пайплайна, а не тип сообщения.

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

{
    "success": false,
    "error": "Invalid message type"
}

Доступ запрещён

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

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

примечание

Переход на запасной канал. Перечислите каналы в том порядке, в котором их нужно пробовать, и добавьте параметры каждого этапа. Шлюз резервирует стоимость самого дорогого этапа, а разницу возвращает после фактической доставки.

{
    "type": "pipeline",
    "pipeline": ["whatsapp", "sms"],
    "id": 100500,
    "phone": 380971234567,
    "whatsapp": { "signature": "SenderID", "message": "Ваш код 1234" },
    "sms": { "signature": "SenderID", "message": "Ваш код 1234" }
}

Полный список этапов и их параметров — на странице Многоканальная доставка сообщений.

warning

WhatsApp должен быть включён в вашем маршруте — шлюз и цену назначает ваш менеджер. Без них любой пайплайн с whatsapp отвечает No route.

Этап whatsapp API не проверяет. Если signature или message не передать, запрос всё равно будет принят и оплачен, а сообщение уйдёт пустым. Проверяйте оба поля на своей стороне до отправки.

Статус доставки запроса pipeline уходит на адрес уведомлений из настроек API — см. Отчёт о доставке на URL: hook шлюз для этого типа не сохраняет.

примечание

У асинхронного API адрес из hook всё же используется в одном случае: отказ в приёме сообщения (No route, нехватка средств, ошибка валидации) приходит туда отдельным вебхуком со status: REJECTED.