Send Viber with resending by SMS

Example of request to send Viber message with text, image, button and resend the message by SMS in case of failure to deliver.

URI: https://api.interconnect.solutions/api/json.php

All requests to API are sent in JSON format using the POST method.

Header parameters

Requests must contain header Content-Type: application/json, otherwise, the request will be considered invalid even if it has valid JSON.

Request parameters

authstringrequired Your API key, which can be obtained in your personal cabinet

datalist[object]required List of objects with request parameters typestringrequired Request type idnumberrequired Unique message identifier in the client system phonenumberrequired Phone number of the recipient of the message sms_signaturestringrequired Signature in the message sms_messagestringrequired Message text to be sent via SMS viber_typestringrequired Viber message type viber_signaturestringrequired Signature in the message viber_messagestringrequired Message text to be sent via Viber viber_imagestringrequired Link to the image to be sent in the message viber_linkstringrequired Link that will be followed after pressing the button viber_buttonstringrequired Caption to be displayed on the button viber_lifetimenumber Viber message lifetime in seconds Min. value: 60 seconds Default: 1 day (86400 seconds) short_linkboolean Shorter and track links (according to the tariff) hookstring URL address of the script where the message delivery status will be sent

Request example

Sync

JSON

{
    "auth": "bb56a4369eb19***cfec6d1776bd25",
    "data": [
        {
            "type": "viber+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Message text to be sent via SMS",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Message text to send via Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Button caption",
            "viber_lifetime": 86400,
            "short_link": true,
            "hook": "https://example.org/webhook/url.php"
        }
    ]
}

cURL

curl -X POST 'https://api.interconnect.solutions/api/json.php' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "viber+sms",
      "id": 100500,
      "phone": 380971234567,
      "sms_signature": "SMSTest",
      "sms_message": "Message text to be sent via SMS",
      "viber_type": "text+image+link",
      "viber_signature": "ViberTest",
      "viber_message": "Message text to send via Viber",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_link": "https://redirect.url",
      "viber_button": "Button caption",
      "viber_lifetime": 86400,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'viber+sms',
            'id' => 100500,
            'phone' => 380971234567,
            'sms_signature' => 'SMSTest',
            'sms_message' => 'Message text to be sent via SMS',
            'viber_type' => 'text+image+link',
            'viber_signature' => 'ViberTest',
            'viber_message' => 'Message text to send via Viber',
            'viber_image' => 'https://url.com/storage/images/image.png',
            'viber_link' => 'https://redirect.url',
            'viber_button' => 'Button caption',
            'viber_lifetime' => 86400,
            'short_link' => true,
            'hook' => 'https://example.org/webhook/url.php',
        ],
    ],
], JSON_UNESCAPED_UNICODE);

$ch = curl_init('https://api.interconnect.solutions/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+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Message text to be sent via SMS",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Message text to send via Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Button caption",
            "viber_lifetime": 86400,
            "short_link": True,
            "hook": "https://example.org/webhook/url.php",
        },
    ],
}

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

print(response.json())

Node.js

const payload = {
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "viber+sms",
      "id": 100500,
      "phone": 380971234567,
      "sms_signature": "SMSTest",
      "sms_message": "Message text to be sent via SMS",
      "viber_type": "text+image+link",
      "viber_signature": "ViberTest",
      "viber_message": "Message text to send via Viber",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_link": "https://redirect.url",
      "viber_button": "Button caption",
      "viber_lifetime": 86400,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
};

const response = await fetch("https://api.interconnect.solutions/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+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Message text to be sent via SMS",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Message text to send via Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Button caption",
            "viber_lifetime": 86400,
            "short_link": true,
            "hook": "https://example.org/webhook/url.php"
        }
    ]
}

cURL

curl -X POST 'https://api-async.interconnect.solutions/v1/json' \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "viber+sms",
      "id": 100500,
      "phone": 380971234567,
      "sms_signature": "SMSTest",
      "sms_message": "Message text to be sent via SMS",
      "viber_type": "text+image+link",
      "viber_signature": "ViberTest",
      "viber_message": "Message text to send via Viber",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_link": "https://redirect.url",
      "viber_button": "Button caption",
      "viber_lifetime": 86400,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
}'

PHP

<?php

$payload = json_encode([
    'auth' => 'bb56a4369eb19***cfec6d1776bd25',
    'data' => [
        [
            'type' => 'viber+sms',
            'id' => 100500,
            'phone' => 380971234567,
            'sms_signature' => 'SMSTest',
            'sms_message' => 'Message text to be sent via SMS',
            'viber_type' => 'text+image+link',
            'viber_signature' => 'ViberTest',
            'viber_message' => 'Message text to send via Viber',
            'viber_image' => 'https://url.com/storage/images/image.png',
            'viber_link' => 'https://redirect.url',
            'viber_button' => 'Button caption',
            'viber_lifetime' => 86400,
            'short_link' => true,
            'hook' => 'https://example.org/webhook/url.php',
        ],
    ],
], JSON_UNESCAPED_UNICODE);

$ch = curl_init('https://api-async.interconnect.solutions/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+sms",
            "id": 100500,
            "phone": 380971234567,
            "sms_signature": "SMSTest",
            "sms_message": "Message text to be sent via SMS",
            "viber_type": "text+image+link",
            "viber_signature": "ViberTest",
            "viber_message": "Message text to send via Viber",
            "viber_image": "https://url.com/storage/images/image.png",
            "viber_link": "https://redirect.url",
            "viber_button": "Button caption",
            "viber_lifetime": 86400,
            "short_link": True,
            "hook": "https://example.org/webhook/url.php",
        },
    ],
}

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

print(response.json())

Node.js

const payload = {
  "auth": "bb56a4369eb19***cfec6d1776bd25",
  "data": [
    {
      "type": "viber+sms",
      "id": 100500,
      "phone": 380971234567,
      "sms_signature": "SMSTest",
      "sms_message": "Message text to be sent via SMS",
      "viber_type": "text+image+link",
      "viber_signature": "ViberTest",
      "viber_message": "Message text to send via Viber",
      "viber_image": "https://url.com/storage/images/image.png",
      "viber_link": "https://redirect.url",
      "viber_button": "Button caption",
      "viber_lifetime": 86400,
      "short_link": true,
      "hook": "https://example.org/webhook/url.php"
    }
  ]
};

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

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

Response parameters

successinteger Result of request execution

errorstring Error text, returned if success=false

datalist[object] List of objects with the results of request execution successboolean Request execution result returned in the data packet errorstring Error text, returned if data.success=false dataobject Request execution result idnumber Unique message identifier in the client system msg_idnumber Message identifier assigned by the gateway datanumber Description partsnumber Number of messages used to send the specified text

Response examples

Successful

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

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

Access denied

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

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

Error in Alpha-name

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

{
    "success": true,
    "data": [
        {
            "success": false,
            "error": "Error in Alpha-name",
            "data": {
                "id": 100500
            }
        }
    ]
}