Відправка Viber з зображенням (JSON API)

Приклад запиту для відправки Viber-повідомлення із зображенням на вказаний номер.

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

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

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

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

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

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

datalist[object]обов'язковий Список об'єктів з параметрами запиту typestringобов'язковий Тип запиту idnumberобов'язковий Унікальний ідентифікатор повідомлення в системі клієнта phonenumberобов'язковий Номер телефону одержувача повідомлення viber_typestringобов'язковий Тип повідомлення Viber viber_signaturestringобов'язковий Підпис у повідомленні viber_imagestringобов'язковий Посилання на зображення, яке буде надіслано в повідомленні viber_lifetimenumber Час життя Viber-повідомлення в секундах Мін. значення: 60 секунд За замовчуванням: 2 дні (172800 секунд) short_linkboolean Короткі та відстежувані посилання (згідно з тарифом) hookstring URL-адреса скрипта, куди буде відправлено статус доставки повідомлення

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

Sync

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "viber",
            "id": 100500,
            "phone": 380971234567,
            "viber_type": "image",
            "viber_signature": "ViberTest",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_lifetime": 172800,
            "short_link": true,
            "hook": "https://example.org/webhook/url.php"
        }
    ]
}

cURL

curl -X POST 'https://alphasms.ua/api/json.php' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "viber",
      "id": 100500,
      "phone": 380971234567,
      "viber_type": "image",
      "viber_signature": "ViberTest",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_lifetime": 172800,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'viber',
            'id' => 100500,
            'phone' => 380971234567,
            'viber_type' => 'image',
            'viber_signature' => 'ViberTest',
            'viber_image' => 'https://url.com/storage/images/image.png',
            'viber_lifetime' => 172800,
            'short_link' => true,
            'hook' => 'https://example.org/webhook/url.php',
        ],
    ],
], 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": "viber",
            "id": 100500,
            "phone": 380971234567,
            "viber_type": "image",
            "viber_signature": "ViberTest",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_lifetime": 172800,
            "short_link": True,
            "hook": "https://example.org/webhook/url.php",
        },
    ],
}

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": "viber",
      "id": 100500,
      "phone": 380971234567,
      "viber_type": "image",
      "viber_signature": "ViberTest",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_lifetime": 172800,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
};

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": "viber",
            "id": 100500,
            "phone": 380971234567,
            "viber_type": "image",
            "viber_signature": "ViberTest",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_lifetime": 172800,
            "short_link": true,
            "hook": "https://example.org/webhook/url.php"
        }
    ]
}

cURL

curl -X POST 'https://api-async.alphasms.ua/v1/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "viber",
      "id": 100500,
      "phone": 380971234567,
      "viber_type": "image",
      "viber_signature": "ViberTest",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_lifetime": 172800,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'viber',
            'id' => 100500,
            'phone' => 380971234567,
            'viber_type' => 'image',
            'viber_signature' => 'ViberTest',
            'viber_image' => 'https://url.com/storage/images/image.png',
            'viber_lifetime' => 172800,
            'short_link' => true,
            'hook' => 'https://example.org/webhook/url.php',
        ],
    ],
], 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": "viber",
            "id": 100500,
            "phone": 380971234567,
            "viber_type": "image",
            "viber_signature": "ViberTest",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_lifetime": 172800,
            "short_link": True,
            "hook": "https://example.org/webhook/url.php",
        },
    ],
}

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": "viber",
      "id": 100500,
      "phone": 380971234567,
      "viber_type": "image",
      "viber_signature": "ViberTest",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_lifetime": 172800,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
};

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

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

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

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": "Error in Alpha-name",
            "data": {
                "id": 100500
            }
        }
    ]
}