Viber For Business API

Channel Info

PARAMETERS

Name	Description	type	Required
channels	This block contains information related messaging channel	N/A	Yes
name	Name of Messaging Channel. Ex: `viber`	`string`	Yes
from	Commercial Account Id	`string`	Yes
recipient	This block contains contacts information related to channel	N/A	Yes
meta	This block contains category information related to message type	N/A	Yes
category	`transactional` or `promotional`	`string`	Yes
ttl	If TTL value is set it should be min 30 to max 1,209,600 seconds	`string`	No
group_id	Segment id which contain list of phone numbers	`string` or `array`	Yes if `to` param is not present
to	Receiver mobile numbers	`array`	Yes, if `group_id` is not present

Note : The recipient block inside channel is related to particular communication channel and it is optional. The outside recipient channel contain common recipients for every channel.

{
  "channels": [
      {
          "name": "viber",
          "from": "700969ca-0cb2-11ec-a2cxxxx", //Account ID
          "meta": {
              "category": "category",
              "foreign_id": "your-custom-id",
              "ttl": 60
          }
      }
  ],
	"recipient": {
        "group_id": "{segment_id}",
        "to": [
            "91XXXXXX",
            "91XXXXXX"
        ]
  }
}

Example Response

{
  "status": "OK",
  "message": "Message Queued successfully",
  "data": [
    {
      "id": "a418d672-9781-4d97-b517-a56f7d95ad8a",
      "channel": "viber",
      "from": "700969ca-0cb2-11ec-a2cxxxx",
      "to": "9190199xxxxx",
      "credits": 1,
      "created_at": "2021-06-18T14:48:06.886358Z",
      "status": "queued",
      "foreign_id": "your-message-id"
    }
  ]
}

HTTP Methods

It will support only POST requests.

API Endpoint

https://eu.cpaas.bics.com/api/v2/

Note: Few elements in the endpoint may change from service to service.

Message Category

Category	Supported Message Type
transactional	`text` and `file`
promotional	`interactive`, `image` and `video`

Validations

type	formats	limits
file	.doc, .docx, .rtf, .dot, .dotx, .odt ,odf, .fodt, .txt, .info, .pdf,.xps, .pdax, .eps, .xls, .xlsx, .ods, .fods, .csv, .xlsm, .xltx	Max 200 MB
image	.jpg, .jpeg, .png, .bmp, .gif, .svg, .webp. (recommended size 800x800)	No limit (gif - 24MB)
video	.3gp, .m4v, .mov, .mp4	200MB (duration max 600 seconds)

Sending Text Message

{endpoint}viber/message/send

PARAMETERS

Name	Description	Limits	Required
category	category of message (`transactional`)	NA	Yes
to	Destination mobile number with country code	NA	Yes
type	Message Type section (`text`)	N/A	Yes
payload	Message Payload section	N/A	Yes
text	Message Content you want to send	Max 1000 Characters	Yes

Example Request With Text Message

cURL - cURL

curl --location --globoff '{ endpoint }api/v2/viber/message/send' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "channels": [
        {
            "name": "viber",
            "from": " { from }",
            "meta": {
                "category": "transactional"
            }
        }
    ],
    "recipient": {
        "to": [
            " { receiver }"
        ]
    },
    "message": {
        "type": "text",
        "payload": {
            "text": "Welcome to viber messaging!!"
        }
    }
}'

Send Image Message

API Endpoint

https://eu.cpaas.bics.com/api/v2/

Note: Few elements in the endpoint may change from service to service.

{endpoint}viber/message/send

PARAMETERS

Name	Description	Limits	Required
url	Public url of the image file. Either HTTP/HTTPS link.	N/A (gif-24MB)	Yes
type	`image`	YES	YES

Example Request With Image Message

cURL - cURL

