Messaging - Send link button with Viber

This page walks you step-by-step through how to use Telesign Messaging to send a Viber message to an end-user that includes a link button to a URL of your choice.

Before you begin

Make sure you have the following before you start:

📘

NOTE:

The Transaction Callback Service is also where you would receive inbound replies from the recipient of your message.

🚧

CAUTION:

If an end user does not have Viber, the Viber send will fail. We recommend either ensuring your end users have Viber on their devices or including a fallback channel for users without Viber.

Steps

  1. Send a POST /v1/omnichannel request. Include the following param values:
ParameterValueDescriptionRequired?
channelsArray of channel objectsAdd channel objects to the array in the order you want the service to try the channels.yes
channels[0]{"channel":"viber"}Include viber as the first channel.yes
channels[0].fallback_timeA time in seconds.Specify the time to wait before cascading to the next channel.no
message.viber.templateurl_actionSpecify the predefined Viber template that includes a link button in the message.yes
message.viber.parameters.textSome text.Text to display above the link button.yes
message.viber.parameters.urlA fully-qualified URL.The URL that the link button takes the end-user to after it is clicked.yes
message.viber.parameters.url_idAn identifier.A unique ID for this link.yes
message.viber.parameters.url_textSome text.Text to display inside the link button.yes
message.sms.templatetextSpecify SMS as your preferred backup channel, using the text template. You can use a different backup channel and template if you prefer.no

Request example

POST /v1/omnichannel HTTP/1.1
Content-Type: application/json
Authorization: Basic 12345678-9ABC-DEF0-1234-56789ABCDEF0:vjE/ZDfPvDkuGNsuqCFFO4neYIs=
Host: rest-ww.telesign.com
{
  "channels": [
    {
      "channel": "viber",
      "fallback_time": 600
    },
    {
      "channel": "sms"
    }
  ],
  "phone_number": "15558675309",
  "message": {
    "viber": {
      "template": "url_action",
      "parameters": {
        "url_text": "Track Order",
        "text": "Thanks for your purchase on viatushop.com! Track your order status here:",
        "url_id": "urlid1",
        "url":"https://viatushop.com/orders?id=45390"
      }
    },
    "sms": {
      "template": "text",
      "parameters": {
        "text": "Thanks for your purchase on viatushop.com! Track your order status here: https://viatushop.com/orders?id=45390"
      }
    }
  },
  "message_type": "MKT"
}
  1. If the request is processed successfully, you should see a response with a 3001 status code.

Response example

HTTP/1.1 200 OK
Server: nginx/1.17.7
Date: Wed, 14 Oct 2020 21:25:54 GMT
Content-Type: application/json
Content-Length: 137
Connection: keep-alive
Allow: GET,POST,HEAD
{
  "status": {
    "code": 3001,
    "description": "Message in progress"
  },
  "reference_id": "35C8B5D509BC10689196FED2AD551B8A",
  "external_id": null
}
  1. If the send in Viber format is successful, your end-user receives a message on their device that looks like this.
405405
  1. If the send in Viber format fails, the service tries to send the next specified backup channel (if any).
405405

SMS Backup

  1. Updates on the status of this message are sent to the callback URL for your Transaction Callback Service. The general callback schema common to both this and other products is described on Transaction Callback Service. Modifications to the callback schema for this product are described on Messaging - Callback service. Search for these callbacks based on the reference ID in the response to your original Messaging request. Each callback payload includes an object with the status of the send for each channel that is tried.

Callback example

GET /callback_endpoint HTTP/1.1
Host: your-callback-url.com
{
  "reference_id": "35C8B5D509BC10689196FED2AD551B8A",
  "external_id": "null",
  "status": {
    "code": 3000,
    "description": "Delivered",
    "last_channel": "sms",
    "updated_on": "2020-05-04 22:07:01:226"
  },
  "channel_status": [
    {"viber": {
      "code": 3056,
      "description": "Message failed to deliver in specified fallback time",
      "reference_id": "65C77D4A6C5C09085694EFB6C554D2BF",
      "updated_on": "2020-05-04 22:05:00.325"
    }},
    {"sms": {
      "code": 3000,
      "description": "Delivered",
      "reference_id": "65C77D4A6C5C09085694EFB6C558B4C7",
      "updated_on": "2020-05-04 22:07:01:226"
    }}
  ]
}

📘

NOTE:

In addition to the reference ID for the Messaging transaction itself, the delivery status payload also includes a reference ID for the message-send on each channel. These can be useful for troubleshooting purposes.


Did this page help you?