v1

latestOpenAPI 3.1.02026-07-2414238909.1 KB

Send a Viber Single Message

Send Viber message to single recipient. This is a paid service.

post/viber

Headers

Authorizationstring required

Bearer {access_token}

Content-Typestring required

application/json

Request body

senderInfoTrackingIdstring required

The unique sender id. You can find it at Routee Platform-applications page.

tostring required

The phone number the message is about to be sent to. Format with a '+' and country code e.g., +3069xxxxxxxx (E.164 format).

ttlinteger

Time range until message expires. TTL range in seconds: 30 - 86400 seconds. If it is not set, the default range is 14 days.

callbackUrlstring

Defines the callback URL that will receive all the individual messages' progress of the Viber campaign.

inboundUrlstring

Defines the callback URL that will receive the inbound messages.

labelstring

A generic label which can be used for tagging the Viber message. Maximum length is 350 characters.

isSessionMessageboolean

Indicates a Viber Single is a Viber Session if the value is true. False by default. Learn more about session messaging at our documentation.

Response

200

trackingIdstring

tostring

fromstring

countrystring

applicationNamestring

directionstring

ttlstring

messagestring

imageUrlstring

sessionMessageboolean

inboundUrlstring

callbackUrlstring

Example response

{
  "trackingId": "e9507384-d557-4789-ac24-2d0cbe831c33",
  "to": "+3069xxxxxxxx",
  "from": "testviber",
  "country": "GR",
  "status": {
    "status": "QUEUED",
    "date": "2023-05-15T10:39:49.059+03:00"
  },
  "applicationName": "default",
  "direction": "Outbound",
  "ttl": "30",
  "message": "This is a viber message!",
  "viberAction": {
    "caption": "Go",
    "targetUrl": "https://www.xxxxxx"
  },
  "imageUrl": "https://www.xxxxxx/css/xxx.jpg",
  "inboundUrl": "https://www.yourserver.com/inbound-message",
  "callbackUrl": "https://www.yourserver.com/callback"
}