Отправка RCS с переотправкой по SMS и Viber

Пример запроса для отправки RCS-сообщения с текстом, изображением, кнопкой и переотправкой по SMS и Viber в случае невозможности доставки.

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

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

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

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

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

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

datalist[object]обязательный Список объектов с параметрами запроса typestringобязательный Тип запроса idnumberобязательный Уникальный идентификатор сообщения в системе клиента phonenumberобязательный Номер телефона получателя сообщения sms_signaturestringобязательный Подпись в сообщении sms_messagestringобязательный Текст сообщения для отправки по SMS rcs_signaturestringобязательный Подпись в сообщении rcs_messagestringобязательный Текст сообщения для отправки по SMS rcs_imagestringобязательный Ссылка на изображение, которое будет отправлено в сообщении rcs_linkstringобязательный Ссылка, по которой будет осуществлен переход после нажатия кнопки rcs_buttonstringобязательный Текст, который будет отображаться на кнопке viber_typestringобязательный Тип сообщения Viber viber_signaturestringобязательный Подпись в сообщении viber_messagestringобязательный Текст сообщения, которое будет отправлено через Viber viber_imagestringобязательный Ссылка на изображение, которое будет отправлено в сообщении viber_linkstringобязательный Ссылка, по которой будет осуществлен переход после нажатия кнопки viber_buttonstringобязательный Текст, который будет отображаться на кнопке rcs_lifetimenumber Время жизни RCS-сообщения в секундах Мин. значение: 60 секунд По умолчанию: 2 дня (172800 секунд) short_linkboolean Короткие и отслеживаемые ссылки (согласно тарифу) hookstring URL-адреса скрипта, куда будет отправлен статус доставки сообщения

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

