Send Viber message with image and button

Example of request to send a Viber message with image and button which, when clicked, will lead to the specified link.

URI: /api/xml.php

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

Request parameters

packagetagrequired Tag to transmit the credentials required for authorization keyattribute | varcharrequired Your API key, which can be obtained in your personal cabinet message-vibertagrequired Tag specifying the type of request msgtag Message tag idattribute | integer User numeric message identifier. When used, the user must ensure that this identifier is unique within their account phonetag | varchar(21)required Phone number of the recipient of the message sendertag | varchar(11)required Signature in the message typetag | stringrequired Type of message: text - usual message image - message with picture button - message with a picture and a button texttagrequired Message text in UTF8 encoding buttontagrequired Caption to be displayed on the button From 1 to 19 characters urltagrequired Link that will be followed after pressing the button or image imagetagrequired Image URL Image format: .jpg .jpeg .png .gif

Request example

<?xml version="1.0" encoding="utf-8" ?>
<package key="bb56a4369eb19***cfec6d1776bd25">
    <message-viber>
        <msg id="1234">
            <phone>+380971234567</phone>
            <sender>SMSTest</sender>
            <type>image</type>
            <text>Message text to be sent via Viber</text>
            <button>Caption</button>
            <url>https://page.url</url>
            <image>https://image.url/image.png</image>
        </msg>
    </message-viber>
</package>

Response parameters

packagetag Tag to transmit the credentials required for authorization messagetag Tag specifying the type of request msgtag Message tag. Message status is returned as a parameter idattribute | integer User numeric message identifier msg_idattribute | integer Numeric message identifier assigned by the gateway

Response examples

Successful

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

<?xml version="1.0" encoding="utf-8" ?>
<package>
    <message-viber>
        <msg id="1234" msg_id="1234568">1</msg>
    </message-viber>
</package>

Wrong message ID

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

<?xml version="1.0" encoding="utf-8" ?>
<package>
    <message-viber>
        <msg id="7777" msg_id="0">201</msg>
    </message-viber>
</package>