Create a new viber campaign

Create a new camapign. Click 'Try it' then input your api-key as username and api-secret as password.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

Name of the campaign

string
  • The "channelName" field indicates the channel name or brand name used for sending messages to the recipient.
  • If you do not fill a channel name or brand name in the "channelName" field, the system will automatically use the default channel name.
  • You can send a message with your own customized channel name by registering it with Movider.
  • Please note that the "channelName" field is case-sensitive. Ensure the channel name matches the case (lowercase or uppercase) you registered with Movider.
string
  • For trial accounts, you are unable to edit the body message or channel name. The system automatically sends a default message with a default channel. If you would like to customize both the message and channel name, please upgrade your account.
  • If you do not provide a channel name, or if the channel name does not match the one in your registration, the system will automatically send a default message with a default channel name. Please ensure that your channel name is correct before sending.
phoneNumbers
object
required

Phone numbers for the campaign

date-time

Delivery date for the campaign

string
  • The imageURL field in the API requires a publicly accessible URL pointing to an image resource with either a .jpeg or .png file extension as the last part of the path. For example: https://www.example.com/path/image.jpeg. The maximum allowed size for the image is 1MB.
  • Please keep in mind that sending a message with an image requires specifying the desired channelName in your request.
string
  • The videoUrl field in the API requires a publicly accessible URL pointing to an video resource with only .mp4 file extension as the last part of the path. For example: https://www.example.com/path/video.mp4. The maximum allowed size for the video is 25MB.
  • Please keep in mind that sending a message with an video requires specifying the desired channelName in your request.
string
  • The videoThumbnail field in the API requires a publicly accessible URL pointing to an image resource with either a .jpeg or .png file extension as the last part of the path. For example: https://www.example.com/path/image.jpg. The maximum allowed size for the video is 1MB.
  • Please keep in mind that, if you want to send video message you must include videoThumbnail along with videoUrl.
string
  • The fileUrl field in the API requires a publicly accessible URL pointing to a file resource with a supported file extension as the last part of the path (pdf, documents, spreadsheet). For example: https://pdfobject.com/pdf/sample.pdf. The maximum allowed size for the file is 25MB.
  • When sending a message with an file, you must specify the desired channelName in your request. Additionally, when using the fileUrl field, other message types cannot be included in the same request.
button
object

Sending a message with a button requires message field and validate channelName field.

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json