Sync

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "rcs+viber+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Текст сообщения для отправки по SMS",
            "rcs_signature": "RCSTest",
            "rcs_message": "Текст сообщения для отправки по RCS",
            "rcs_image": "https://url.com/storage/images/image.png",
            "rcs_link": "https://redirect.url",
            "rcs_button": "Текст кнопки",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Текст сообщения для отправки по Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Текст кнопки",
            "rcs_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": "rcs+viber+sms",
      "id": 100500,
      "phone": 380971234567,
      "sms_signature": "SMSTest",
      "sms_message": "Текст сообщения для отправки по SMS",
      "rcs_signature": "RCSTest",
      "rcs_message": "Текст сообщения для отправки по RCS",
      "rcs_image": "https://url.com/storage/images/image.png",
      "rcs_link": "https://redirect.url",
      "rcs_button": "Текст кнопки",
      "viber_type": "text+image+link",
      "viber_signature": "ViberTest",
      "viber_message": "Текст сообщения для отправки по Viber",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_link": "https://redirect.url",
      "viber_button": "Текст кнопки",
      "rcs_lifetime": 172800,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'rcs+viber+sms',
            'id' => 100500,
            'phone' => 380971234567,
            'sms_signature' => 'SMSTest',
            'sms_message' => 'Текст сообщения для отправки по SMS',
            'rcs_signature' => 'RCSTest',
            'rcs_message' => 'Текст сообщения для отправки по RCS',
            'rcs_image' => 'https://url.com/storage/images/image.png',
            'rcs_link' => 'https://redirect.url',
            'rcs_button' => 'Текст кнопки',
            'viber_type' => 'text+image+link',
            'viber_signature' => 'ViberTest',
            'viber_message' => 'Текст сообщения для отправки по Viber',
            'viber_image' => 'https://url.com/storage/images/image.png',
            'viber_link' => 'https://redirect.url',
            'viber_button' => 'Текст кнопки',
            'rcs_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": "rcs+viber+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Текст сообщения для отправки по SMS",
            "rcs_signature": "RCSTest",
            "rcs_message": "Текст сообщения для отправки по RCS",
            "rcs_image": "https://url.com/storage/images/image.png",
            "rcs_link": "https://redirect.url",
            "rcs_button": "Текст кнопки",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Текст сообщения для отправки по Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Текст кнопки",
            "rcs_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": "rcs+viber+sms",
      "id": 100500,
      "phone": 380971234567,
      "sms_signature": "SMSTest",
      "sms_message": "Текст сообщения для отправки по SMS",
      "rcs_signature": "RCSTest",
      "rcs_message": "Текст сообщения для отправки по RCS",
      "rcs_image": "https://url.com/storage/images/image.png",
      "rcs_link": "https://redirect.url",
      "rcs_button": "Текст кнопки",
      "viber_type": "text+image+link",
      "viber_signature": "ViberTest",
      "viber_message": "Текст сообщения для отправки по Viber",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_link": "https://redirect.url",
      "viber_button": "Текст кнопки",
      "rcs_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": "rcs+viber+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Текст сообщения для отправки по SMS",
            "rcs_signature": "RCSTest",
            "rcs_message": "Текст сообщения для отправки по RCS",
            "rcs_image": "https://url.com/storage/images/image.png",
            "rcs_link": "https://redirect.url",
            "rcs_button": "Текст кнопки",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Текст сообщения для отправки по Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Текст кнопки",
            "rcs_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": "rcs+viber+sms",
      "id": 100500,
      "phone": 380971234567,
      "sms_signature": "SMSTest",
      "sms_message": "Текст сообщения для отправки по SMS",
      "rcs_signature": "RCSTest",
      "rcs_message": "Текст сообщения для отправки по RCS",
      "rcs_image": "https://url.com/storage/images/image.png",
      "rcs_link": "https://redirect.url",
      "rcs_button": "Текст кнопки",
      "viber_type": "text+image+link",
      "viber_signature": "ViberTest",
      "viber_message": "Текст сообщения для отправки по Viber",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_link": "https://redirect.url",
      "viber_button": "Текст кнопки",
      "rcs_lifetime": 172800,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'rcs+viber+sms',
            'id' => 100500,
            'phone' => 380971234567,
            'sms_signature' => 'SMSTest',
            'sms_message' => 'Текст сообщения для отправки по SMS',
            'rcs_signature' => 'RCSTest',
            'rcs_message' => 'Текст сообщения для отправки по RCS',
            'rcs_image' => 'https://url.com/storage/images/image.png',
            'rcs_link' => 'https://redirect.url',
            'rcs_button' => 'Текст кнопки',
            'viber_type' => 'text+image+link',
            'viber_signature' => 'ViberTest',
            'viber_message' => 'Текст сообщения для отправки по Viber',
            'viber_image' => 'https://url.com/storage/images/image.png',
            'viber_link' => 'https://redirect.url',
            'viber_button' => 'Текст кнопки',
            'rcs_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": "rcs+viber+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Текст сообщения для отправки по SMS",
            "rcs_signature": "RCSTest",
            "rcs_message": "Текст сообщения для отправки по RCS",
            "rcs_image": "https://url.com/storage/images/image.png",
            "rcs_link": "https://redirect.url",
            "rcs_button": "Текст кнопки",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Текст сообщения для отправки по Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Текст кнопки",
            "rcs_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": "rcs+viber+sms",
      "id": 100500,
      "phone": 380971234567,
      "sms_signature": "SMSTest",
      "sms_message": "Текст сообщения для отправки по SMS",
      "rcs_signature": "RCSTest",
      "rcs_message": "Текст сообщения для отправки по RCS",
      "rcs_image": "https://url.com/storage/images/image.png",
      "rcs_link": "https://redirect.url",
      "rcs_button": "Текст кнопки",
      "viber_type": "text+image+link",
      "viber_signature": "ViberTest",
      "viber_message": "Текст сообщения для отправки по Viber",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_link": "https://redirect.url",
      "viber_button": "Текст кнопки",
      "rcs_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
            }
        }
    ]
}