curl --location --globoff '{ endpoint }api/v2/viber/message/send' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "channels": [
        {
            "name": "viber",
            "from": "  { from }",
            "meta": {
                "category": "promotional"
            }
        }
    ],
    "recipient": {
        "to": [
            "  { receiver }"
        ]
    },
    "message": {
        "type": "image",
        "payload": {
            "url": "https://www.gstatic.com/webp/gallery/4.sm.jpg"
        }
    }
}'

Send Document Message

API Endpoint

https://eu.cpaas.bics.com/api/v2/

Note: Few elements in the endpoint may change from service to service.

We can send Document which is having valid MIME-type as attachment using below API. So anything not image or video will be transmitted as document message.

{endpoint}viber/message/send

PARAMETERS

Name	Description	Limits	Required
url	Public url of the document file. Either HTTP or HTTPS link.	Max File size 200MB	Yes
file_name	Media file name	Max 25 characters	Yes

Example Request With Document Message

cURL - cURL

curl --location --globoff '{ endpoint }api/v2/viber/message/send' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "channels": [
        {
            "name": "viber",
            "from": " { from }",
            "meta": {
                "category": "transactional"
            }
        }
    ],
    "recipient": {
        "to": [
            " { receiver }"
        ]
    },
    "message": {
        "type": "file",
        "payload": {
            "file_name": "sample_file.pdf",
            "url": "https://www.learningcontainer.com/wp-content/uploads/2019/09/sample-pdf-file.pdf"
        }
    }
}'

Send Video Message

API Endpoint

https://eu.cpaas.bics.com/api/v2/

Note: Few elements in the endpoint may change from service to service.

We can send Video clips as attachment using below API. Video duration should not be over 600 seconds.

{endpoint}viber/message/send

PARAMETERS

Name	Description	Limits	Required
url	Public url of the video file. Either HTTP or HTTPS link.	Upto 200MB, duration 600 sec	Yes
type	video	YES	Yes
thumbnail	A static image that acts as the preview image for the video. Either HTTP or HTTPS link.	Max 1000 characters	Yes

Example Request With Video Message

cURL - cURL

curl --location --globoff '{ endpoint }api/v2/viber/message/send' \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--data '{
    "channels": [
        {
            "name": "viber",
            "from": " { from }",
            "meta": {
                "category": "promotional"
            }
        }
    ],
    "recipient": {
        "to": [
            " { receiver }"
        ]
    },
    "message": {
        "type": "video",
        "payload": {
            "url": "https://www.learningcontainer.com/wp-content/uploads/2020/05/sample-mp4-file.mp4",
            "thumbnail": "https://videoUrlAddress.com/thumbnail.jpg"
        }
    }
}'

Send Interactive Message

API Endpoint

https://eu.cpaas.bics.com/api/v2/

Note: Few elements in the endpoint may change from service to service.

{endpoint}viber/message/send

PARAMETERS

Name	Description	Limits	Required
choices	this block contains options of the message	N/A	Yes
choices.type	`button`	N/A	Yes
choices.payload.title	caption on the button	Max 30 chars	Yes
choices.payload.url	Either HTTP/HTTPS link	N/A	Yes

Example Request With Interactive Message

cURL - cURL

curl --location --globoff '{ endpoint }api/v2/viber/message/send' \
--data '{
    "channels": [
        {
            "name": "viber",
            "from": " { from }",
            "meta": {
                "category": "promotional"
            }
        }
    ],
    "recipient": {
        "to": [
            " { receiver }"
        ]
    },
    "message": {
        "type": "interactive",
        "payload": {
            "header": {
                "type": "image",
                "payload": {
                    "url": "https://www.gstatic.com/webp/gallery/4.sm.jpg"
                }
            },
            "body": {
                "type": "text",
                "payload": {
                    "text": "Welcome to viber messaging!!"
                }
            },
            "choices": [
                {
                    "type": "button",
                    "payload": {
                        "title": "click here",
                        "url": "http://www.viber.com"
                    }
                }
                
            ]
        }
    }
}'

Table of Contents

Channel Info
Sending Text Message
Send Image Message
Send Document Message
Send Video Message
Send Interactive Message